com.ibm.dse.services.comms
Interface CommunicationsPoolService

All Known Implementing Classes:
CommunicationsPool

public interface CommunicationsPoolService

This class is a pool that manages communications services that implement CommonCommunications interface.


Method Summary
 boolean areAllServicesOffline()
          Returns true is all services are online.
 void closeAll()
          Executes ccClose method of every pool element.
 CommonCommunicationsService getPoolService()
          This method returns the first free service of the pool, and in SEND state.
 void insertService(CommonCommunicationsService aService)
          Inserts a service in the pool.
 void openAll()
          Executes ccOpen method of every pool element.
 void releasePoolService(CommonCommunicationsService aService)
          Free service to be reused.
 void removeService(CommonCommunicationsService aService)
          Removes aService from the pool.
 void terminate()
          This is a housekeeping process for Notifier instances.
 

Method Detail

areAllServicesOffline

public boolean areAllServicesOffline()
Returns true is all services are online.

closeAll

public void closeAll()
Executes ccClose method of every pool element.

getPoolService

public CommonCommunicationsService getPoolService()
This method returns the first free service of the pool, and in SEND state. It marks this session 'inUse', to prevent be used by another client. If no free services and the elements are identical, a new instance of the communications service is created.
Returns:
com.ibm.dse.services.comms.CommonCommunicationsService

insertService

public void insertService(CommonCommunicationsService aService)
Inserts a service in the pool.
Parameters:
aSession - com.ibm.dse.services.comms.CommonCommunicationsService.

openAll

public void openAll()
Executes ccOpen method of every pool element.

releasePoolService

public void releasePoolService(CommonCommunicationsService aService)
Free service to be reused.
Parameters:
aSession - com.ibm.dse.services.comms.CommonCommunicationsService

removeService

public void removeService(CommonCommunicationsService aService)
Removes aService from the pool.
Parameters:
aSession - com.ibm.dse.services.comms.CommonCommunicationsService

terminate

public void terminate()
This is a housekeeping process for Notifier instances. This is called either from the application or from the context when it is destroyed or unchained. Releases all the resources acquired by the pool.