com.ibm.dse.services.comms
Interface Lu62ConversationService

All Known Implementing Classes:
Lu62Conversation

public interface Lu62ConversationService
extends CommonCommunicationsService


Field Summary
static java.lang.String ACCEPT_CONVERSATION
           
static java.lang.String ALLOCATEERROR
           
static int BUFFER_LENGTH
           
static java.lang.String CLOSED
           
static int CM_ALLOCATE_FAILURE_NO_RETRY
           
static int CM_ALLOCATE_FAILURE_RETRY
           
static int CM_ALLOCATION_ERROR
           
static boolean CM_BASIC_CONVERSATION
           
static boolean CM_BLOCKING
           
static int CM_BUFFER_DATA
           
static int CM_BUFFER_TOO_SMALL
           
static int CM_CALL_NOT_SUPPORTED
           
static int CM_COMPLETE_DATA_RECEIVED
           
static boolean CM_CONFIRM
           
static int CM_CONFIRM_DEALLOC_RECEIVED
           
static int CM_CONFIRM_RECEIVED
           
static int CM_CONFIRM_SEND_RECEIVED
           
static int CM_CONV_DEALLOC_AFTER_SYNCPT
           
static int CM_CONVERSATION_CANCELLED
           
static int CM_CONVERSATION_ENDING
           
static int CM_CONVERSATION_TYPE_MISMATCH
           
static int CM_DATA_RECEIVED
           
static int CM_DEALLOC_CONFIRM_REJECT
           
static int CM_DEALLOCATE_ABEND
           
static int CM_DEALLOCATE_CONFIRM
           
static int CM_DEALLOCATE_FLUSH
           
static int CM_DEALLOCATE_SYNC_LEVEL
           
static int CM_DEALLOCATED_ABEND
           
static int CM_DEALLOCATED_ABEND_BO
           
static int CM_DEALLOCATED_ABEND_SVC
           
static int CM_DEALLOCATED_ABEND_SVC_BO
           
static int CM_DEALLOCATED_ABEND_TIMER
           
static int CM_DEALLOCATED_ABEND_TIMER_BO
           
static int CM_DEALLOCATED_NORMAL
           
static int CM_DEALLOCATED_NORMAL_BO
           
static int CM_EXP_DATA_NOT_SUPPORTED
           
static int CM_INCLUDE_PARTNER_REJECT_BO
           
static int CM_INCOMPLETE_DATA_RECEIVED
           
static int CM_JOIN_TRANSACTION
           
static boolean CM_MAPPED_CONVERSATION
           
static int CM_NO_DATA_RECEIVED
           
static int CM_NO_SECONDARY_INFORMATION
           
static int CM_NO_STATUS_RECEIVED
           
static boolean CM_NON_BLOCKING
           
static boolean CM_NONE
           
static int CM_OK
           
static int CM_OPERATION_INCOMPLETE
           
static int CM_OPERATION_NOT_ACCEPTED
           
static int CM_PARAMETER_ERROR
           
static int CM_PARM_VALUE_NOT_SUPPORTED
           
static int CM_PIP_NOT_SPECIFIED_CORRECTLY
           
static int CM_PREPARE_OK
           
static int CM_PRODUCT_SPECIFIC_ERROR
           
static int CM_PROGRAM_ERROR_NO_TRUNC
           
static int CM_PROGRAM_ERROR_PURGING
           
static int CM_PROGRAM_ERROR_TRUNC
           
static int CM_PROGRAM_PARAMETER_CHECK
           
static int CM_PROGRAM_STATE_CHECK
           
static boolean CM_RECEIVE_AND_WAIT
           
static boolean CM_RECEIVE_IMMEDIATE
           
static int CM_RESOURCE_FAIL_NO_RETRY_BO
           
static int CM_RESOURCE_FAILURE_NO_RETRY
           
static int CM_RESOURCE_FAILURE_RETRY
           
static int CM_RESOURCE_FAILURE_RETRY_BO
           
static int CM_RETRY_LIMIT_EXCEEDED
           
static int CM_SECURITY_MUTUAL_FAILED
           
static int CM_SECURITY_NOT_SUPPORTED
           
static int CM_SECURITY_NOT_VALID
           
static int CM_SEND_AND_CONFIRM
           
static int CM_SEND_AND_DEALLOCATE
           
static int CM_SEND_AND_FLUSH
           
static int CM_SEND_AND_PREP_TO_RECEIVE
           
static int CM_SEND_RCV_MODE_NOT_SUPPORTED
           
static int CM_SEND_RECEIVED
           
static int CM_SVC_ERROR_NO_TRUNC
           
static int CM_SVC_ERROR_PURGING
           
static int CM_SVC_ERROR_TRUNC
           
static int CM_SYNC_LEVEL_NOT_SUPPORTED_LU
           
static int CM_SYNC_LEVEL_NOT_SUPPORTED_PGM
           
static int CM_SYNC_LVL_NOT_SUPPORTED_LU
           
static int CM_SYNC_LVL_NOT_SUPPORTED_PGM
           
