Module org.refcodes.serial

Package org.refcodes.serial

Class LoopbackPortTestBench

java.lang.Object

org.refcodes.serial.LoopbackPortTestBench

All Implemented Interfaces:

AutoCloseable, org.refcodes.component.Openable, PortTestBench

public class LoopbackPortTestBench
extends Object
implements PortTestBench

The LoopbackPortTestBench implements the PortTestBench for the LoopbackPort type.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.component.Openable

org.refcodes.component.Openable.OpenAutomaton, org.refcodes.component.Openable.OpenBuilder<B extends org.refcodes.component.Openable.OpenBuilder<B>>

Constructor Summary

Constructors

Constructor	Description
LoopbackPortTestBench()

Method Summary

Modifier and Type	Method	Description
void	close()
LoopbackPort	getReceiverPort()	Retrieves the loopback's "receiver" port.
LoopbackPort	getTransmitterPort()	Retrieves the loopback's "transmitter" port.
boolean	hasPorts()	Tests whether a pair of loopback ports can be provided.
void	open()
void	waitForPortCatchUp()	Heuristic (normal) wait time for the given implementsation's ports to catch up after issuing a specific port operation (the actual duration depends on the implementation's requirements).
void	waitForPortCatchUp(long aSleepTimeMillis)	Custom wait time for the given implementsation's ports to catch up after issuing a specific port operation.
void	waitLongestForPortCatchUp()	Heuristic longest wait time for the given implementsation's ports to catch up after issuing a specific port operation (the actual duration depends on the implementation's requirements).
void	waitLongForPortCatchUp()	Heuristic long wait time for the given implementsation's ports to catch up after issuing a specific port operation (the actual duration depends on the implementation's requirements).
void	waitShortestForPortCatchUp()	Heuristic shortest wait time for the given implementsation's ports to catch up after issuing a specific port operation (the actual duration depends on the implementation's requirements).
void	waitShortForPortCatchUp()	Heuristic short wait time for the given implementsation's ports to catch up after issuing a specific port operation (the actual duration depends on the implementation's requirements).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.component.Openable

openUnchecked

Constructor Details

LoopbackPortTestBench

public LoopbackPortTestBench()

Method Details

hasPorts

public boolean hasPorts()

Tests whether a pair of loopback ports can be provided.

Specified by:

hasPorts in interface PortTestBench

Returns:

True in case there is a pair of corresponding ports.

getReceiverPort

public LoopbackPort getReceiverPort()
                             throws IOException

Retrieves the loopback's "receiver" port.

Specified by:

getReceiverPort in interface PortTestBench

Returns:

The according receiver port.

Throws:

IOException - thrown in case acquiring the port failed.

getTransmitterPort

public LoopbackPort getTransmitterPort()
                                throws IOException

Retrieves the loopback's "transmitter" port.

Specified by:

getTransmitterPort in interface PortTestBench

Returns:

The according transmitter port.

Throws:

IOException - thrown in case acquiring the port failed.

open

public void open()
          throws IOException

Specified by:

open in interface org.refcodes.component.Openable

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface PortTestBench

Throws:

IOException

waitShortestForPortCatchUp

public void waitShortestForPortCatchUp()

Heuristic shortest wait time for the given implementsation's ports to catch up after issuing a specific port operation (the actual duration depends on the implementation's requirements).

Specified by:

waitShortestForPortCatchUp in interface PortTestBench

waitShortForPortCatchUp

public void waitShortForPortCatchUp()

Heuristic short wait time for the given implementsation's ports to catch up after issuing a specific port operation (the actual duration depends on the implementation's requirements).

Specified by:

waitShortForPortCatchUp in interface PortTestBench

waitForPortCatchUp

public void waitForPortCatchUp()

Heuristic (normal) wait time for the given implementsation's ports to catch up after issuing a specific port operation (the actual duration depends on the implementation's requirements).

Specified by:

waitForPortCatchUp in interface PortTestBench

waitLongForPortCatchUp

public void waitLongForPortCatchUp()

Heuristic long wait time for the given implementsation's ports to catch up after issuing a specific port operation (the actual duration depends on the implementation's requirements).

Specified by:

waitLongForPortCatchUp in interface PortTestBench

waitLongestForPortCatchUp

public void waitLongestForPortCatchUp()

Heuristic longest wait time for the given implementsation's ports to catch up after issuing a specific port operation (the actual duration depends on the implementation's requirements).

Specified by:

waitLongestForPortCatchUp in interface PortTestBench

waitForPortCatchUp

public void waitForPortCatchUp(long aSleepTimeMillis)

Custom wait time for the given implementsation's ports to catch up after issuing a specific port operation.

Specified by:

waitForPortCatchUp in interface PortTestBench

Parameters:

aSleepTimeMillis - The sleep time in milliseconds.