Multiple Connection Functions (TipcSrvConn*)

The TipcSrvConn* functions are used for communication between a client program (RTclient) and RTserver. These functions enable the publish-subscribe message delivery services of SmartSockets.

Callback Functions (TipcSrvConn*Cb*)

TipcSrvConnCloseCbCreate — create a server close callback 

T_CB TipcSrvConnCloseCbCreate(srv, func, arg) 
T_IPC_SRV srv; 
T_IPC_SRV_DESTROY_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnCloseCbLookup — look up a server close callback 

T_CB TipcSrvConnCloseCbLookup(srv, func, arg) 
T_IPC_SRV srv; 
T_IPC_SRV_DESTROY_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnDefaultCbCreate — create a default callback in the connection 

T_CB TipcSrvConnDefaultCbCreate(srv, func, arg) 
T_IPC_SRV srv; 
T_IPC_CONN_DEFAULT_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnDefaultCbLookup — look up a default callback in the connection 

T_CB TipcSrvConnDefaultCbLookup(srv, func, arg) 
T_IPC_SRV srv; 
T_IPC_CONN_DEFAULT_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnErrorCbCreate — create an error callback in the connection 

T_CB TipcSrvConnErrorCbCreate(srv, func, arg) 
T_IPC_SRV srv; 
T_IPC_CONN_ERROR_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnErrorCbLookup — look up an error callback in the connection 

T_CB TipcSrvConnErrorCbLookup(srv, func, arg) 
T_IPC_SRV srv; 
T_IPC_CONN_ERROR_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnGetCurrentConnectedLcn — get the logical connection name of the RTserver to which this RTclient is connected 

T_BOOL TipcSrvConnGetCurrentConnectedLcn(srv, lcn_return) 
T_IPC_SRV srv; 
T_STR lcn_return;

TipcSrvConnOpenCbCreate — create a server open callback 

T_CB TipcSrvConnOpenCbCreate(srv, func, arg) 
T_IPC_SRV srv; 
T_IPC_SRV_CREATE_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnOpenCbLookup — look up a server open callback 

T_CB TipcSrvConnOpenCbLookup(srv, func, arg) 
T_IPC_SRV srv; 
T_IPC_SRV_CREATE_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnProcessCbCreate — create a process callback in the connection 

T_CB TipcSrvConnProcessCbCreate(srv, mt, func, arg) 
T_IPC_SRV srv; 
T_IPC_MT mt; 
T_IPC_CONN_PROCESS_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnProcessCbLookup — look up a process callback in the connection 

T_CB TipcSrvConnProcessCbLookup(srv, mt, func, arg) 
T_IPC_SRV srv; 
T_IPC_MT mt; 
T_IPC_CONN_PROCESS_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnQueueCbCreate — create a queue callback in the connection 

T_CB TipcSrvConnQueueCbCreate(srv, mt, func, arg) 
T_IPC_SRV srv; 
T_IPC_MT mt; 
T_IPC_CONN_QUEUE_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnQueueCbLookup — look up a queue callback in the connection 

T_CB TipcSrvConnQueueCbLookup(srv, mt, func, arg) 
T_IPC_SRV srv; 
T_IPC_MT mt; 
T_IPC_CONN_QUEUE_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnReadCbCreate — create a read callback in the connection 

T_CB TipcSrvConnReadCbCreate(srv, mt, func, arg) 
T_IPC_SRV srv; 
T_IPC_MT mt; 
T_IPC_CONN_READ_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnReadCbLookup — look up a read callback in the connection 

T_CB TipcSrvConnReadCbLookup(srv, mt, func, arg) 
T_IPC_SRV srv; 
T_IPC_MT mt; 
T_IPC_CONN_READ_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnSubjectCbCreate — create a subject callback 

T_CB TipcSrvConnSubjectCbCreate(srv, subject, mt, func, arg) 
T_IPC_SRV srv; 
T_STR subject; 
T_IPC_MT mt; 
T_IPC_SRV_SUBJECT_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnSubjectCbDestroyAll— destroy all subject callbacks 