static int CM_SYNC_LVL_NOT_SUPPORTED_SYS
           
static int CM_SYSTEM_EVENT
           
static int CM_TAKE_BACKOUT
           
static int CM_TAKE_COMMIT
           
static int CM_TAKE_COMMIT_DATA_OK
           
static int CM_TAKE_COMMIT_DEALLOC_DATA_OK
           
static int CM_TAKE_COMMIT_DEALLOCATE
           
static int CM_TAKE_COMMIT_SEND
           
static int CM_TAKE_COMMIT_SEND_DATA_OK
           
static int CM_TP_NOT_AVAILABLE_NO_RETRY
           
static int CM_TP_NOT_AVAILABLE_RETRY
           
static int CM_TPN_NOT_RECOGNISED
           
static int CM_TPN_NOT_RECOGNIZED
           
static int CM_UNSUCCESSFUL
           
static java.lang.String COMPLETE
           
static java.lang.String CONFIRM
           
static java.lang.String CONFIRM_CONVERSATION
           
static java.lang.String CONFIRM_DEALLOCATE
           
static java.lang.String CONFIRM_SEND
           
static java.lang.String CONFIRMED_RECEIVED
           
static java.lang.String CONVERSATION_CLOSED
           
static java.lang.String CONVERSATION_DOWN
           
static java.lang.String CONVERSATION_ESTABLISHED
           
static java.lang.String CONVERSATION_NOT_ESTABLISHED
           
static java.lang.String DATA
           
static java.lang.String DATA_CANCELLED
           
static java.lang.String DEALLOCATE_CONVERSATION
           
static java.lang.String ERROR
           
static java.lang.String ERROR_RECEIVED
           
static java.lang.String IBM_AIX
           
static java.lang.String IBM_OS2
           
static java.lang.String INCOMING
           
static java.lang.String INFO
           
static java.lang.String INITIALIZE
           
static java.lang.String LISTEN
           
static java.lang.String LU62_WRAPPER_DLL
           
static java.lang.String LUNAME
           
static java.lang.String MVS
           
static java.lang.String OPENED
           
static java.lang.String OSNAME
           
static java.lang.String OUTGOING
           
static java.lang.String RECEIVE
           
static java.lang.String REGISTERERROR
           
static java.lang.String RESET
           
static java.lang.String RESET_PENDING
           
static java.lang.String SDN
           
static java.lang.String SEND
           
static java.lang.String SEND_PENDING
           
static java.lang.String SENDERROR
           
static java.lang.String SRTERROR
           
static java.lang.String TPNAME
           
static java.lang.String WINDOWS_NT
           
 
Fields inherited from interface com.ibm.dse.services.comms.CommonCommunicationsService
CLOSED, DATA, DATASENT, ERROR, OPENED, RECEIVERC, TIMEOUT
 
Method Summary
 void addConfirmedReceivedListener(ConfirmedReceivedListener newListener)
          Generated to support the ConfirmedReceived event.
 void addConversationClosedListener(ConversationClosedListener newListener)
          Generated to support the ConversationClosed event.
 void addConversationDownListener(ConversationDownListener newListener)
          Generated to support the ConversationDown event.
 void addConversationEstablishedListener(ConversationEstablishedListener newListener)
          Generated to support the ConversationEstablished event.
 void addConversationNotEstablishedListener(ConversationNotEstablishedListener newListener)
          Generated to support the ConversationNotEstablished event.
 void addDataCancelledListener(DataCancelledListener newListener)
          Generated to support the DataCancelled event.
 void addDataListener(DataListener newListener)
          Generated to support the Data event.
 void addErrorReceivedListener(ErrorReceivedListener newListener)
          Generated to support the ErrorReceived event.
 void cancelConversation()
          Ends a specified conversation, cancels any incomplete operation (a previous call that returned with CM_OPERATION_INCOMPLETE) on this conversation, and ends the session used by the conversation.
 void closeConversation()
          Leaves the communications closed.
 void confirm()
          Sends the contents of the local LU's send buffer and a confirmation request to the partner program.
 void establishConversation()
          Establishes the conversation.
 void establishConversation(java.lang.String aTPName)
          Establishes the conversation.
 void flush()
          Sends the contents of the local LU's send buffer to the partner LU (and program).
 java.lang.String getConversationId()
          Gets the conversationId property (char[]) value.
 java.lang.String getConversationStatus()
          Gets the conversationStatus property (java.lang.String) value.It has the value of Conversation Status, the valid values are: RESET INITIALIZE SEND RECEIVE CONFIRM CONFIRM_SEND CONFIRM_DEALLOCATE
 boolean getInUse()
          Gets the inUse property (boolean) value.
 void initInstance()
          Initiates all handlers that have a default treatment.
 Lu62Message peekData()
          Returns the Lu62Message received, without reading it.
 Lu62Message readData()
          Returns the Lu62Message received.
 Lu62Message readData(Context aContext, FormatElement aFormat)
           
 Lu62Message readData(Context aContext, java.lang.String aFormatName)
          Returns the Lu62Message received.
 Lu62Message readData(long aTimeout)
          Returns the Lu62Message received.
 Lu62Message receiveAndRequestToSend()
           
 void removeConfirmedReceivedListener(ConfirmedReceivedListener newListener)
          Generated to support the ConfirmedReceived event.
 void removeConversationClosedListener(ConversationClosedListener newListener)
          Generated to support the ConversationClosed event.
 void removeConversationDownListener(ConversationDownListener newListener)
          Generated to support the ConversationDown event.
 void removeConversationEstablishedListener(ConversationEstablishedListener newListener)
          Generated to support the ConversationEstablished event.
 void removeConversationNotEstablishedListener(ConversationNotEstablishedListener newListener)
          Generated to support the ConversationNotEstablished event.
 void removeDataCancelledListener(DataCancelledListener newListener)
          Generated to support the DataCancelled event.
 void removeDataListener(DataListener newListener)
          Generated to support the Data event.
 void removeErrorReceivedListener(ErrorReceivedListener newListener)
          Generated to support the ErrorReceived event.
 void send(Context aContext, FormatElement aFormat)
          Puts data in the local LU's send buffer for transmission to the partner program.
 void send(Context aContext, java.lang.String aFormatName)
          Puts data in the local LU's send buffer for transmission to the partner program.
 void send(java.lang.String aString)
          Puts data in the local LU's send buffer for transmission to the partner program.
 void sendAndPrepareToReceive(Context aContext, FormatElement aFormat)
          Causes data to be sent , with the SEND indicator to the remote LU, witch enters the local LU in RECEIVE state.
 void sendAndPrepareToReceive(Context aContext, java.lang.String aFormatName)
          Causes data to be sent , with the SEND indicator to the remote LU, witch enters the local LU in RECEIVE state.
 void sendAndPrepareToReceive(java.lang.String aString)
          Causes data to be sent , with the SEND indicator to the remote LU, witch enters the local LU in RECEIVE state.
 void sendCancel(java.lang.String aMessage)
          Cancels the current block of data by sending an error indication to the remote LU and keeping the local LU in a SEND state.
 void sendConfirmed()
          Replies to a confirmation request from the partner program.
 void sendError()
          Notifies the partner program that the local program has encountered an application-level error.
 void setAutomaticConversationEstablishment(boolean anAutomaticConversationEstablishment)
          Sets the automaticConversationEstablishment property (boolean) value.
 void setConfirmMode(boolean aConfirmMode)
          Sets the confirmMode property (boolean) value.
 void setFlushMode(boolean aFlushMode)
          Sets the flushMode property (boolean) value.
 void setInUse(boolean use)
          Sets the inUse property (boolean) value.
 void setLUName(java.lang.String aLUName)
          Issued by the invoking program to specify the local LU for a conversation.
 void setManageResponses(boolean aManageResponses)
          Sets the manageResponses property (boolean) value.
 void setOutgoing(boolean aOutgoing)
          Sets the outgoing property (boolean) value.
 void setSymbolicDestinationName(java.lang.String aSymbolicDestinationName)
          Sets the symbolicDestinationName property (java.lang.String) value.
 void setSynchronousMode(boolean aSynchronousMode)
          Sets the synchronousMode property (boolean) value.
 void setTpName(java.lang.String aTpName)
          Sets the tpName property (java.lang.String) value.
 void terminate()
          Terminates the conversation.
 
Methods inherited from interface com.ibm.dse.services.comms.CommonCommunicationsService
ccClose, ccOpen, ccReceiveData, ccSendData, ccSendReceive, getCcClosedEventName, getCcDataReceivedEventName, getCcErrorReceivedEventName, getCcOpenedEventName, isFree, isOffline
 
Methods inherited from interface com.ibm.dse.base.Notifier
addHandler, getHandlersList, getName, removeHandler, setName, signalEvent, signalEvent
 

Field Detail

LU62_WRAPPER_DLL

public static final java.lang.String LU62_WRAPPER_DLL

WINDOWS_NT

public static final java.lang.String WINDOWS_NT

IBM_AIX

public static final java.lang.String IBM_AIX

IBM_OS2

public static final java.lang.String IBM_OS2

MVS

public static final java.lang.String MVS

OUTGOING

public static final java.lang.String OUTGOING

SDN

public static final java.lang.String SDN

INCOMING

public static final java.lang.String INCOMING

TPNAME

public static final java.lang.String TPNAME

LUNAME

public static final java.lang.String LUNAME

OPENED

public static final java.lang.String OPENED

CLOSED

public static final java.lang.String CLOSED

ERROR

public static final java.lang.String ERROR

RESET

public static final java.lang.String RESET

RESET_PENDING

public static final java.lang.String RESET_PENDING

INITIALIZE

public static final java.lang.String INITIALIZE

SEND

public static final java.lang.String SEND

SEND_PENDING

public static final java.lang.String SEND_PENDING

RECEIVE

public static final java.lang.String RECEIVE

CONFIRM

