com.ibm.dse.services.comms
Interface CommonCommunicationsService

All Known Subinterfaces:
CICSConnectionService, ITOCConnectionService, Lu0SnaSessionService, Lu62ConversationService, MQConnectionService, OTMAConnectionService

public interface CommonCommunicationsService
extends Notifier

The CommonCommunicationsService interface is the common interface for communication services.


Field Summary
static java.lang.String CLOSED
           
static java.lang.String DATA
           
static java.lang.String DATASENT
           
static java.lang.String ERROR
           
static java.lang.String OPENED
           
static java.lang.String RECEIVERC
           
static java.lang.String TIMEOUT
           
 
Method Summary
 void ccClose()
          Closes the communications sevice.
 void ccOpen()
          Opens the communications chanel.
 CCMessage ccReceiveData(long aTimeout)
          Reads the data that has been received.
 void ccSendData(java.lang.String aString)
          Sends aData thought the communications channel.
 CCMessage ccSendReceive(java.lang.String aString, long aTimeout)
          Sends aString to the communication services and waits for aTimeout to receive the data.
 java.lang.String getCcClosedEventName()
          Returns the name of the closed event.
 java.lang.String getCcDataReceivedEventName()
          Returns the name of the dataReceived event.
 java.lang.String getCcErrorReceivedEventName()
          Returns the name of the errorReceived event.
 java.lang.String getCcOpenedEventName()
          Returns the name of the opened event.
 boolean isFree()
          Returns true if the communication service is ready to be used.
 boolean isOffline()
          Returns true if the communication service is offline.
 void setInUse(boolean inUse)
          Sets service inUse attribute.
 
Methods inherited from interface com.ibm.dse.base.Notifier
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent, terminate
 

Field Detail

RECEIVERC

public static final java.lang.String RECEIVERC

TIMEOUT

public static final java.lang.String TIMEOUT

DATASENT

public static final java.lang.String DATASENT

OPENED

public static final java.lang.String OPENED

CLOSED

public static final java.lang.String CLOSED

DATA

public static final java.lang.String DATA

ERROR

public static final java.lang.String ERROR
Method Detail

ccClose

public void ccClose()
             throws DSECCException
Closes the communications sevice. It returns control immediately. When the communications channel is started correctly, the event ChanelClosed is signaled.

ccOpen

public void ccOpen()
            throws DSECCException
Opens the communications chanel. It returns control inmediately. When the communications channel is started correctly, the event ChanelOpened is signaled.

ccReceiveData

public CCMessage ccReceiveData(long aTimeout)
                        throws DSECCException
Reads the data that has been received. If the data is not ready, it waits only for the timeout.
Parameters:
aTimeout - long

ccSendData

public void ccSendData(java.lang.String aString)
                throws DSECCException
Sends aData thought the communications channel. It returns control inmediately. When a response is received, two events might be signaled: DataReceived event (in case of data received) or ErrorReceived (in case of error).
Parameters:
aString - java.lang.String

ccSendReceive

public CCMessage ccSendReceive(java.lang.String aString,
                               long aTimeout)
                        throws DSECCException
Sends aString to the communication services and waits for aTimeout to receive the data.
Parameters:
aString - java.lang.String
aTimeout - long

getCcClosedEventName

public java.lang.String getCcClosedEventName()
Returns the name of the closed event.

getCcDataReceivedEventName

public java.lang.String getCcDataReceivedEventName()
Returns the name of the dataReceived event.

getCcErrorReceivedEventName

public java.lang.String getCcErrorReceivedEventName()
Returns the name of the errorReceived event.

getCcOpenedEventName

public java.lang.String getCcOpenedEventName()
Returns the name of the opened event.

isFree

public boolean isFree()
Returns true if the communication service is ready to be used.

isOffline

public boolean isOffline()
Returns true if the communication service is offline.

setInUse

public void setInUse(boolean inUse)
Sets service inUse attribute.
Parameters:
inUse - boolean