TipcSrvConnOpen

Name

TipcSrvConnOpen — open a connection to RTserver

Synopsis

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

Arguments

srv — the connection to open

create_status — whether to create a warm connection (use T_IPC_SRV_CONN_WARM) or a full connection (use T_IPC_SRV_CONN_FULL)

Return Values

TRUE if the connection to RTserver was successfully opened, FALSE otherwise.

Diagnostics

If TipcSrvConnOpen fails, it returns FALSE and sets the global SmartSockets error number to one of:

T_ERR_VAL_INVALID — create_status was not T_IPC_SRV_CONN_WARM or T_IPC_SRV_CONN_FULL

T_ERR_SRV_ALREADY_CONNECTED — the connection is already open

T_ERR_SRV_ACCESS_DENIED — access was denied because another RTclient or RTserver has the same value for the unique subject

T_ERR_SRV_NOT_CONNECTED — a connection to an RTserver could not be created

Description

TipcSrvConnOpen opens the connection to RTserver. The RTclient becomes part of the project, can subscribe to subjects, can publish (send) messages to RTserver, and receive messages from RTserver. Each project is self-contained; messages cannot be sent between projects. When the connection to RTserver is created, the RTclient immediately starts subscribing to its unique subject. The RTclient can call TipcSrvConnSubjectSetSubscribe to start subscribing to other subjects.

An RTclient can have a warm connection to RTserver, which is a subset of a full connection to RTserver. Most of the other TipcSrvConn functions, such as TipcSrvConnMsgSend, call TipcSrvConnOpen if Server_Auto_Connect is set to TRUE and the RTclient does not have a full connection to RTserver. See TipcSrvConnClose for more information on warm connections to RTserver.

Caution

None

Examples

This example sets the options Project and Server_Names, then connects to RTserver:

T_IPC_SRV srv; 
 
srv = TipcSrvConnCreate(T_NULL, "demo", "tcp:mode", T_NULL); 
if (!srv) { 
  return;  /* error */ 
}  
 
if (!TipcSrvConnOpen(srv, T_IPC_SRV_CONN_FULL)) { 
  return;  /* error */ 
}