public static final java.lang.String CONFIRM

CONFIRM_SEND

public static final java.lang.String CONFIRM_SEND

CONFIRM_DEALLOCATE

public static final java.lang.String CONFIRM_DEALLOCATE

CONVERSATION_ESTABLISHED

public static final java.lang.String CONVERSATION_ESTABLISHED

CONVERSATION_NOT_ESTABLISHED

public static final java.lang.String CONVERSATION_NOT_ESTABLISHED

CONVERSATION_DOWN

public static final java.lang.String CONVERSATION_DOWN

CONVERSATION_CLOSED

public static final java.lang.String CONVERSATION_CLOSED

DATA

public static final java.lang.String DATA

DATA_CANCELLED

public static final java.lang.String DATA_CANCELLED

ERROR_RECEIVED

public static final java.lang.String ERROR_RECEIVED

CONFIRMED_RECEIVED

public static final java.lang.String CONFIRMED_RECEIVED

LISTEN

public static final java.lang.String LISTEN

DEALLOCATE_CONVERSATION

public static final java.lang.String DEALLOCATE_CONVERSATION

ACCEPT_CONVERSATION

public static final java.lang.String ACCEPT_CONVERSATION

CONFIRM_CONVERSATION

public static final java.lang.String CONFIRM_CONVERSATION

ALLOCATEERROR

public static final java.lang.String ALLOCATEERROR

REGISTERERROR

public static final java.lang.String REGISTERERROR

SENDERROR

public static final java.lang.String SENDERROR

COMPLETE

public static final java.lang.String COMPLETE

SRTERROR

public static final java.lang.String SRTERROR

INFO

public static final java.lang.String INFO

OSNAME

public static final java.lang.String OSNAME

CM_BLOCKING

public static final boolean CM_BLOCKING

CM_NON_BLOCKING

public static final boolean CM_NON_BLOCKING

CM_NONE

public static final boolean CM_NONE

CM_CONFIRM

public static final boolean CM_CONFIRM

CM_RECEIVE_AND_WAIT

public static final boolean CM_RECEIVE_AND_WAIT

CM_RECEIVE_IMMEDIATE

public static final boolean CM_RECEIVE_IMMEDIATE

CM_BASIC_CONVERSATION

public static final boolean CM_BASIC_CONVERSATION

CM_MAPPED_CONVERSATION

public static final boolean CM_MAPPED_CONVERSATION

BUFFER_LENGTH

public static final int BUFFER_LENGTH

CM_BUFFER_DATA

public static final int CM_BUFFER_DATA

CM_SEND_AND_FLUSH

public static final int CM_SEND_AND_FLUSH

CM_SEND_AND_CONFIRM

public static final int CM_SEND_AND_CONFIRM

CM_SEND_AND_PREP_TO_RECEIVE

public static final int CM_SEND_AND_PREP_TO_RECEIVE

CM_SEND_AND_DEALLOCATE

public static final int CM_SEND_AND_DEALLOCATE

CM_NO_STATUS_RECEIVED

public static final int CM_NO_STATUS_RECEIVED

CM_SEND_RECEIVED

public static final int CM_SEND_RECEIVED

CM_CONFIRM_RECEIVED

public static final int CM_CONFIRM_RECEIVED

CM_CONFIRM_SEND_RECEIVED

public static final int CM_CONFIRM_SEND_RECEIVED

CM_CONFIRM_DEALLOC_RECEIVED

public static final int CM_CONFIRM_DEALLOC_RECEIVED

CM_TAKE_COMMIT

public static final int CM_TAKE_COMMIT

CM_TAKE_COMMIT_SEND

public static final int CM_TAKE_COMMIT_SEND

CM_TAKE_COMMIT_DEALLOCATE

public static final int CM_TAKE_COMMIT_DEALLOCATE

CM_TAKE_COMMIT_DATA_OK

public static final int CM_TAKE_COMMIT_DATA_OK

CM_TAKE_COMMIT_SEND_DATA_OK

public static final int CM_TAKE_COMMIT_SEND_DATA_OK

CM_TAKE_COMMIT_DEALLOC_DATA_OK

public static final int CM_TAKE_COMMIT_DEALLOC_DATA_OK

CM_PREPARE_OK

public static final int CM_PREPARE_OK

CM_JOIN_TRANSACTION

public static final int CM_JOIN_TRANSACTION

CM_NO_DATA_RECEIVED

public static final int CM_NO_DATA_RECEIVED

CM_DATA_RECEIVED

public static final int CM_DATA_RECEIVED

CM_COMPLETE_DATA_RECEIVED

public static final int CM_COMPLETE_DATA_RECEIVED

CM_INCOMPLETE_DATA_RECEIVED

public static final int CM_INCOMPLETE_DATA_RECEIVED

CM_DEALLOCATE_SYNC_LEVEL

public static final int CM_DEALLOCATE_SYNC_LEVEL

CM_DEALLOCATE_FLUSH

public static final int CM_DEALLOCATE_FLUSH

CM_DEALLOCATE_CONFIRM

