|
Sun Adapter for SNA LU62 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.stc.connector.snalu62.api.SNACPICCalls
public class SNACPICCalls
This class exposes a set of wrapper methods for each CPIC call. This enables the eWay collaboration to call the CPIC function conveniently.
For the input/output parameters of each CPIC function, please refer to your SNA CPIC manual for details.
Note: the wrappers use the same name as their corresponding
CPIC calls. However, they do not have parameters in their signatures, the
parameters used by the CPIC calls are stored in an instance of
type SNAConversationAttributes
, which is the context of
the input/output parameters for the CPIC calls. You should specify
the input parameters or get the output parameters through this context.
Example 1: for CPIC function Set_Send_Type, the steps might be like:
(1). Specify SendType value through node [OTD].[CPICCalls].[ConversationAttributes].[SendType].
(2). Call function [OTD].[CPICCalls].[cmsst].
(3). Check return code through node [OTD].[CPICCalls].[ConversationAttributes].[ReturnCode] or node [OTD].[LastReturnCode].
Example 2: for CPIC function Extract_Sync_Level, the steps might be like:
(1). Call function [OTD].[CPICCalls].[cmssl].
(2). Check return code through node [OTD].[CPICCalls].[ConversationAttributes].[ReturnCode] or node [OTD].[LastReturnCode].
(3). Get SyncLevel value through node [OTD].[CPICCalls].[ConversationAttributes].[SyncLevel].
SNAInterface
Field Summary | |
---|---|
static java.lang.String |
version
|
Constructor Summary | |
---|---|
SNACPICCalls(SNAApi snaApi)
Constructor of SNACPICCalls. |
Method Summary | |
---|---|
void |
cmaccp()
The Accept_Conversation (cmaccp) call accepts an incoming conversation. |
void |
cmallc()
A program uses the Allocate (cmallc) call to establish a basic or mapped conversation (depending on the conversation_type characteristic) with its partner program. |
void |
cmcanc()
A program uses Cancel_Conversation (cmcanc) to end a conversation immediately. |
void |
cmcfm()
The Confirm (cmcfm) call is used by a local program to send a confirmation request to the remote program and then wait for a reply. |
void |
cmcfmd()
A program uses the Confirmed (cmcfmd) call to send a confirmation reply to the remote program. |
void |
cmdeal()
A program uses the Deallocate (cmdeal) call to end a conversation. |
void |
cmecs()
A program uses the Extract_Conversation_State (cmecs) call to extract the conversation state for a given conversation. |
void |
cmecsu()
The Extract_Conversation_Security_User_ID (cmecsu) call returns the user identifier being used in a specified conversation. |
void |
cmect()
A program uses the Extract_Conversation_Type (cmect) call to extract the conversation_type characteristic's value for a given conversation. |
void |
cmemn()
A program uses the Extract_Mode_Name (cmemn) call to extract the mode_name characteristic's value for a given conversation. |
void |
cmepln()
A program uses the Extract_Partner_LU_Name (cmepln) call to extract the partner_LU_name characteristic's value for a given conversation. |
void |
cmesl()
A program uses the Extract_Sync_Level (cmesl) call to extract the sync_level characteristic's value for a given conversation. |
void |
cmetpn()
A program uses the Extract_TP_Name (cmetpn) call to extract the TP_name characteristic's value for a given conversation. |
void |
cmflus()
A program uses the Flush (cmflus) call to empty the local system's send buffer for a given conversation. |
void |
cminit()
A program uses the Initialize_Conversation (cminit) call to initialize values for various conversation characteristics before the conversation is allocated (with a call to Allocate). |
void |
cmptr()
Programs use the Prepare_To_Receive (cmptr) call to transfer control of the conversation to the remote program without waiting for the remote program to send data; that is, waiting for a Receive to complete. |
void |
cmrcv()
A program uses the Receive (cmrcv) call to receive information from a given conversation. |
void |
cmrts()
The local program uses the Request_To_Send (cmrts) call to notify the remote program that the local program would like to enter Send state for a given conversation. |
void |
cmscsp()
Set_Conversation_Security_Password (cmscsp) is used by a program to set the security_password and security_password_length characteristics for a conversation. |
void |
cmscst()
Set_Conversation_Security_Type (cmscst) is used by a program to set the conversation_security_type characteristic for a conversation. |
void |
cmscsu()
Set_Conversation_Security_User_ID (cmscsu) is used by a program to set the security_user_ID and security_user_ID_length characteristics for a conversation. |
void |
cmsct()
Set_Conversation_Type (cmsct) is used by a program to set the conversation_type characteristic for a given conversation. |
void |
cmsdt()
Set_Deallocate_Type (cmsdt) is used by a program to set the deallocate_type characteristic for a given conversation. |
void |
cmsed()
Set_Error_Direction (cmsed) is used by a program to set the error_direction characteristic for a given conversation. |
void |
cmsend()
A program uses the Send_Data (cmsend) call to send data to the remote program. |
void |
cmserr()
Send_Error (cmserr) is used by a program to inform the remote program that the local program detected an error during a conversation. |
void |
cmsf()
Set_Fill (cmsf) is used by a program to set the fill characteristic for a given conversation. |
void |
cmsld()
Set_Log_Data (cmsld) is used by a program to set the log_data and log_data_length characteristics for a given conversation. |
void |
cmsltp()
A program uses the Specify_Local_TP_Name (cmsltp) call to associate a name with itself, thus notifying CPI Communications that it can accept conversations destined for the name. |
void |
cmsmn()
Set_Mode_Name (cmsmn) is used by a program to set the mode_name and mode_name_length characteristics for a conversation. |
void |
cmspln()
Set_Partner_LU_Name (cmspln) is used by a program to set the partner_LU_name and partner_LU_name_length characteristics for a conversation. |
void |
cmspm()
A program uses the Set_Processing_Mode (cmspm) call to set the processing_mode characteristic of a conversation. |
void |
cmsptr()
Set_Prepare_To_Receive_Type (cmsptr) is used by a program to set the prepare_to_receive_type characteristic for a conversation. |
void |
cmsrc()
Set_Return_Control (cmsrc) is used to set the return_control characteristic for a given conversation. |
void |
cmsrt()
Set_Receive_Type (cmsrt) is used by a program to set the receive_type characteristic for a conversation. |
void |
cmssl()
Set_Sync_Level (cmssl) is used by a program to set the sync_level characteristic for a given conversation. |
void |
cmsst()
Set_Send_Type (cmsst) is used by a program to set the send_type characteristic for a conversation. |
void |
cmstpn()
Set_TP_Name (cmstpn) is used by a program that initiates a conversation, using the Initialize_Conversation call, to set the TP_name and TP_name_length characteristics for a given conversation. |
void |
cmtrts()
Test_Request_To_Send_Received (cmtrts) is used by a program to determine whether a request-to-send or allocate-confirmed notification has been received from the remote program for the specified conversation. |
void |
cmwait()
A program must use the Wait_For_Conversation (cmwait) call to wait for the completion of an outstanding operation on a conversation using conversation-level non-blocking. |
SNAConversationAttributes |
getConversationAttributes()
Gets conversation attributes object. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String version
Constructor Detail |
---|
public SNACPICCalls(SNAApi snaApi)
snaApi
- SNAApi objectMethod Detail |
---|
public SNAConversationAttributes getConversationAttributes()
public final void cmaccp() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmaccp()
public final void cmallc() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmallc()
public final void cmcanc() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmcanc()
public final void cmcfm() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmcfm()
public final void cmcfmd() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmcfmd()
public final void cmdeal() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmdeal()
public final void cmecs() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmecs()
public final void cmect() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmect()
public final void cmemn() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmemn()
public final void cmepln() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmepln()
public final void cmesl() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmesl()
public final void cmetpn() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmetpn()
public final void cmflus() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmflus()
public final void cminit() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cminit()
public final void cmptr() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmptr()
public final void cmrcv() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmrcv()
public final void cmrts() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmrts()
public final void cmsend() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsend()
public final void cmserr() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmserr()
public final void cmsct() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsct()
public final void cmsdt() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsdt()
public final void cmsed() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsed()
public final void cmsf() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsf()
public final void cmsld() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsld()
public final void cmsltp() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsltp()
public final void cmspm() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmspm()
public final void cmsmn() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsmn()
public final void cmspln() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmspln()
public final void cmsptr() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsptr()
public final void cmsrt() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsrt()
public final void cmsrc() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsrc()
public final void cmsst() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmsst()
public final void cmssl() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmssl()
public final void cmstpn() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmstpn()
public final void cmtrts() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmtrts()
public final void cmwait() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmwait()
public final void cmecsu() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmecsu()
public final void cmscsu() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmscsu()
public final void cmscsp() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmscsp()
public final void cmscst() throws SNAApplicationException
SNAApplicationException
- up on an JNI errorSNAInterface.cmscst()
|
Sun Adapter for SNA LU62 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |