![]() |
T4S4
18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
acknowledgeMessage connectionID messageID | |
Explicitly acknowledge a specific message via an open consumer connection. More... | |
closeAll ?timeout? | |
Close all opened connections including the pipe. More... | |
closeConnection connectionID ?timeout? | |
Close a specific producer or consumer connection. Clean up all stored messages for this connection. If no other connection exists, also close the pipe. More... | |
receiveMessage connectionID receiveMode ?timeout? | |
Receive binary or text messages via an open consumer connection. More... | |
sendBinaryMessage connectionID properties payload ?headers? | |
Send binary messages via an open producer connection. (wrapper to sendMessage) More... | |
sendStringMessage connectionID properties payload ?headers? | |
Send text messages via an open producer connection. (wrapper to sendMessage) More... | |
startConnection connectionID connectionType config ?userName? ?password? | |
Start a producer or consumer connection for a given configuration. More... | |
T4X::MESSAGING::acknowledgeMessage | connectionID messageID | ||
Explicitly acknowledge a specific message via an open consumer connection.
Note: In order to explicitly acknowledge messages, the acknowledge mode needs to be set to CLIENT_ACKNOWLEDGE in the configuration dictionary passed to procedure startConnection (key t4x.acknowledgeMode)
connectionID | - Unique identifier of the consumer connection |
messageID | - ID of the message to be acknowledged (message ID returned by receiveMessage) |
References T4X::CORE::getLogLineMessageType4rc(), T4X::CORE::getSessionLogChannel(), T4X::JAVASERVER::setDefaultLogChannel(), T4X::OBJECTS::tpwith(), and tpwrite().
T4X::MESSAGING::closeAll | ?timeout? | ||
Close all opened connections including the pipe.
timeout | - Pipe shutdown timeout (Optional - Default: Empty) |
References T4X::CORE::getLogLineMessageType4rc(), T4X::CORE::getSessionLogChannel(), T4X::JAVASERVER::setDefaultLogChannel(), T4X::JAVASERVER::tpcontrol(), T4X::OBJECTS::tplet(), T4X::OBJECTS::tprevertto(), and tpwrite().
T4X::MESSAGING::closeConnection | connectionID ?timeout? | ||
Close a specific producer or consumer connection. Clean up all stored messages for this connection. If no other connection exists, also close the pipe.
connectionID | - Unique identifier of the producer or consumer connection |
timeout | - Pipe shutdown timeout (Optional - Default: Empty) |
References T4X::CORE::getLogLineMessageType4rc(), T4X::CORE::getSessionLogChannel(), T4X::JAVASERVER::setDefaultLogChannel(), T4X::JAVASERVER::tpcontrol(), T4X::OBJECTS::tprevertto(), T4X::OBJECTS::tpwith(), and tpwrite().
T4X::MESSAGING::receiveMessage | connectionID receiveMode ?timeout? | ||
Receive binary or text messages via an open consumer connection.
connectionID | - Unique identifier of the consumer connection |
receiveMode | - Possible receive modes: BLOCK - Blocks indefinitely until a message is produced or until this message consumer is closed. BLOCK_TIMEOUT - Blocks until a message arrives, the timeout expires, or this message consumer is closed. NON_BLOCK - Receives the next message if one is immediately available. |
timeout | - The timeout for BLOCK_TIMEOUT mode (Optional - Default: 1000) |
References T4X::CORE::getLogLineMessageType4rc(), T4X::CORE::getSessionLogChannel(), T4X::JAVASERVER::setDefaultLogChannel(), T4X::OBJECTS::tplet(), T4X::OBJECTS::tpwith(), and tpwrite().
T4X::MESSAGING::sendBinaryMessage | connectionID properties payload ?headers? | ||
Send binary messages via an open producer connection. (wrapper to sendMessage)
connectionID | - Unique identifier of the producer connection |
properties | - Dictionary containing the message property fields |
payload | - Message body containing binary data. Note: The binary message body data passed to this parameter needs to be HEX16. Use interfaces tpco_H16Bin2File and tpco_readfileH16 in order to convert file data correctly. |
headers | - Dictionary containing the message header fields |
References T4X::CORE::getSessionLogChannel(), and tpwrite().
T4X::MESSAGING::sendStringMessage | connectionID properties payload ?headers? | ||
Send text messages via an open producer connection. (wrapper to sendMessage)
connectionID | - Unique identifier of the producer connection |
properties | - Dictionary containing the message property fields |
payload | - Message body containing text data. |
headers | - Dictionary containing the message header fields |
References T4X::CORE::getSessionLogChannel(), and tpwrite().
T4X::MESSAGING::startConnection | connectionID connectionType config ?userName? ?password? | ||
Start a producer or consumer connection for a given configuration.
Note: If the connection for specified connectionID already exists in cache, nothing is done.
connectionID | - Unique identifier for the connection |
connectionType | - Connection type: PRODUCER for sending messages CONSUMER for receiving messages |
config | - Dictionary containing the following configuration parameters of the connection:
|
userName | - The caller's user name (Optional). If not specified, a connection with the default user identity will be establised. |
password | - The caller's password (Optional). |
References T4X::CORE::getLogLineMessageType4rc(), T4X::CORE::getSessionLogChannel(), T4X::JAVASERVER::setDefaultLogChannel(), T4X::OBJECTS::tpmodule(), T4X::OBJECTS::tpsnapshot(), T4X::OBJECTS::tpwith(), and tpwrite().