public static final int CM_DEALLOCATE_CONFIRM

CM_DEALLOCATE_ABEND

public static final int CM_DEALLOCATE_ABEND

CM_OK

public static final int CM_OK

CM_ALLOCATE_FAILURE_NO_RETRY

public static final int CM_ALLOCATE_FAILURE_NO_RETRY

CM_ALLOCATE_FAILURE_RETRY

public static final int CM_ALLOCATE_FAILURE_RETRY

CM_CONVERSATION_TYPE_MISMATCH

public static final int CM_CONVERSATION_TYPE_MISMATCH

CM_PIP_NOT_SPECIFIED_CORRECTLY

public static final int CM_PIP_NOT_SPECIFIED_CORRECTLY

CM_SECURITY_NOT_VALID

public static final int CM_SECURITY_NOT_VALID

CM_SYNC_LVL_NOT_SUPPORTED_LU

public static final int CM_SYNC_LVL_NOT_SUPPORTED_LU

CM_SYNC_LVL_NOT_SUPPORTED_SYS

public static final int CM_SYNC_LVL_NOT_SUPPORTED_SYS

CM_SYNC_LEVEL_NOT_SUPPORTED_LU

public static final int CM_SYNC_LEVEL_NOT_SUPPORTED_LU

CM_SYNC_LVL_NOT_SUPPORTED_PGM

public static final int CM_SYNC_LVL_NOT_SUPPORTED_PGM

CM_SYNC_LEVEL_NOT_SUPPORTED_PGM

public static final int CM_SYNC_LEVEL_NOT_SUPPORTED_PGM

CM_TPN_NOT_RECOGNIZED

public static final int CM_TPN_NOT_RECOGNIZED

CM_TPN_NOT_RECOGNISED

public static final int CM_TPN_NOT_RECOGNISED

CM_TP_NOT_AVAILABLE_NO_RETRY

public static final int CM_TP_NOT_AVAILABLE_NO_RETRY

CM_TP_NOT_AVAILABLE_RETRY

public static final int CM_TP_NOT_AVAILABLE_RETRY

CM_DEALLOCATED_ABEND

public static final int CM_DEALLOCATED_ABEND

CM_DEALLOCATED_NORMAL

public static final int CM_DEALLOCATED_NORMAL

CM_PARAMETER_ERROR

public static final int CM_PARAMETER_ERROR

CM_PRODUCT_SPECIFIC_ERROR

public static final int CM_PRODUCT_SPECIFIC_ERROR

CM_PROGRAM_ERROR_NO_TRUNC

public static final int CM_PROGRAM_ERROR_NO_TRUNC

CM_PROGRAM_ERROR_PURGING

public static final int CM_PROGRAM_ERROR_PURGING

CM_PROGRAM_ERROR_TRUNC

public static final int CM_PROGRAM_ERROR_TRUNC

CM_PROGRAM_PARAMETER_CHECK

public static final int CM_PROGRAM_PARAMETER_CHECK

CM_PROGRAM_STATE_CHECK

public static final int CM_PROGRAM_STATE_CHECK

CM_RESOURCE_FAILURE_NO_RETRY

public static final int CM_RESOURCE_FAILURE_NO_RETRY

CM_RESOURCE_FAILURE_RETRY

public static final int CM_RESOURCE_FAILURE_RETRY

CM_UNSUCCESSFUL

public static final int CM_UNSUCCESSFUL

CM_DEALLOCATED_ABEND_SVC

public static final int CM_DEALLOCATED_ABEND_SVC

CM_DEALLOCATED_ABEND_TIMER

public static final int CM_DEALLOCATED_ABEND_TIMER

CM_SVC_ERROR_NO_TRUNC

public static final int CM_SVC_ERROR_NO_TRUNC

CM_SVC_ERROR_PURGING

public static final int CM_SVC_ERROR_PURGING

CM_SVC_ERROR_TRUNC

public static final int CM_SVC_ERROR_TRUNC

CM_OPERATION_INCOMPLETE

public static final int CM_OPERATION_INCOMPLETE

CM_SYSTEM_EVENT

public static final int CM_SYSTEM_EVENT

CM_OPERATION_NOT_ACCEPTED

public static final int CM_OPERATION_NOT_ACCEPTED

CM_CONVERSATION_ENDING

public static final int CM_CONVERSATION_ENDING

CM_SEND_RCV_MODE_NOT_SUPPORTED

public static final int CM_SEND_RCV_MODE_NOT_SUPPORTED

CM_BUFFER_TOO_SMALL

public static final int CM_BUFFER_TOO_SMALL

CM_EXP_DATA_NOT_SUPPORTED

public static final int CM_EXP_DATA_NOT_SUPPORTED

CM_DEALLOC_CONFIRM_REJECT

public static final int CM_DEALLOC_CONFIRM_REJECT

CM_ALLOCATION_ERROR

public static final int CM_ALLOCATION_ERROR

CM_RETRY_LIMIT_EXCEEDED

public static final int CM_RETRY_LIMIT_EXCEEDED

