com.ergotech.vib.ports

Class PortFactory

java.lang.Object

com.ergotech.vib.ports.PortFactory

All Implemented Interfaces:

PortFactoryInterface

Direct Known Subclasses:

BlueToothRFCommFactory, ControlLogixEthernetDeviceServer.EIPPortFactory, SerialPortFactory, TCPActivePortFactory, TCPPassivePortFactory, UDPActivePortFactory, UDPPassivePortFactory

public abstract class PortFactory
extends java.lang.Object
implements PortFactoryInterface

This will wrap a serial port and allow us to read and write to it as a port interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	debugLevel The debug level for this device.

Fields inherited from interface com.ergotech.vib.ports.PortFactoryInterface

cvsRev

Constructor Summary

Constructors

Constructor and Description
PortFactory(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the factory.
PortPoolInterface	getPortPool(java.lang.String portName, java.lang.Object checkedForDuplication) Calling this methods indicates that a component is interested in this factory and will (presumably) be calling "checkin/checkout" at some later date to get access to the underlying resource.
void	releasePortPool(PortPoolInterface portPool, java.lang.Object mustHaveBeenAdded) Once a factory is no longer required, that is, checkin/checkout will no longer be called on this factory, the reference to the factory should be removed allowing the factory and any underlying resources to be freed.

Methods inherited from class java.lang.Object

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

Field Detail

debugLevel

public static int debugLevel

The debug level for this device. This is set by deviceserver.debuglevel define (eg deviceserver.debuglevel=100).

Constructor Detail

PortFactory

public PortFactory(java.lang.String name)

Parameters:

name -

Method Detail

getName

public java.lang.String getName()

Description copied from interface: PortFactoryInterface

Returns the name of the factory.

Specified by:

getName in interface PortFactoryInterface

Returns:

Returns the name.

getPortPool

public PortPoolInterface getPortPool(java.lang.String portName,
                                     java.lang.Object checkedForDuplication)
                              throws java.io.IOException,
                                     BadParameterException

Calling this methods indicates that a component is interested in this factory and will (presumably) be calling "checkin/checkout" at some later date to get access to the underlying resource. An instance of factory is maintained as long as there is at least one reference to the factory. Once all references to the factory are removed, then the factory is released. If an attempt is made to add a factory twice, that is, if this method is called twice with the same argument, then a "BadParameterException" is thrown.

Specified by:

getPortPool in interface PortFactoryInterface

Parameters:

portName - the name of the port for which a pool is requested. The format of the name is dependent upon the implementation.

checkedForDuplication - if this method is called more than once with identical arguments then a BadParameterException is thrown

Throws:

java.io.IOException - thrown if thrown when creating a port pool/port

BadParameterException - thrown if thrown when creating a port pool/port or this method is called twice with identical arguments

See Also:

com.ergotech.vib.ports.PortFactoryInterface#addReference(java.lang.String)

releasePortPool

public void releasePortPool(PortPoolInterface portPool,
                            java.lang.Object mustHaveBeenAdded)
                     throws java.io.IOException,
                            BadParameterException

Once a factory is no longer required, that is, checkin/checkout will no longer be called on this factory, the reference to the factory should be removed allowing the factory and any underlying resources to be freed. If an attempt is made to remove a reference that has not been added, that is, if the argument is not known, then a BadParameterException is thrown. Regardless of why this exception is thrown, there will not be an association between the releasePortForName object and the port.

Specified by:

releasePortPool in interface PortFactoryInterface

Throws:

java.io.IOException

BadParameterException

See Also:

com.ergotech.vib.ports.PortFactoryInterface#releaseReference(java.lang.String)