TipcSrvConnSetGmdDirName

Name

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

Synopsis

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

Arguments

srv — connection handle to RTserver

gmd_dir_name — sub-directory name of the connection to RTserver's GMD area

Return Values

TRUE if the GMD area sub-directory name was successfully set for the connection to RTserver, FALSE otherwise.

Diagnostics

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

T_ERR_IN_USE — the GMD area files are already open

T_ERR_NULL_PTR — srv or gmd_dir_name was null

T_ERR_SRV_NOT_CONNECTED — a connection to RTserver could not be created

Description

TipcSrvConnSetGmdDirName is used to set the GMD area sub-directory file name to a unique value for each connection to RTserver.

By default the GMD area sub-directory name is the RTclient’s unique subject. However, file conflicts occur when an RTclient process using multiple connections and file-based GMD shares the same unique subject and project on each connection. Multiple connections sharing the same unique subject and project are only allowed when each connection connects to a different RTserver cloud. In that case, TipcSrvConnSetGmdDirName must be called to set the GMD area sub-directory to a unique value for each connection.

Caution

None

Examples

This example sets the GMD area sub-directory of the connection to RTserver:

if (!TipcSrvConnSetGmdDirName(srv, "connection1")) { 
  return;  /* error */ 
}