TipcSrvConnGetUniqueSubject

Name

TipcSrvConnGetUniqueSubject — get the unique subject of the connected RTserver

Synopsis

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

Arguments

srv — connection handle to RTserver

unique_subject_return — storage for RTserver unique subject

Return Values

TRUE if the unique subject was successfully retrieved from the connection handle to RTserver, FALSE otherwise.

Diagnostics

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

Description

TipcSrvConnGetUniqueSubject gets the unique subject of the RTserver this RTclient is connected to by calling TipcConnGetUniqueSubject. The RTserver unique subject can be useful for diagnostic purposes. The unique subject, which is used to uniquely identify a process, is stored in the option Unique_Subject. There is some overlap between TipcSrvConnGetUniqueSubject and TipcSrvMonServerGeneralPoll, but TipcSrvConnGetUniqueSubject is easier to use if only the unique subject is needed instead of all RTserver general information.

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

Caution

If TipcSrvConnGetUniqueSubject returns FALSE, it does not store a value in unique_subject_return.

The value stored in unique_subject_return points directly into an internal data structure and should not be modified.

See Also

TipcConnGetUniqueSubject, TipcSrvMonServerGeneralPoll, TipcSrvConnGetArch, TipcSrvConnGetNode, TipcSrvConnGetPid, TipcSrvConnGetUser

Examples

This example retrieves and prints the unique subject of the connected RTserver:

T_IPC_SRV srv; 
T_STR unique_subject; 
 
if (!TipcSrvConnGetUniqueSubject(srv, &unique_subject)) { 
  return;  /* error */ 
} 
 
TutOut("RTserver unique subject is <%s>.\n",  
       unique_subject);