CM_NO_SECONDARY_INFORMATION

public static final int CM_NO_SECONDARY_INFORMATION

CM_SECURITY_NOT_SUPPORTED

public static final int CM_SECURITY_NOT_SUPPORTED

CM_SECURITY_MUTUAL_FAILED

public static final int CM_SECURITY_MUTUAL_FAILED

CM_CALL_NOT_SUPPORTED

public static final int CM_CALL_NOT_SUPPORTED

CM_PARM_VALUE_NOT_SUPPORTED

public static final int CM_PARM_VALUE_NOT_SUPPORTED

CM_CONVERSATION_CANCELLED

public static final int CM_CONVERSATION_CANCELLED

CM_TAKE_BACKOUT

public static final int CM_TAKE_BACKOUT

CM_DEALLOCATED_ABEND_BO

public static final int CM_DEALLOCATED_ABEND_BO

CM_DEALLOCATED_ABEND_SVC_BO

public static final int CM_DEALLOCATED_ABEND_SVC_BO

CM_DEALLOCATED_ABEND_TIMER_BO

public static final int CM_DEALLOCATED_ABEND_TIMER_BO

CM_RESOURCE_FAIL_NO_RETRY_BO

public static final int CM_RESOURCE_FAIL_NO_RETRY_BO

CM_RESOURCE_FAILURE_RETRY_BO

public static final int CM_RESOURCE_FAILURE_RETRY_BO

CM_DEALLOCATED_NORMAL_BO

public static final int CM_DEALLOCATED_NORMAL_BO

CM_CONV_DEALLOC_AFTER_SYNCPT

public static final int CM_CONV_DEALLOC_AFTER_SYNCPT

CM_INCLUDE_PARTNER_REJECT_BO

public static final int CM_INCLUDE_PARTNER_REJECT_BO
Method Detail

addConfirmedReceivedListener

public void addConfirmedReceivedListener(ConfirmedReceivedListener newListener)
Generated to support the ConfirmedReceived event.
Parameters:
newListener - com.ibm.dse.services.comms.ConfirmedReceivedListener

addConversationClosedListener

public void addConversationClosedListener(ConversationClosedListener newListener)
Generated to support the ConversationClosed event.
Parameters:
newListener - com.ibm.dse.services.comms.ConversationClosedListener

addConversationDownListener

public void addConversationDownListener(ConversationDownListener newListener)
Generated to support the ConversationDown event.
Parameters:
newListener - com.ibm.dse.services.comms.ConversationDownListener

addConversationEstablishedListener

public void addConversationEstablishedListener(ConversationEstablishedListener newListener)
Generated to support the ConversationEstablished event.
Parameters:
newListener - com.ibm.dse.services.comms.ConversationEstablishedListener

addConversationNotEstablishedListener

public void addConversationNotEstablishedListener(ConversationNotEstablishedListener newListener)
Generated to support the ConversationNotEstablished event.
Parameters:
newListener - com.ibm.dse.services.comms.ConversationNotEstablishedListener

addDataCancelledListener

public void addDataCancelledListener(DataCancelledListener newListener)
Generated to support the DataCancelled event.
Parameters:
newListener - com.ibm.dse.services.comms.DataCancelledListener

addDataListener

public void addDataListener(DataListener newListener)
Generated to support the Data event.
Parameters:
newListener - com.ibm.dse.services.comms.DataListener

addErrorReceivedListener

public void addErrorReceivedListener(ErrorReceivedListener newListener)
Generated to support the ErrorReceived event.
Parameters:
newListener - com.ibm.dse.services.comms.ErrorReceivedListener

cancelConversation

public void cancelConversation()
                        throws DSELu62InternalErrorException,
                               DSELu62InvalidRequestException
Ends a specified conversation, cancels any incomplete operation (a previous call that returned with CM_OPERATION_INCOMPLETE) on this conversation, and ends the session used by the conversation.

closeConversation

public void closeConversation()
                       throws DSEException

Leaves the communications closed. To establish them again, the establishConversation method must be invoked.


confirm

public void confirm()
             throws DSELu62InternalErrorException,
                    DSELu62InvalidRequestException
Sends the contents of the local LU's send buffer and a confirmation request to the partner program. When the confirmation arrives, confirmedReceived or errorReceived is signaled.

establishConversation

public void establishConversation()
                           throws DSEException

Establishes the conversation. Depending on whether the outgoing atribute is true or false, it has two different behaviours:

When Outgoing is true, establishConversation method, request to allocate a conversation using a session where the local LU is the contention winner (the one that can send data right after session setup - SEND state).

When Outgoing is false, establishConversation method requests to allocate a conversation using a contention looser session (the one that has to wait for data right after session setup - RECEIVE state).

As soon as, the conversation is allocated, the event conversationEstablished is signaled, and both partners can begin exchanging data on a half-duplex flip flop protocol


establishConversation

public void establishConversation(java.lang.String aTPName)
                           throws DSEException

Establishes the conversation. Depending on whether the outgoing atribute is true or false, it has two different behaviours:

