OpenTP1 Version 7 TP1/Client User's Guide TP1/Client/J
The following tables list the APIs that are used by TP1/Client/J.
Table 3-1 List of APIs (package and classes)
Classification | Name | Description or function |
---|---|---|
Package | JP.co.Hitachi.soft.OpenTP1 | Package name of the TP1/Client/J classes |
Class | TP1Client | Class name of TP1/Client/J |
DCRpcBindTbl | DCRpcBindTbl class |
Table 3-2 List of APIs (methods)
Classification | Method | Description or function |
---|---|---|
Execution | acceptNotification(byte[] inf,int[] inf_len,int port,int timeout,byte[] hostname,byte[] nodeid) | Receives messages that are sent by server's function (dc_rpc_cltsend function). |
acceptNotificationChained(byte[] inf,int[] inf_len,int timeout,byte[] hostname,byte[] nodeid) | ||
cancelNotification(byte[] inf,int inf_len,String hostname,int port) | Releases the unidirectional server message reception wait status (issuance of the acceptNotification or acceptNotificationChained method). | |
closeConnection() | Releases a permanent connection between a CUP and a RAP-processing listener and server. | |
closeNotification() | Deletes an environment for using the unidirectional message consecutive reception facility. | |
cltAssemSend(byte[] buff, int sendleng, String hostname, int portnum, int timeout, int flags) | Uses the receive message assembly facility to send a message. | |
cltAssemReceive(byte[] buff, int[] recvleng, int timeout, int flags) | Uses the receive message assembly facility to receive a message. | |
closeConnection() | Releases a permanent connection between a CUP and a RAP-processing listener and server. | |
cltReceive(byte[] buff, int[] recvleng, int timeout, int flags) | Receives a message sent by an MHP. | |
cltSend(byte[] buff, int sendleng, String hostname, int portnum, int flags) | Sends a message to an MHP. | |
getTrnID(byte[] gid, byte[] bid) | Obtains the transaction global identifier and transaction branch identifier. | |
openConnection() | Establishes a permanent connection with a RAP-processing server or connects to TP1/Web and starts a virtual session. | |
openConnection(String host, int port) | ||
openConnection(String url, short flags) | ||
openNotification(int port) | Creates an environment for using the unidirectional message consecutive reception facility. | |
rpcCall(String group, String service, byte[] in_data, int[] in_len, byte[] out_data, int[] out_len, int flags) | Issues an RPC to the specified service-group-name + service-name. | |
rpcCall(String group, String service, byte[] in_data, byte[] out_data, int flags) | ||
rpcCallTo(DCRpcBindTbl direction, String group, String service, byte[] in_data, int[] in_len, byte[] out_data, int[] out_len, int flags) | Issues an RPC to the service-group-name + service-name of the specified communication-target node. | |
rpcClose() | Releases the environment for calling a TP1/Server SPP. | |
rpcOpen() | Initializes the environment for calling a TP1/Server SPP. | |
rpcOpen(String deffilename) | ||
trnBegin() | Starts a global transaction. | |
trnChainedCommit() | Acquires the synchronization point of a transaction. | |
trnChainedRollback() | Rolls back a transaction. | |
trnInfo() | Determines whether or not the TP1Client object is running as a transaction. | |
trnUnchainedCommit() | Acquires the synchronization point of a transaction. | |
trnUnchainedRollback() | Rolls back a transaction. | |
Definition | setConnectInformation(byte[] inf, short inf_len) | Sets terminal identification information. |
setDataTraceMode(String TrcPath, int size, int Datasize, boolean flag)# | Specifies whether or not to output to a file a data trace when an RPC is issued from a Java application or servlet. | |
setDccltdelay(int sec) | Sets the communication delay time between a CUP and a RAP-processing listener and server. | |
setDccltextend(int flags) | Sets the extension level of the TP1/Client/J facility. The user can specify multiple extension levels by specifying the disjunction of each value. | |
setDccltinquiretime(int sec) | Sets the maximum time for the inquiry interval that is monitored from the RAP-processing server (if no service request is received from the client within this period, the connection is released). | |
setDchost(String host, int port) | Sets the host name and port number of the TP1/Server as a gateway. | |
setDcselint(int msec) | This method serves no purpose. It is retained only to provide compatibility with the source of the previous version. |
|
setDcwatchtim(int sec) | For a synchronous-response RPC, sets the maximum time to wait for a response from the service since a service request was issued from the CUP to the SPP. | |
setErrorTraceMode(String TrcPath, int size, boolean flag)# | Specifies whether or not to output to a file information about connection establishment with the server, disconnection from the server, and error trace when the TP1Client class is called from a Java application or servlet. | |
setMethodTraceMode(String TrcPath, int size, boolean flag)# | Specifies whether or not to output to a file a method trace when the TP1Client class is called from a Java application or servlet. | |
setRpcextend(int extendoption) | Changes RPC-related settings. | |
setScdDirectObject(String scdhost, int scdport, int flags) | Sets the host name and port number of the communication-target scheduler. | |
setTraceArray(String[] array) | Specifies the array (memory trace) for storing information about connection establishment with the server, disconnection from the server, and error trace when the TP1Client class is called from a Java application, servlet, or applet. To view the error information, you must use a Java application, servlet, or applet to reference the contents of this array. | |
setUapTraceMode(String TrcPath, int size, boolean flag)# | Specifies whether or not to output to a file a UAP trace when the TP1Client class is called from a Java application or servlet. |
#
Only Java applications and servlets can use this method. If an attempt is made to use this method with a Java applet, SecurityException occurs.
All Rights Reserved. Copyright (C) 2006, 2009, Hitachi, Ltd.