TipcSrvGetBlockMode

Name

TipcSrvGetBlockMode — get the block mode of the connection to RTserver

Synopsis

T_BOOL TipcSrvGetBlockMode(block_mode_return) 
T_BOOL *block_mode_return; 

Arguments

block_mode_return — storage for block mode

Return Values

TRUE if block mode was successfully retrieved from the connection to RTserver, FALSE otherwise.

Diagnostics

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

Description

TipcSrvGetBlockMode gets the block mode of the connection to RTserver by calling TipcConnGetBlockMode. The block mode controls whether or not the RTclient blocks waiting for read and write operations to complete. See TipcConnGetBlockMode for more information on connection block modes.

TipcSrvGetBlockMode may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvGetBlockMode does not use the warm connection, because the warm connection does not have a valid socket. See TipcSrvCreate on automatic creation of connections and warm connections to RTserver.

Caution

If TipcSrvGetBlockMode returns FALSE, it does not store a value in block_mode_return.

See Also

TipcConnGetBlockMode, TipcSrvSetBlockMode

Examples

This example gets the block mode of the connection to RTserver and prints it:

T_BOOL block_mode; 
if (!TipcSrvGetBlockMode(&block_mode)) { 
  return;  /* error */ 
}  
TutOut("Connection to RTserver %s for read/write operations.\n", 
       block_mode ? "blocks" : "does not block");