TipcSrvConnGetPid

Name

TipcSrvConnGetPid — get the process ID of the connected RTserver

Synopsis

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

Arguments

srv — connection handle to RTserver

pid_return — storage for the RTserver process ID

Return Values

TRUE if the process ID was successfully retrieved from the connection to RTserver, FALSE otherwise.

Diagnostics

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

Description

TipcSrvConnGetPid gets the operating system process ID of the RTserver this RTclient is connected to by calling TipcConnGetPid. The RTserver process ID can be useful for diagnostic purposes. There is some overlap between TipcSrvConnGetPid and TipcSrvMonServerGeneralPoll, but TipcSrvConnGetPid is easier to use if only the process ID is needed instead of all RTserver general information.

TipcSrvConnGetPid may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvConnGetPid does not use the warm connection, because the warm connection does not have a peer process with a process ID. See TipcSrvConnOpen for more information on automatic creation of connections and warm connections to RTserver.

Caution

If TipcSrvConnGetPid returns FALSE, it does not store a value in pid_return.

See Also

TipcConnGetPid, TipcSrvMonServerGeneralPoll, TipcSrvConnGetArch, TipcSrvConnGetNode, TipcSrvConnGetUniqueSubject, TipcSrvConnGetUser

Examples

This example prints the process ID of the connected RTserver:

T_IPC_SRV srv; 
T_INT4 pid_return; 
if (!TipcSrvConnGetPid(srv, &pid_return)) { 
  return;  /* error */ 
} 
 
TutOut("RTserver ID is <%d>.\n", pid_return);