com.ergotech.vib.ports

Class PortPool

java.lang.Object

com.ergotech.vib.ports.PortPool

All Implemented Interfaces:

PortPoolInterface

public class PortPool
extends java.lang.Object
implements PortPoolInterface

The port pool keeps track of a pool of ports. A port can be checked in, or checked out of the pool. Checking out a port provides exclusive access to that port until it is checked in. Once checked in, no further use can be made of the port.

Field Summary

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

cvsRev

Method Summary

Modifier and Type	Method and Description
void	checkin(PortInterface port) Return the port to the port pool.
PortInterface	checkout() Get a port from the port pool to communicate with the PLC.
void	clear() This method is called when the port pool is no longer in use.
int	getMaxPorts() Returns the maximum number of ports that we will open to communicate with the device.
java.lang.String	getName() Returns the name of this port.
boolean	isRunning() Returns the running status of this port pool.
void	setMaxPorts(int maxPorts) Sets the maximum number of ports that we will open to communicate with the device.

Methods inherited from class java.lang.Object

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

Method Detail

checkin

public void checkin(PortInterface port)
             throws BadParameterException

Return the port to the port pool.

Specified by:

checkin in interface PortPoolInterface

Throws:

BadParameterException - thrown if the port is not checked out.

See Also:

PortPoolInterface.checkout()

checkout

public PortInterface checkout()
                       throws java.io.IOException,
                              BadParameterException

Get a port from the port pool to communicate with the PLC.

Specified by:

checkout in interface PortPoolInterface

Throws:

java.io.IOException

BadParameterException

clear

public void clear()

This method is called when the port pool is no longer in use. It should close all the ports and free any resources. This method is not thread safe, because it should be called only after the port pool is in a stable state.

Specified by:

clear in interface PortPoolInterface

getMaxPorts

public int getMaxPorts()

Returns the maximum number of ports that we will open to communicate with the device.

getName

public java.lang.String getName()

Returns the name of this port.

Specified by:

getName in interface PortPoolInterface

isRunning

public boolean isRunning()

Returns the running status of this port pool. This will generally be true unless the pool has been destroyed.

Returns:

true if the port pool is active. False if it has been destroyed.

setMaxPorts

public void setMaxPorts(int maxPorts)

Sets the maximum number of ports that we will open to communicate with the device.

Specified by:

setMaxPorts in interface PortPoolInterface