com.ergotech.vib.ports

Interface PortPoolInterface

All Known Implementing Classes:

PortPool, TCPPassivePortFactory.PassivePortPool

public interface 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. This interface provide access to the checkin/checkout methods of the implementation. A port pool contains ports that are functionally identical. That is, the use of any port interface checked out from the pool should be identical to any other port that is in the pool.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev

Method Summary

Modifier and Type	Method and Description
void	checkin(PortInterface port) This will check in a resource that you have checked out.
PortInterface	checkout() This method will return an instance of a port interface.
void	clear() This inidicates that the port pool is no longer required.
java.lang.String	getName() This method returns the name associated with this port pool.
void	setMaxPorts(int maxPorts) Sets the maximum number of ports that the port pool will serve.

Field Detail

cvsRev

static final java.lang.String cvsRev

See Also:

Constant Field Values

Method Detail

checkin

void checkin(PortInterface port)
      throws BadParameterException

This will check in a resource that you have checked out. Once a resource is checked in, it should be considered invalid. That is, references to the PortInterface should not be used after checkin.

Throws:

BadParameterException

See Also:

checkout()

checkout

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

This method will return an instance of a port interface. If you checkout a resource you are REQUIRED to check it back in when finished. A good practice is to use try/finally clauses to ensure that the resource is checked in. After checkin, the resource should be considered invalid. That is, and object should not use a reference to an object after the object has been returned to the factory.

Throws:

java.io.IOException

BadParameterException

clear

void clear()

This inidicates that the port pool is no longer required. It should free all resources and clean up the pool.

getName

java.lang.String getName()

This method returns the name associated with this port pool.

setMaxPorts

void setMaxPorts(int maxPorts)

Sets the maximum number of ports that the port pool will serve. This paramter may be ignored by the pool, for example in the case of a serial port where only on port is available. It is typically used by TCP ports to limit the number of simultaneous connections to a device.

Parameters:

maxPorts -