Module org.refcodes.serial

Package org.refcodes.serial

Class CrossoverLoopbackPortHub

java.lang.Object

org.refcodes.serial.LoopbackPortHub

org.refcodes.serial.CrossoverLoopbackPortHub

All Implemented Interfaces:

PortHub<LoopbackPort,PortMetrics>

public class CrossoverLoopbackPortHub
extends LoopbackPortHub

A CrossoverLoopbackPortHub is an in-memory implementation of a PortHub which's Port instances loop their output directly to the "connected" LoopbackPortHub counterpart Port instances ("other end of the wire"). The counterpart Port instances have the same alias so it is easy to retrieve the crossover LoopbackPort instances. This is suitable for cases using a some kind of frequent handshake between a transmitter and a receiver on the same line where we have to simulate a bidirectional in-memory communication between two ports.

Field Summary

Fields inherited from class org.refcodes.serial.LoopbackPortHub

_ports

Constructor Summary

Constructors

Constructor	Description
CrossoverLoopbackPortHub(LoopbackPortHub aCrossoverPortHub)	Constructs a CrossoverLoopbackPortHub with the given LoopbackPortHub as counterpart.
CrossoverLoopbackPortHub(LoopbackPortHub aCrossoverPortHub, String... aPorts)	Constructs a CrossoverLoopbackPortHub with the given LoopbackPortHub as counterpart and the given ports (e.g. ports with the given port aliases).

Method Summary

Modifier and Type	Method	Description
LoopbackPort[]	ports()	Lists the available ports of the system.
LoopbackPort	toPort(String aAlias)	Returns the Port identified by the given alias.

Methods inherited from class org.refcodes.serial.LoopbackPortHub

toPort

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.serial.PortHub

ports

Constructor Details

CrossoverLoopbackPortHub

public CrossoverLoopbackPortHub(LoopbackPortHub aCrossoverPortHub)

Constructs a CrossoverLoopbackPortHub with the given LoopbackPortHub as counterpart.

Parameters:

aCrossoverPortHub - The CrossoverLoopbackPortHub's counterpart LoopbackPortHub.

CrossoverLoopbackPortHub

public CrossoverLoopbackPortHub(LoopbackPortHub aCrossoverPortHub,
 String... aPorts)

Constructs a CrossoverLoopbackPortHub with the given LoopbackPortHub as counterpart and the given ports (e.g. ports with the given port aliases).

Parameters:

aCrossoverPortHub - The CrossoverLoopbackPortHub's counterpart LoopbackPortHub.

aPorts - The ports to be created initially.

Method Details

toPort

public LoopbackPort toPort(String aAlias)
                    throws IOException

Returns the Port identified by the given alias.

Specified by:

toPort in interface PortHub<LoopbackPort,PortMetrics>

Overrides:

toPort in class LoopbackPortHub

Parameters:

aAlias - The alias identifying the given Port.

Returns:

The given Port.

Throws:

IOException - Thrown in case accessing the list of Port instances failed due to I/O problems.

ports

public LoopbackPort[] ports()
                     throws IOException

Lists the available ports of the system.

Specified by:

ports in interface PortHub<LoopbackPort,PortMetrics>

Overrides:

ports in class LoopbackPortHub

Returns:

An array of available Port instances, if there are no ports than an empty array (size 0) is returned.

Throws:

IOException - Thrown in case accessing the list of Port instances failed due to I/O problems.