T_BOOL TipcSrvSubjectCbDestroyAll(srv) 
T_IPC_SRV srv;

TipcSrvConnSubjectCbLookup — lookup a subject callback 

T_CB TipcSrvConnSubjectCbLookup(srv, subject, mt, func, arg) 
T_IPC_SRV srv; 
T_STR subject; 
T_IPC_MT mt; 
T_IPC_SRV_SUBJECT_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnSubjectDefaultCbCreate — create a default subject callback 

T_CB TipcSrvConnSubjectDefaultCbCreate(srv, func, arg) 
T_IPC_SRV srv; 
T_IPC_SRV_SUBJECT_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnSubjectDefaultCbLookup — look up a default subject callback 

T_CB TipcSrvConnSubjectDefaultCbLookup(srv, func, arg) 
T_IPC_SRV srv; 
T_IPC_SRV_SUBJECT_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnWriteCbCreate — create a write callback in the connection 

T_CB TipcSrvConnWriteCbCreate(srv, mt, func, arg) 
T_IPC_SRV srv; 
T_IPC_MT mt; 
T_IPC_CONN_WRITE_CB_FUNC func; 
T_CB_ARG arg;

TipcSrvConnWriteCbLookup — look up a write callback in the connection 

T_CB TipcSrvConnWriteCbLookup(srv, mt, func, arg) 
T_IPC_SRV srv; 
T_IPC_MT mt; 
T_IPC_CONN_WRITE_CB_FUNC func; 
T_CB_ARG arg;

Subject Functions (TipcSrvConn*Subject*)

The TipcSrvConn*Subject* functions are used to work with subjects.

TipcSrvConnStdSubjectSetSubscribe — start or stop subscribing to all standard subjects 

T_BOOL TipcSrvConnStdSubjectSetSubscribe(srv, subscribe_status) 
T_IPC_SRV srv; 
T_BOOL subscribe_status;

TipcSrvConnSubjectGetSubscribe — determine whether an RTclient is subscribing to a subject 

T_BOOL TipcSrvConnSubjectGetSubscribe(srv, subject, 
subscribe_status_return) 
T_IPC_SRV srv; 
T_STR subject; 
T_BOOL *subscribe_status_return;

TipcSrvConnSubjectGetSubscribeLb — determine whether an RTclient is subscribing to a subject, including load balancing information 

T_BOOL TipcSrvConnSubjectGetSubscribeLb(srv, subject, 
subscribe_status_return, lb_status_return) 
T_IPC_SRV srv; 
T_STR subject; 
T_BOOL *subscribe_status_return; 
T_BOOL *lb_status_return;

TipcSrvConnSubjectGmdInit — initialize GMD accounting in RTserver for a subject to which messages will be published 

T_BOOL TipcSrvConnSubjectGmdInit(srv, subject) 
T_IPC_SRV srv; 
T_STR subject;

TipcSrvConnSubjectLbInit — initialize load balancing accounting in RTserver for a subject to which messages will be published 

T_BOOL TipcSrvConnSubjectLbInit(srv, subject) 
T_IPC_SRV srv; 
T_STR subject;

TipcSrvConnSubjectSetSubscribe — start or stop subscribing to a subject 

T_BOOL TipcSrvConnSubjectSetSubscribe(srv, subject, 
subscribe_status) 
T_IPC_SRV srv; 
T_STR subject; 
T_BOOL subscribe_status;

TipcSrvConnSubjectSetSubscribeEx — start or stop subscribing to a subject using extended options 

T_BOOL TipcSrvConnSubjectSetSubscribeEx(srv, subj_name, status, 
type, flags, type_specific_struct) 
T_IPC_SRV srv; 
T_STR subj_name; 
T_BOOL status; 
T_INT4 type; 
T_INT4 flags; 
T_PTR type_specific_struct;

TipcSrvConnSubjectSetSubscribeLb — start or stop subscribing to a subject, with or without load balancing 

T_BOOL TipcSrvConnSubjectSetSubscribeLb(srv, subject, 
subscribe_status, lb_status) 
T_IPC_SRV srv; 
T_STR subject; 
T_BOOL subscribe_status; 
T_BOOL lb_status;

