|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.connector2.sna.lu62.host.Lu62Conversation
This class provides the Lu62Conversation service.
Field Summary | |
---|---|
boolean |
listenThreadAlive
|
Semaphore |
receiveSem
|
Constructor Summary | |
---|---|
Lu62Conversation(Lu62ConversationConfigurationProperties configurationProperties)
This constructor creates a Lu62Conversation object. |
Method Summary | |
---|---|
void |
acceptConversation()
Accepts an incoming conversation from a 390 system. |
void |
acceptIncoming()
Accepts an incoming conversation that has previously been initialized with initializeForIncoming. |
void |
addLu62ConversationEventListener(Lu62ConversationEventListener listener)
addLu62ConversationEventListener method comment. |
void |
allocateConversation(java.lang.String aTPName)
Allocate a conversation from a OS/390 system. |
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()
Closes the communications session. |
void |
confirm()
Sends the contents of the local LU's send buffer and a confirmation request to the partner program. |
void |
deallocate()
Closes the conversation between two programs. |
void |
establishConversation()
Establishes the conversation based on the value of the outgoing attribute. |
void |
establishConversation(java.lang.String aTPName)
Establishes the conversation based on the value of the outgoing attribute. |
void |
finalize()
Clears all the atributes when there is no reference to this instance. |
void |
flush()
Sends the contents of the local LU's send buffer (if it is not empty) to the partner LU (and program). |
boolean |
getClosedIssued()
Gets the closedIssued property (boolean) value. |
boolean |
getConfirmMode()
Gets the confirmMode property value. |
java.lang.String |
getConversationId()
Gets the conversationId property (char[]) value. |
java.lang.String |
getConversationStatus()
Gets the conversationStatus property value. |
int |
getConversationTimeout()
|
int |
getEstablishConversationRetries()
Gets the establishConversationRetries property value. |
boolean |
getFlushMode()
Gets the flushMode property value. |
boolean |
getInUse()
Gets the inUse property value. |
static java.lang.String |
getLevel()
Returns the WrapperLU62 version. |
Lu62Message |
getLu62Message()
Gets the lu62Message property value. |
java.lang.String |
getLUName()
Gets the LUName property value. |
boolean |
getManageResponses()
Gets the manageResponses property value. |
boolean |
getOutgoing()
Gets the outgoing property value. |
(package private) Semaphore |
getReceiveSem()
Gets the receiveSem property value. |
int |
getSendSize()
|
java.lang.String |
getSymbolicDestinationName()
Gets the symbolicDestinationName property () value. |
boolean |
getSynchronousMode()
Gets the synchronousMode property value. |
int |
getTimeBetweenRetries()
Gets the timeBetweenRetries property value. |
java.lang.String |
getTpName()
Gets the tpName property value. |
protected void |
initializeCounter()
Sets the EstablishConversationCounter property to its default value. |
void |
initInstance()
Instantiates all handlers that have a default treatment. |
boolean |
isFree()
Returns whether the conversation is free. |
boolean |
isOffline()
Returns if the conversation is offline. |
protected Lu62Message |
lu62SendReceive(java.lang.String aString,
long aTimeout)
Sends aString to the communication service and waits for the response until the timeout expires. |
Lu62Message |
peekData()
Returns the received Lu62Message without reading it. |
Lu62Message |
readData()
Returns the received Lu62Message. |
Lu62Message |
readData(long timeout)
Returns the received Lu62Message. |
void |
receive()
Receives any data that is currently available from the partner program. |
Lu62Message |
receiveAndRequestToSend()
|
void |
removeLu62ConversationEventListener()
removeLu62ConversationEventListener method comment. |
void |
send(java.lang.String aMessage)
Puts data in the local LU's send buffer to transmit it to the partner LU program. |
void |
sendAndPrepareToReceive(java.lang.String aMessage)
Sends the data with the SEND indicator to the remote LU partner. |
void |
sendCancel(java.lang.String aMessage)
Cancels the current block of data by sending an error indicator 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. |
Lu62Message |
sendReceive(java.lang.String aString,
long aTimeout)
Sends aString to the communication service and waits for up the aTimeout period for the response. |
Lu62Message |
sendReceiveSYNC(java.lang.String aString,
long aTimeout)
Send a string and read data till conversation deallocated |
protected void |
setClosedIssued(boolean closedIssued)
Sets the closedIssued property (boolean) value. |
void |
setConfirmMode(boolean aConfirmMode)
Sets the confirmMode property value. |
void |
setConversationTimeout(int conversationTimeout)
Sets the conversationTimeout property value |
void |
setEstablishConversationRetries(int establishConversationRetries)
Sets the establishConversationRetries property value. |
void |
setFlushMode(boolean aFlushMode)
Sets the flushMode property value. |
void |
setInUse(boolean anInUse)
Sets the inUse property value. |
void |
setLU_Name(java.lang.String aLUName)
Specifies the local LU for a conversation. |
void |
setLUName(java.lang.String aLUName)
Specifies the local LU for a conversation. |
void |
setManageResponses(boolean aManageResponses)
Sets the manageResponses property value. |
void |
setOutgoing(boolean aOutgoing)
Sets the outgoing property value. |
void |
setSendSize(int aSendSize)
Sets the sendSize property value |
void |
setSendType(int aSendType)
Specifies how data is sent by the next send call. |
void |
setSynchronousMode(boolean aSynchronousMode)
Sets the synchronousMode property value. |
void |
setTimeBetweenRetries(int timeBetweenRetries)
Sets the timeBetweenRetries property value. |
void |
setTpName(java.lang.String aTpName)
Sets the tpName property value. |
void |
terminate()
Terminates the conversation. |
java.lang.String |
toString()
Returns a visual representation of this object. |
protected void |
unregister()
Unregisters conversations already registered for allocation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public Semaphore receiveSem
public boolean listenThreadAlive
Constructor Detail |
public Lu62Conversation(Lu62ConversationConfigurationProperties configurationProperties)
Method Detail |
public void addLu62ConversationEventListener(Lu62ConversationEventListener listener)
public void removeLu62ConversationEventListener()
public void acceptConversation() throws Lu62InternalErrorException, Lu62InvalidRequestException
Lu62InternalErrorException
Lu62InvalidRequestException
public void acceptIncoming() throws Lu62InternalErrorException, Lu62InvalidRequestException
Lu62InternalErrorException
Lu62InvalidRequestException
public void allocateConversation(java.lang.String aTPName) throws Lu62InternalErrorException, Lu62InvalidRequestException
Lu62InternalErrorException
Lu62InvalidRequestException
public void cancelConversation() throws Lu62InternalErrorException, Lu62InvalidRequestException
Lu62InternalErrorException
Lu62InvalidRequestException
public void closeConversation() throws Lu62Exception
Lu62Exception
public void confirm() throws Lu62InternalErrorException, Lu62InvalidRequestException
Lu62InternalErrorException
Lu62InvalidRequestException
public void deallocate() throws Lu62InternalErrorException
Lu62InternalErrorException
public void establishConversation() throws Lu62InternalErrorException, Lu62InvalidRequestException
As soon as the method allocates the conversation, it signals the conversationEstablished event and both partners can begin exchanging data using a half-duplex flip flop protocol.
Lu62InternalErrorException
Lu62InvalidRequestException
public void establishConversation(java.lang.String aTPName) throws Lu62Exception
As soon as the method allocates the conversation, it signals the conversationEstablished event and both partners can begin exchanging data using a half-duplex flip flop protocol.
aTPName
- java.lang.String
Lu62Exception
public void finalize()
public void flush() throws Lu62InternalErrorException, Lu62InvalidRequestException
Lu62InternalErrorException
Lu62InvalidRequestException
public boolean getConfirmMode()
setConfirmMode(boolean)
public java.lang.String getConversationId()
public java.lang.String getConversationStatus()
Gets the conversationStatus property value. It can have the following values
public int getEstablishConversationRetries()
setEstablishConversationRetries(int)
public boolean getFlushMode()
This method can be useful in some cases but care should be taken since it can affect the workstation and network performance.
setFlushMode(boolean)
public boolean getInUse()
setInUse(boolean)
public static java.lang.String getLevel() throws Lu62Exception
Lu62Exception
public Lu62Message getLu62Message()
public java.lang.String getLUName()
setLUName(java.lang.String)
public boolean getManageResponses()
setManageResponses(boolean)
public boolean getOutgoing()
setOutgoing(boolean)
Semaphore getReceiveSem()
public java.lang.String getSymbolicDestinationName()
public boolean getSynchronousMode()
setConfirmMode(boolean)
public int getTimeBetweenRetries()
setTimeBetweenRetries(int)
public java.lang.String getTpName()
setTpName(java.lang.String)
protected void initializeCounter()
public void initInstance() throws Lu62InternalErrorException, Lu62InvalidRequestException
Lu62InternalErrorException
Lu62InvalidRequestException
public boolean isFree()
public boolean isOffline()
protected Lu62Message lu62SendReceive(java.lang.String aString, long aTimeout)
aString
- java.lang.StringaTimeout
- longpublic Lu62Message peekData()
public Lu62Message readData() throws Lu62Exception
Lu62Exception
public Lu62Message readData(long timeout) throws Lu62Exception
Lu62Exception
public void receive() throws Lu62Exception
Lu62Exception
public Lu62Message receiveAndRequestToSend() throws Lu62Exception
Lu62Exception
public void send(java.lang.String aMessage) throws Lu62InternalErrorException, Lu62InvalidRequestException
aMessage
- The message to send.
Lu62InternalErrorException
Lu62InvalidRequestException
public void sendAndPrepareToReceive(java.lang.String aMessage) throws Lu62InternalErrorException, Lu62InvalidRequestException
aMessage
- The message to send
Lu62InternalErrorException
Lu62InvalidRequestException
send(java.lang.String)
public Lu62Message sendReceiveSYNC(java.lang.String aString, long aTimeout)
aString
- The StringaTimeout
- The timeoutpublic void sendCancel(java.lang.String aMessage) throws Lu62InternalErrorException, Lu62InvalidRequestException
aMessage
- The message to send
Lu62InternalErrorException
Lu62InvalidRequestException
public void sendConfirmed() throws Lu62InternalErrorException, Lu62InvalidRequestException
Lu62InternalErrorException
Lu62InvalidRequestException
public void sendError() throws Lu62InternalErrorException, Lu62InvalidRequestException
Lu62InternalErrorException
Lu62InvalidRequestException
public Lu62Message sendReceive(java.lang.String aString, long aTimeout)
aString
- java.lang.StringaTimeout
- longpublic void setConversationTimeout(int conversationTimeout)
conversationTimeout
- The new value for the propertypublic int getConversationTimeout()
public void setSendSize(int aSendSize)
aSendSize
- The new value for the propertypublic int getSendSize()
public void setConfirmMode(boolean aConfirmMode)
aConfirmMode
- The new value for the property.getConfirmMode()
public void setEstablishConversationRetries(int establishConversationRetries)
establishConversationRetries
- The new value for the propertygetEstablishConversationRetries()
public void setFlushMode(boolean aFlushMode)
aFlushMode
- The new value for the propertygetFlushMode()
public void setInUse(boolean anInUse)
anInUse
- The new value for the propertygetInUse()
public void setLU_Name(java.lang.String aLUName) throws Lu62InternalErrorException, Lu62InvalidRequestException
This call cannot be issued after the allocate call has been issued.
aLUName
- java.lang.String
Lu62InternalErrorException
Lu62InvalidRequestException
public void setLUName(java.lang.String aLUName) throws Lu62InternalErrorException, Lu62InvalidRequestException
This call cannot be issued after the allocate call has been issued.
aLUName
- java.lang.String
Lu62InternalErrorException
Lu62InvalidRequestException
public void setManageResponses(boolean aManageResponses)
aManageResponses
- The new value for the property.getManageResponses()
public void setOutgoing(boolean aOutgoing)
aOutgoing
- The new value for the property.getOutgoing()
public void setSendType(int aSendType) throws Lu62InternalErrorException, Lu62InvalidRequestException
The valid values are:
aSendType
- (int)
Lu62InternalErrorException
Lu62InvalidRequestException
public void setSynchronousMode(boolean aSynchronousMode)
aSynchronousMode
- The new value for the propertygetSynchronousMode()
public void setTimeBetweenRetries(int timeBetweenRetries)
timeBetweenRetries
- The new value for the propertygetTimeBetweenRetries()
public void setTpName(java.lang.String aTpName)
aTpName
- The new value for the propertygetTpName()
public void terminate() throws Lu62InternalErrorException
Lu62InternalErrorException
public java.lang.String toString()
protected void unregister() throws Lu62InternalErrorException
Lu62InternalErrorException
public boolean getClosedIssued()
Gets the closedIssued property (boolean) value.
protected void setClosedIssued(boolean closedIssued)
Sets the closedIssued property (boolean) value.
closedIssued
- The new value for the property.getClosedIssued()
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |