com.ergotech.vib.ports

Class TCPPassivePortFactory.PassivePortPool

java.lang.Object

com.ergotech.vib.ports.TCPPassivePortFactory.PassivePortPool

All Implemented Interfaces:

PortPoolInterface

Enclosing class:

TCPPassivePortFactory

public static class TCPPassivePortFactory.PassivePortPool
extends java.lang.Object
implements PortPoolInterface

The port pool concept is slightly different for a passive port. Checkout performs an "accept" and does not return until there is a port available. Checkin does nothing.

Field Summary

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

cvsRev

Constructor Summary

Constructors

Constructor and Description
PassivePortPool(java.lang.String portName, TCPPassivePortFactory factory) Create the pool for the given factory and port name.

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 closes the server socket.
java.lang.String	getName() This method returns the name associated with this port pool.
void	setMaxPorts(int maxPorts) This is ignored.

Methods inherited from class java.lang.Object

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

Constructor Detail

PassivePortPool

public PassivePortPool(java.lang.String portName,
                       TCPPassivePortFactory factory)
                throws java.io.IOException,
                       BadParameterException

Create the pool for the given factory and port name.

Parameters:

portName -

factory -

Throws:

java.io.IOException

BadParameterException

Method Detail

checkin

public void checkin(PortInterface port)
             throws BadParameterException

Description copied from interface: PortPoolInterface

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.

Specified by:

checkin in interface PortPoolInterface

Throws:

BadParameterException

See Also:

PortPoolInterface.checkout()

checkout

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

Description copied from interface: PortPoolInterface

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.

Specified by:

checkout in interface PortPoolInterface

Throws:

java.io.IOException

BadParameterException

clear

public void clear()

This closes the server socket. It does not do anything with the sockets that have been accepted.

Specified by:

clear in interface PortPoolInterface

See Also:

PortPoolInterface.clear()

getName

public java.lang.String getName()

Description copied from interface: PortPoolInterface

This method returns the name associated with this port pool.

Specified by:

getName in interface PortPoolInterface

setMaxPorts

public void setMaxPorts(int maxPorts)

This is ignored.

Specified by:

setMaxPorts in interface PortPoolInterface

See Also:

PortPoolInterface.setMaxPorts(int)