TipcSrvConnSubjectTraverseSubscribe — traverse the subjects that the RTclient is subscribing to 

T_PTR TipcSrvConnSubjectTraverseSubscribe(srv, func, arg) 
T_IPC_SRV srv; 
T_IPC_SRV_SUBJECT_TRAV_FUNC func; 
T_PTR arg;

GMD Functions (TipcSrvConnGmd*)

The TipcSrvConnGmd* functions are used to work with the guaranteed message delivery services of SmartSockets when using the publish-subscribe communication mode.

TipcSrvConnGmdFileCreate — create a GMD area on the connection 

T_BOOL TipcSrvConnGmdFileCreate(srv) 
T_IPC_SRV srv;

TipcSrvConnGmdFileDelete — delete GMD files for the connection 

T_BOOL TipcSrvConnGmdFileDelete(srv) 
T_IPC_SRV srv;

TipcSrvConnGmdMsgDelete — delete a message from the GMD area after a GMD failure 

T_BOOL TipcSrvConnGmdMsgDelete(srv, msg) 
T_IPC_SRV srv; 
T_IPC_MSG msg;

TipcSrvConnGmdMsgServerDelete — delete a message in RTserver after a GMD failure 

T_BOOL TipcSrvConnGmdMsgServerDelete(srv, msg) 
T_IPC_SRV srv; 
T_IPC_MSG msg;

TipcSrvConnGmdMsgStatus — poll RTserver for GMD status of a message 

T_BOOL TipcSrvConnGmdMsgStatus(srv, msg) 
T_IPC_SRV srv; 
T_IPC_MSG msg;

Miscellaneous Functions (TipcSrvConn*)

These functions do not fit with any of the other categories. The miscellaneous functions are used for tasks such as creating a connection to RTserver, destroying a connection to RTserver, checking if an RTserver is running, checking if an RTserver is still alive, and stopping an RTserver.

TipcSrvConnCheck — check if data can be read from or written to connection 

T_BOOL TipcSrvConnCheck(srv, check_mode, timeout) 
T_IPC_SRV srv; 
T_IO_CHECK_MODE check_mode; 
T_REAL8 timeout;

TipcSrvConnClose — close a physical connection to RTserver 

T_BOOL TipcSrvConnClose(srv, conn_status) 
T_IPC_SRV srv; 
T_IPC_SRV_CONN_STATUS conn_status;

TipcSrvConnCreate — create an RTclient connection handle to an RTserver 

T_IPC_SRV TipcSrvConnCreate(unique_subject, project, server_names, 
default_subject_prefix) 
T_STR unique_subject; 
T_STR project; 
T_STR server_names; 
T_STR default_subject_prefix;

TipcSrvConnCreateNamed — create a named RTclient connection handle to an RTserver 

T_IPC_SRV TipcSrvConnCreateNamed(name) 
T_STR name;

TipcSrvConnDestroy — free resources associated with the RTclient/RTserver connection handle 

T_BOOL TipcSrvConnDestroy(srv) 
T_IPC_SRV srv;

TipcSrvConnKeepAlive — check if the connection to RTserver is still alive 

T_BOOL TipcSrvConnKeepAlive(srv) 
T_IPC_SRV srv;

TipcSrvConnLock — acquire exclusive access to the connection 

T_BOOL TipcSrvConnLock(srv) 
T_IPC_SRV srv;

TipcSrvConnOpen — open a connection to RTserver 

T_BOOL TipcSrvConnOpen(srv, create_status) 
T_IPC_SRV srv; 
T_IPC_SRV_CONN_STATUS create_status;

TipcSrvConnPrint — print all information about the connection in a portable, reproducible format 

T_BOOL TipcSrvConnPrint(srv, func) 
T_IPC_SRV srv; 
T_OUT_FUNC func;

TipcSrvConnUnlock — release exclusive access to the connection 

T_BOOL TipcSrvConnUnlock(srv) 
T_IPC_SRV srv;

