|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.cics.server.API
com.ibm.cics.server.Conversation
public class Conversation
This class implements the interface that is common to both ends of an APPC conversation.
Method Summary | |
---|---|
void |
converse(DataHolder data)
DTC converse |
void |
converse(DataHolder data,
int maxLength,
boolean retainExcess)
DTC Converse |
void |
flush()
flush the connection |
void |
free()
Free the connection |
byte[] |
getConvId()
Get the conversation identifier for a conversation. |
boolean |
getDataComplete()
Has all data been received? |
int |
getErrorCode()
What was the last error code on this conversation? |
boolean |
getErrorOccurred()
Has there been an error on this conversation? |
boolean |
getNoData()
Have we received a message without data? |
boolean |
getSignalReceived()
Have we received a SIGNAL? |
ConversationState |
getState()
|
SyncLevel |
getSyncLevel()
|
void |
issueAbend()
|
void |
issueConfirmation()
|
void |
issueError()
|
void |
issuePrepare()
|
void |
issueSignal()
|
void |
receive(DataHolder data)
DTC converse |
void |
receive(DataHolder data,
int maxLength,
boolean retainExcess)
DTC converse |
void |
send(byte[] data)
Send data. |
void |
send(byte[] data,
ConversationSendOptions options)
|
void |
send(ConversationSendOptions options)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void converse(DataHolder data) throws EndOfChainIndicatorException, InvalidRequestException, LengthErrorException, NotAllocatedException, InboundSignalException, TerminalException
data
- the data to send
EndOfChainIndicatorException
- EOC occurred.
InvalidRequestException
- INVREQ occurred.
LengthErrorException
- LENGERR occurred.
NotAllocatedException
- NOTALLOC occurred.
InboundSignalException
- SIGNAL occurred.
TerminalException
- TERMERR occurred.public void converse(DataHolder data, int maxLength, boolean retainExcess) throws EndOfChainIndicatorException, InvalidRequestException, LengthErrorException, NotAllocatedException, InboundSignalException, TerminalException
data
- the data to sendmaxLength
- the maximum length of the dataretainExcess
- should excess data be retained?
EndOfChainIndicatorException
- EOC occurred.
InvalidRequestException
- INVREQ occurred.
LengthErrorException
- LENGERR occurred.
NotAllocatedException
- NOTALLOC occurred.
InboundSignalException
- SIGNAL occurred.
TerminalException
- TERMERR occurred.public void flush() throws InvalidRequestException, NotAllocatedException
InvalidRequestException
- INVREQ
NotAllocatedException
- NOTALLOCpublic void free() throws InvalidRequestException, NotAllocatedException, NotAuthorisedException, InvalidSystemIdException
InvalidRequestException
- INVREQ
NotAllocatedException
- NOTALLOC
NotAuthorisedException
- NOTAUTH
InvalidSystemIdException
- SYSIDERRpublic byte[] getConvId()
public boolean getDataComplete()
public int getErrorCode()
public boolean getErrorOccurred()
public boolean getNoData()
public boolean getSignalReceived()
public ConversationState getState()
public SyncLevel getSyncLevel()
public void issueAbend() throws InvalidRequestException, NotAllocatedException, TerminalException
InvalidRequestException
- INVREQ
NotAllocatedException
- NOTALLOC
TerminalException
- TERMERRpublic void issueConfirmation() throws InvalidRequestException, NotAllocatedException, TerminalException
InvalidRequestException
- INVREQ
NotAllocatedException
- NOTALLOC
TerminalException
- TERMERRpublic void issueError() throws InvalidRequestException, NotAllocatedException, TerminalException
InvalidRequestException
- INVREQ
NotAllocatedException
- NOTALLOC
TerminalException
- TERMERRpublic void issuePrepare() throws InvalidRequestException, NotAllocatedException, TerminalException
InvalidRequestException
- INVREQ
NotAllocatedException
- NOTALLOC
TerminalException
- TERMERRpublic void issueSignal() throws InvalidRequestException, NotAllocatedException, TerminalException
InvalidRequestException
- INVREQ
NotAllocatedException
- NOTALLOC
TerminalException
- TERMERRpublic void receive(DataHolder data) throws EndOfChainIndicatorException, InvalidRequestException, LengthErrorException, NotAllocatedException, InboundSignalException, TerminalException
data
- the data received on the connection
EndOfChainIndicatorException
- EOC occurred.
InvalidRequestException
- INVREQ occurred.
LengthErrorException
- LENGERR occurred.
NotAllocatedException
- NOTALLOC occurred.
InboundSignalException
- SIGNAL occurred.
TerminalException
- TERMERR occurred.public void receive(DataHolder data, int maxLength, boolean retainExcess) throws EndOfChainIndicatorException, InvalidRequestException, LengthErrorException, NotAllocatedException, InboundSignalException, TerminalException
data
- the data received on the connectionmaxLength
- the maximum length to receiveretainExcess
- should excess data be retained?
EndOfChainIndicatorException
- EOC occurred.
InvalidRequestException
- INVREQ occurred.
LengthErrorException
- LENGERR occurred.
NotAllocatedException
- NOTALLOC occurred.
InboundSignalException
- SIGNAL occurred.
TerminalException
- TERMERR occurred.public void send(byte[] data) throws InvalidRequestException, LengthErrorException, NotAllocatedException, InboundSignalException, TerminalException
If you want to achieve the effect of specifying LENGTH(0) in the EXEC CICS command interface, you must pass in an array of length 0.
If you want to achieve the effect of not sending any data, pass in null as the data.
data
- the data to send
InvalidRequestException
- INVREQ
LengthErrorException
- LENGERR
NotAllocatedException
- NOTALLOC
InboundSignalException
- SIGNAL
TerminalException
- TERMERRpublic void send(byte[] data, ConversationSendOptions options) throws InvalidRequestException, LengthErrorException, NotAllocatedException, InboundSignalException, TerminalException
data
- the data to sendoptions
- the options to set
InvalidRequestException
- INVREQ
LengthErrorException
- LENGERR
NotAllocatedException
- NOTALLOC
InboundSignalException
- SIGNAL
TerminalException
- TERMERRpublic void send(ConversationSendOptions options) throws InvalidRequestException, LengthErrorException, NotAllocatedException, InboundSignalException, TerminalException
options
- the options to set
InvalidRequestException
- INVREQ
LengthErrorException
- LENGERR
NotAllocatedException
- NOTALLOC
InboundSignalException
- SIGNAL
TerminalException
- TERMERR
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |