TipcSrvLock

Name

TipcSrvLock — acquire exclusive access to the connection to RTserver

Synopsis

T_BOOL TipcSrvLock() 

Arguments

None

Return Values

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

Diagnostics

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

Description

TipcSrvLock locks all of the internal synchronization objects within the connection to RTserver. This insures that the calling thread in a multi-threaded process has exclusive access to the connection to RTserver. TipcSrvLock may be called by a thread recursively.

Caution

Every call to TipcSrvLock must be balanced by a call to TipcSrvUnlock.

See Also

TipcConnLock, TipcSrvUnlock

Examples

This example locks and unlocks the connection to RTserver:

if (!TipcSrvLock()) { 
  return;  /* error */ 
} 
 
/* At this point, several TipcSrv* functions could be called and there would be no risk of any other 
thread accessing the connection. The connection must be unlocked with TipcSrvUnlock when 
exclusive access is no longer needed. */ 
 
if (!TipcSrvUnlock()) { 
  return;  /* error */ 
}