Property Get Functions (TipcSrvConnGet*, TipcSrv*Get*, and TipcSrvConnSubjectGet*)

The TipcSrvConnGet*, TipcSrv*Get*, and TipcSrvConnSubjectGet* functions are used to retrieve the properties of a connection to an RTserver.

TipcSrvBufferGetReadSize — get the total number of bytes in a connection’s read buffer to an RTserver 

T_BOOL TipcSrvBufferGetReadSize(read_size_return) 
T_INT4 *read_size_return;

TipcSrvBufferGetWriteSize — get the total number of bytes in a connection’s write buffer to an RTserver 

T_BOOL TipcSrvBufferGetWriteSize(write_size_return) 
T_INT4 *write_size_return;

TipcSrvConnBufferGetReadSize — get the total number of bytes in a connection’s read buffer to an RTserver 

T_BOOL TipcSrvConnBufferGetReadSize(srv, read_size_return) 
T_IPC_SRV srv; 
T_INT4 *read_size_return;

TipcSrvConnBufferGetWriteSize — get the total number of bytes in a connection’s write buffer to an RTserver 

T_BOOL TipcSrvConnBufferGetWriteSize(conn, write_size_return) 
T_IPC_SRV srv; 
T_INT4 *write_size_return;

TipcSrvConnGetAutoFlushSize — determine the automatic flush size of the connection 

T_BOOL TipcSrvConnGetAutoFlushSize(srv, auto_flush_size_return) 
T_IPC_SRV srv; 
T_INT4 *auto_flush_size_return;

TipcSrvConnGetConnStatus — determine the status of the connection 

T_BOOL TipcSrvConnGetConnStatus(srv, status_return) 
T_IPC_SRV srv; 
T_IPC_SRV_CONN_STATUS *status_return;

TipcSrvConnGetGmdDirName — get the GMD area sub-directory name of the connection to RTserver 

T_BOOL TipcSrvConnGetGmdDirName(srv, gmd_dir_name_return) 
T_IPC_SRV srv; 
T_STR *gmd_dir_name_return;

TipcSrvConnGetGmdMaxSize — determine the GMD area maximum size of the connection 

T_BOOL TipcSrvConnGetGmdMaxSize(srv, gmd_max_size_return) 
T_IPC_SRV srv; 
T_UINT4 *gmd_max_size_return;

TipcSrvConnGetGmdNumPending — determine the number of outgoing GMD messages still pending on the connection 

T_BOOL TipcSrvConnGetGmdNumPending(srv, gmd_num_pending_return) 
T_IPC_SRV srv; 
T_INT4 *gmd_num_pending_return;

TipcSrvConnGetNumQueued — get number of queued messages from the connection 

T_BOOL TipcSrvConnGetNumQueued(srv, num_queued_return) 
T_IPC_SRV srv; 
T_INT4 *num_queued_return;

TipcSrvConnGetProject — get the project of the connection to RTserver 

T_BOOL TipcSrvConnGetProject(srv, project_return) 
T_IPC_SRV srv; 
T_STR *project_return;

TipcSrvConnGetServerNamesList — get the server names of the connection to RTserver 

T_BOOL TipcSrvConnGetServerNamesList(srv, server_names_list_return) 
T_IPC_SRV srv; 
T_STR_LIST *server_names_list_return;

TipcSrvConnGetSocket — determine the socket of the connection 

T_BOOL TipcSrvConnGetSocket(srv, socket_return) 
T_IPC_SRV srv; 
T_INT4 *socket_return;

TipcSrvConnGetTimeout — get a timeout property from the connection 

T_BOOL TipcSrvConnGetTimeout(srv, timeout, value_return) 
T_IPC_SRV srv; 
T_IPC_TIMEOUT timeout; 
T_REAL8 *value_return;

TipcSrvConnGetXtSource — get source for XtAppAddInput from the connection 

T_BOOL TipcSrvConnGetXtSource(srv, source_return) 
T_IPC_SRV srv; 
T_INT4 *source_return;

TipcSrvConnSubjectGetDefaultPrefix — get the default subject prefix of the connection to RTserver 

T_BOOL TipcSrvConnSubjectGetDefaultPrefix(srv, 
default_prefix_return) 
T_IPC_SRV srv; 
T_STR *default_prefix_return;

TipcSrvConnSubjectGetUnique — get the unique subject of the connection to RTserver 

T_BOOL TipcSrvConnGetUniqueSubject(srv, unique_subject_return) 
T_IPC_SRV srv; 
T_STR *unique_subject_return;

TipcSrvConnTrafficGetBytesRecv8 — get the total number of bytes received on a connection to an RTserver 

T_BOOL TipcSrvConnTrafficGetBytesRecv8(srv, bytes_recv_return) 
T_IPC_SRV srv; 
T_INT8 *bytes_recv_return;

TipcSrvConnTrafficGetBytesSent8 — get the total number of bytes sent on a connection to an RTserver 

T_BOOL TipcSrvConnTrafficGetBytesSent8(srv, bytes_sent_return) 
T_IPC_SRV srv; 
T_INT8 *bytes_sent_return;

TipcSrvConnTrafficGetMsgsRecv8 — get the total number of messages received on a connection to an RTserver 

T_BOOL TipcSrvConnTrafficGetMsgsRecv8(srv, msgs_recv_return) 
T_IPC_SRV srv; 
T_INT8 *msgs_recv_return;

TipcSrvConnTrafficGetMsgsSent8 — get the total number of messages sent on a connection to an RTserver 

T_BOOL TipcSrvConnTrafficGetMsgsSent8(srv, msgs_sent_return) 
T_IPC_SRV srv; 
T_INT8 *msgs_sent_return;

The previous functions supersede their older counterparts. Do not use the following older functions; we have retained them only for backward source compatibility.

TipcSrvConnTrafficGetBytesRecv — get the total number of bytes received on a connection to an RTserver 

T_BOOL TipcSrvConnTrafficGetBytesRecv(srv, bytes_recv_return) 
T_IPC_SRV srv; 
T_INT4 *bytes_recv_return;

TipcSrvConnTrafficGetBytesSent — get the total number of bytes sent on a connection to an RTserver 

T_BOOL TipcSrvConnTrafficGetBytesSent(srv, bytes_sent_return) 
T_IPC_SRV srv; 
T_INT4 *bytes_sent_return;

TipcSrvConnTrafficGetMsgsRecv — get the total number of messages received on a connection to an RTserver 

T_BOOL TipcSrvConnTrafficGetMsgsRecv(srv, msgs_recv_return) 
T_IPC_SRV srv; 
T_INT4 *msgs_recv_return;

TipcSrvConnTrafficGetMsgsSent — get the total number of messages sent on a connection to an RTserver 

T_BOOL TipcSrvConnTrafficGetMsgsSent(srv, msgs_sent_return) 
T_IPC_SRV srv; 
T_INT4 *msgs_sent_return;

TipcSrvTrafficGetBytesRecv8 — get the total number of bytes received on a connection to an RTserver 

T_BOOL TipcSrvTrafficGetBytesRecv8(bytes_recv_return) 
T_INT8 *bytes_recv_return;

TipcSrvTrafficGetBytesSent8 — get the total number of bytes sent on a connection to an RTserver 

T_BOOL TipcSrvTrafficGetBytesSent8(bytes_sent_return) 
T_INT8 *bytes_sent_return;

TipcSrvTrafficGetMsgsRecv8 — get the total number of messages received on a connection to an RTserver 

T_BOOL TipcSrvTrafficGetMsgsRecv8(msgs_recv_return) 
T_INT8 *msgs_recv_return;

TipcSrvTrafficGetMsgsSent8 — get the total number of messages sent on a connection to an RTserver 

T_BOOL TipcSrvTrafficGetMsgsSent8(msgs_sent_return) 
T_INT8 *msgs_sent_return;

The previous functions supersede their older counterparts. Do not use the following older functions; we have retained them only for backward source compatibility.

TipcSrvTrafficGetBytesRecv — get the total number of bytes received on a connection to an RTserver 

T_BOOL TipcSrvTrafficGetBytesRecv(bytes_recv_return) 
T_INT4 *bytes_recv_return;

TipcSrvTrafficGetBytesSent — get the total number of bytes sent on a connection to an RTserver 

T_BOOL TipcSrvTrafficGetBytesSent(bytes_sent_return) 
T_INT4 *bytes_sent_return;

TipcSrvTrafficGetMsgsRecv — get the total number of messages received on a connection to an RTserver 

T_BOOL TipcSrvTrafficGetMsgsRecv(msgs_recv_return) 
T_INT4 *msgs_recv_return;

TipcSrvTrafficGetMsgsSent — get the total number of messages sent on a connection to an RTserver 

T_BOOL TipcSrvTrafficGetMsgsSent(msgs_sent_return) 
T_INT4 *msgs_sent_return;

Property Set Functions (TipcSrvConnSet* and TipcSrvConnSubjectSet*)

The TipcSrvConnSet* and TipcSrvConnSubjectSet* functions are used to set the values of the properties of a connection to RTserver.

TipcSrvConnSetAutoFlushSize — set the automatic flush size of the connection 

T_BOOL TipcSrvConnSetAutoFlushSize(srv, auto_flush_size) 
T_IPC_SRV srv; 
T_INT4 auto_flush_size;

TipcSrvConnSetGmdDirName — set the GMD area sub-directory name of the connection to RTserver 

T_BOOL TipcSrvConnSetGmdDirName(srv, gmd_dir_name) 
T_IPC_SRV srv; 
T_STR gmd_dir_name;

TipcSrvConnSetGmdMaxSize — set the GMD area maximum size of the connection 

T_BOOL TipcSrvConnSetGmdMaxSize(srv, gmd_max_size) 
T_IPC_SRV srv; 
T_UINT4 gmd_max_size;

TipcSrvConnSetProject — set the project of the connection to RTserver 

T_BOOL TipcSrvConnSetProject(srv, project) 
T_IPC_SRV srv; 
T_STR project;

TipcSrvConnSetServerNames — set the server names of a connection to RTserver 

T_BOOL TipcSrvConnSetServerNames(srv, server_names) 
T_IPC_SRV srv; 
T_STR server_names;

TipcSrvConnSetServerNamesList — set the server names of the connection to RTserver in a linked list of strings 

T_BOOL TipcSrvConnSetServerNamesList(srv, server_names_list) 
T_IPC_SRV srv; 
T_STR_LIST server_names_list;

TipcSrvConnSetTimeout — set a timeout property of the connection 

T_BOOL TipcSrvConnSetTimeout(srv, timeout, value) 
T_IPC_SRV srv; 
T_IPC_TIMEOUT timeout; 
T_REAL8 value;

TipcSrvConnSetUsernamePassword — set the basic credentials of the connection to RTserver 

T_BOOL TipcSrvConnSetUsernamePassword(srv, username, password) 
T_IPC_SRV srv; 
T_STR username; 
T_STR password;

TipcSrvConnSubjectSetDefaultPrefix — set the connection’s default subject prefix 

T_BOOL TipcSrvConnSubjectSetDefaultPrefix(srv, default_prefix) 
T_IPC_SRV srv; 
T_STR default_prefix;

TipcSrvConnSubjectSetUnique — set the unique subject of the connection to RTserver 

T_BOOL TipcSrvConnSubjectSetUnique(srv, unique_subject) 
T_IPC_SRV srv; 
T_STR unique_subject;

Peer Property Functions (TipcSrvConnGet*)

These TipcSrvConnGet* functions are used to retrieve the values of the properties of a peer connection to RTserver.

TipcSrvConnGetArch — determine the architecture name of the connected RTserver 

T_BOOL TipcSrvConnGetArch(srv, arch_return) 
T_IPC_SRV srv; 
T_STR *arch_return;

TipcSrvConnGetNode — determine the node name of the connected RTserver 

T_BOOL TipcSrvConnGetNode(srv, node_return) 
T_IPC_SRV srv; 
T_STR *node_return;

TipcSrvConnGetPid — determine the process ID of the connected RTserver 

T_BOOL TipcSrvConnGetPid(srv, pid_return) 
T_IPC_SRV srv; 
T_INT4 *pid_return;

TipcSrvConnGetUniqueSubject — get the unique subject for the peer connection 

T_BOOL TipcSrvConnGetUniqueSubject(srv, unique_subject) 
T_IPC_SRV srv; 
T_STR *unique_subject;

TipcSrvConnGetUser — determine the user name of the connected RTserver 

T_BOOL TipcSrvConnGetUser(srv, user_return) 
T_IPC_SRV srv; 
T_STR *user_return;

Reading and Processing Messages from RTserver (TipcSrvConn*)

These functions are used to read, process, or search for messages arriving from RTserver.

TipcSrvConnMainLoop — read and process messages on the connection 

T_BOOL TipcSrvConnMainLoop(srv, timeout) 
T_IPC_SRV srv; 
T_REAL8 timeout;

TipcSrvConnMsgNext — retrieve the next message from the connection 

T_IPC_MSG TipcSrvConnMsgNext(srv, timeout) 
T_IPC_SRV srv; 
T_REAL8 timeout;

TipcSrvConnMsgProcess — process a message in the connection to RTserver 

T_BOOL TipcSrvConnMsgProcess(srv, msg) 
T_IPC_SRV srv; 
T_IPC_MSG msg;

TipcSrvConnMsgSearch — search the message queue of the connection for a specific message 

T_IPC_MSG TipcSrvConnMsgSearch(srv, timeout, func, arg) 
T_IPC_SRV srv; 
T_REAL8 timeout; 
T_IPC_CONN_MSG_SEARCH_FUNC func; 
T_PTR arg;

TipcSrvConnMsgSearchType — search the message queue of a connection for a message with a specific type 

T_IPC_MSG TipcSrvConnMsgSearchType(srv, timeout, mt) 
T_IPC_SRV srv; 
T_REAL8 timeout; 
T_IPC_MT mt;

TipcSrvConnRead — read all available data from the connection and queue messages in priority order 

T_BOOL TipcSrvConnRead(srv, timeout) 
T_IPC_SRV srv; 
T_REAL8 timeout;

Publishing Messages (TipcSrvConn*)

These functions are used to publish messages using RTserver.

TipcSrvConnFlush — flush buffered outgoing messages on the connection 

T_BOOL TipcSrvConnFlush(srv) 
T_IPC_SRV srv;

TipcSrvConnMsgInsert — insert a message into the queue of the connection 

T_BOOL TipcSrvConnMsgInsert(srv, msg, pos) 
T_IPC_SRV srv; 
T_IPC_MSG msg; 
T_INT4 pos;

TipcSrvConnMsgSend — send a message through the connection 

T_BOOL TipcSrvConnMsgSend(srv, msg, check_server_msg_send) 
T_IPC_SRV srv; 
T_IPC_MSG msg; 
T_BOOL check_server_msg_send;

TipcSrvConnMsgSendRpc — make a remote procedure call (RPC) with messages on the connection 

T_IPC_MSG TipcSrvConnMsgSendRpc(srv, call_msg, timeout) 
T_IPC_SRV srv; 
T_IPC_MSG call_msg; 
T_REAL8 timeout;

TipcSrvConnMsgWrite — construct a message and send it through the connection 

T_BOOL TipcSrvConnMsgWrite(srv, dest, mt, check_server_msg_send, 
...) 
T_IPC_SRV srv; 
T_STR dest; 
T_IPC_MT mt; 
T_BOOL check_server_msg_send;

TipcSrvConnMsgWriteVa — construct a message and send it through the connection (va_list version) 

T_BOOL TipcSrvConnMsgWriteVa(srv, dest, mt, check_server_msg_send, 
var_arg_list) 
T_IPC_SRV srv; 
T_STR dest; 
T_IPC_MT mt; 
T_BOOL check_server_msg_send; 
va_list var_arg_list;
TIBCO SmartSockets™ API Quick Reference
Software Release 6.8, July 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com