TipcSrvConnSetAutoFlushSize

Name

TipcSrvConnSetAutoFlushSize — set the auto flush size of the connection

Synopsis

T_BOOL TipcSrvConnSetAutoFlushSize(srv, auto_flush_size) 
T_IPC_SRV srv; 
T_INT4 auto_flush_size; 

Arguments

srv — connection to RTserver

auto_flush_size — auto flush size (in bytes)

Return Values

TRUE if the auto flush size was successfully set for the connection to RTserver, FALSE otherwise.

Diagnostics

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

Description

TipcSrvConnSetAutoFlushSize sets the auto flush size of the connection to RTserver by calling TipcConnSetAutoFlushSize. 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.

TipcSrvConnSetAutoFlushSize may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvConnSetAutoFlushSize sets 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 with 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.

See Also

TipcConnGetAutoFlushSize, TipcConnSetAutoFlushSize, TipcSrvConnGetAutoFlushSize

Examples

This example creates a connection to RTserver, then sets the auto flush size to 4096 bytes:

if (!TipcSrvConnSetAutoFlushSize(srv, 4096)) { 
  return;  /* error */ 
}