When Outgoing is true, establishConversation method, request to allocate a conversation using a session where the local LU is the contention winner (the one that can send data right after session setup - SEND state).

When Outgoing is false, establishConversation method requests to allocate a conversation using a contention looser session (the one that has to wait for data right after session setup - RECEIVE state).

As soon as, the conversation is allocated, the event conversationEstablished is signaled, and both partners can begin exchanging data on a half-duplex flip flop protocol

Parameters:
aTPName - java.lang.String

flush

public void flush()
           throws DSELu62InternalErrorException,
                  DSELu62InvalidRequestException
Sends the contents of the local LU's send buffer to the partner LU (and program). If the send buffer is empty, no action takes place.

getConversationId

public java.lang.String getConversationId()

Gets the conversationId property (char[]) value. This is the identifier for the conversation. It is used by subsequent CPI-C calls.

Returns:
The conversationId property value.
See Also:
#setConversationId

getConversationStatus

public java.lang.String getConversationStatus()

Gets the conversationStatus property (java.lang.String) value.It has the value of Conversation Status, the valid values are:

Returns:
The conversationStatus property value.

getInUse

public boolean getInUse()

Gets the inUse property (boolean) value. If true, if this instance is in use.

Returns:
The inUse property value.
See Also:
setInUse(boolean)

initInstance

public void initInstance()
                  throws DSELu62InternalErrorException,
                         DSELu62InvalidRequestException

Initiates all handlers that have a default treatment. It will also create the listenThread.


peekData

public Lu62Message peekData()
Returns the Lu62Message received, without reading it.
Returns:
com.ibm.dse.services.Lu62Message

readData

public Lu62Message readData()
                     throws DSEException
Returns the Lu62Message received.
Returns:
com.ibm.dse.services.Lu62Message

readData

public Lu62Message readData(long aTimeout)
                     throws DSEException
Returns the Lu62Message received.
Returns:
com.ibm.dse.services.Lu62Message

readData

public Lu62Message readData(Context aContext,
                            FormatElement aFormat)
                     throws DSEException
Parameters:
aContext - com.ibm.dse.base.Context
aFormat - com.ibm.dse.base.FormatElement
Returns:
com.ibm.dse.services.Lu62Message

readData

public Lu62Message readData(Context aContext,
                            java.lang.String aFormatName)
                     throws DSEException
Returns the Lu62Message received.
Parameters:
aContext - com.ibm.dse.base.Context
aFormatName - java.lang.String
Returns:
com.ibm.dse.services.Lu62Message

receiveAndRequestToSend

public Lu62Message receiveAndRequestToSend()
                                    throws DSEException

removeConfirmedReceivedListener

public void removeConfirmedReceivedListener(ConfirmedReceivedListener newListener)
Generated to support the ConfirmedReceived event.
Parameters:
newListener - com.ibm.dse.services.comms.ConfirmedReceivedListener

removeConversationClosedListener

public void removeConversationClosedListener(ConversationClosedListener newListener)
Generated to support the ConversationClosed event.
Parameters:
newListener - com.ibm.dse.services.comms.ConversationClosedListener

removeConversationDownListener

public void removeConversationDownListener(ConversationDownListener newListener)
Generated to support the ConversationDown event.
Parameters:
newListener - com.ibm.dse.services.comms.ConversationDownListener

removeConversationEstablishedListener

public void removeConversationEstablishedListener(ConversationEstablishedListener newListener)
Generated to support the ConversationEstablished event.
Parameters:
newListener - com.ibm.dse.services.comms.ConversationEstablishedListener

removeConversationNotEstablishedListener

public void removeConversationNotEstablishedListener(ConversationNotEstablishedListener newListener)
Generated to support the ConversationNotEstablished event.
Parameters:
newListener - com.ibm.dse.services.comms.ConversationNotEstablishedListener

removeDataCancelledListener

public void removeDataCancelledListener(DataCancelledListener newListener)
Generated to support the DataCancelled event.
Parameters:
newListener - com.ibm.dse.services.comms.DataCancelledListener

removeDataListener

public void removeDataListener(DataListener newListener)
Generated to support the Data event.
Parameters:
newListener - com.ibm.dse.services.comms.DataListener

removeErrorReceivedListener

public void removeErrorReceivedListener(ErrorReceivedListener newListener)
Generated to support the ErrorReceived event.
Parameters:
newListener - com.ibm.dse.services.comms.ErrorReceivedListener

send

public void send(Context aContext,
                 FormatElement aFormat)
          throws DSEException

Puts data in the local LU's send buffer for transmission to the partner program.

If flushMode enabled then the data is flushed at this moment.

If confirmMode data is flushed at this time and a confirmation is asked to the partner lu.

Parameters:
aContext - com.ibm.dse.base.Context
aFormat - com.ibm.dse.base.FormatElement

send

public void send(Context aContext,
                 java.lang.String aFormatName)
          throws DSEException

Puts data in the local LU's send buffer for transmission to the partner program.

If flushMode enabled then the data is flushed at this moment.

