TipcSrvConnGetAutoFlushSize

Name

TipcSrvConnGetAutoFlushSize — determine the auto flush size of the connection

Synopsis

T_BOOL TipcSrvConnGetAutoFlushSize(srv, auto_flush_size_return) 
T_IPC_SRV srv; 
T_INT4 *auto_flush_size_return; 

Arguments

srv — connection handle to RTserver

auto_flush_size_return — storage for auto flush size

Return Values

TRUE if the auto flush size was successfully retrieved from the connection to RTserver, FALSE otherwise.

Diagnostics

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

Description

TipcSrvConnGetAutoFlushSize gets the auto flush size of the connection to RTserver by calling TipcConnGetAutoFlushSize. The auto flush size is used to control how much outgoing data (in bytes) is buffered before being automatically flushed to RTserver. The default for the auto flush size is 8192 bytes. See TipcConnGetAutoFlushSize for more information on auto flush sizes.

TipcSrvConnGetAutoFlushSize may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvConnGetAutoFlushSize gets the auto flush size of the warm connection. See TipcSrvConnOpen for more information on automatic creation of connections and warm connections to RTserver.

Caution

Unlike other connections, the auto flush size T_IPC_NO_AUTO_FLUSH_SIZE cannot be used with the connection to RTserver to disable all automatic flushing of outgoing messages.

If TipcSrvConnGetAutoFlushSize returns FALSE, it does not store a value in auto_flush_size_return.

See Also

TipcConnGetAutoFlushSize, TipcSrvConnSetAutoFlushSize

Examples

This example creates a connection to RTserver, then gets and prints the auto flush size of the connection to RTserver:

T_INT4 auto_flush_size; 
 
if (!TipcSrvConnOpen(srv, T_IPC_SRV_CONN_FULL)) { 
  return;  /* error */ 
}  

if (!TipcSrvConnGetAutoFlushSize(srv, &auto_flush_size)) { 
  return;  /* error */ 
}  
 
TutOut("The connection to RTserver auto flush size is %d bytes.\n", 
       auto_flush_size);