If confirmMode data is flushed at this time and a confirmation is asked to the partner lu.

Parameters:
aContext - com.ibm.dse.base.Context
aFormatName - java.lang.String

send

public void send(java.lang.String aString)
          throws DSEException

Puts data in the local LU's send buffer for transmission to the partner program.

If flushMode enabled then the data is flushed at this moment.

If confirmMode data is flushed at this time and a confirmation is asked to the partner lu.

Parameters:
aMessage - The message to send.

sendAndPrepareToReceive

public void sendAndPrepareToReceive(Context aContext,
                                    FormatElement aFormat)
                             throws DSEException

Causes data to be sent , with the SEND indicator to the remote LU, witch enters the local LU in RECEIVE state.

Parameters:
aMessage - The message to send.
See Also:
send(com.ibm.dse.base.Context, com.ibm.dse.base.FormatElement)

sendAndPrepareToReceive

public void sendAndPrepareToReceive(Context aContext,
                                    java.lang.String aFormatName)
                             throws DSEException

Causes data to be sent , with the SEND indicator to the remote LU, witch enters the local LU in RECEIVE state.

Parameters:
aMessage - The message to send.
See Also:
send(com.ibm.dse.base.Context, com.ibm.dse.base.FormatElement)

sendAndPrepareToReceive

public void sendAndPrepareToReceive(java.lang.String aString)
                             throws DSEException

Causes data to be sent , with the SEND indicator to the remote LU, witch enters the local LU in RECEIVE state.

Parameters:
aMessage - The message to send.
See Also:
send(com.ibm.dse.base.Context, com.ibm.dse.base.FormatElement)

sendCancel

public void sendCancel(java.lang.String aMessage)
                throws DSELu62InternalErrorException,
                       DSELu62InvalidRequestException
Cancels the current block of data by sending an error indication to the remote LU and keeping the local LU in a SEND state.
Parameters:
aMessage - The message to send.

sendConfirmed

public void sendConfirmed()
                   throws DSELu62InternalErrorException,
                          DSELu62InvalidRequestException

Replies to a confirmation request from the partner program. It informs the partner program that the local program has not detected an error in the received data.


sendError

public void sendError()
               throws DSELu62InternalErrorException,
                      DSELu62InvalidRequestException
Notifies the partner program that the local program has encountered an application-level error. The local program can use the sendError for such purposes as informing the partner program of an error encountered in received data, rejecting a confirmation request, or truncating an incomplete logical record it is sending.

setAutomaticConversationEstablishment

public void setAutomaticConversationEstablishment(boolean anAutomaticConversationEstablishment)

Sets the automaticConversationEstablishment property (boolean) value.

Parameters:
anAutomaticConversationEstablishment - The new value for the property.
See Also:
#getAutomaticConversationEstablishment

setConfirmMode

public void setConfirmMode(boolean aConfirmMode)

Sets the confirmMode property (boolean) value.

Parameters:
aConfirmMode - The new value for the property.
See Also:
#getConfirmMode

setFlushMode

public void setFlushMode(boolean aFlushMode)

Sets the flushMode property (boolean) value.

Parameters:
aFlushMode - The new value for the property.
See Also:
#getFlushMode

setInUse

public void setInUse(boolean use)

Sets the inUse property (boolean) value.

Specified by:
setInUse in interface CommonCommunicationsService
Parameters:
anInUse - The new value for the property.
See Also:
getInUse()

setLUName

public void setLUName(java.lang.String aLUName)
               throws DSELu62InternalErrorException,
                      DSELu62InvalidRequestException

Issued by the invoking program to specify the local LU for a conversation. initializeConversation call was issued.

This call cannot be issued after the allocate call has been issued.

Parameters:
aTPName - java.lang.String

setManageResponses

public void setManageResponses(boolean aManageResponses)

Sets the manageResponses property (boolean) value.

Parameters:
aManageResponses - The new value for the property.
See Also:
#getManageResponses

setOutgoing

public void setOutgoing(boolean aOutgoing)

Sets the outgoing property (boolean) value.

Parameters:
aOutgoing - The new value for the property.
See Also:
#getOutgoing

setSymbolicDestinationName

public void setSymbolicDestinationName(java.lang.String aSymbolicDestinationName)

Sets the symbolicDestinationName property (java.lang.String) value.

Parameters:
aSymbolicDestinationName - The new value for the property.
See Also:
#getSymbolicDestinationName

setSynchronousMode

public void setSynchronousMode(boolean aSynchronousMode)

Sets the synchronousMode property (boolean) value.

Parameters:
aSynchronousMode - The new value for the property.
See Also:
#getSynchronousMode

setTpName

public void setTpName(java.lang.String aTpName)

Sets the tpName property (java.lang.String) value.

Parameters:
aTpName - The new value for the property.
See Also:
#getTpName

terminate

public void terminate()
               throws DSELu62InternalErrorException
Terminates the conversation. This method terminates the internal thread and closes the conversation ABNORMALY if needed (if in RECEIVE state).