TipcConnSetAutoFlushSize

Name

TipcConnSetAutoFlushSize — set the auto flush size of a connection

Synopsis

T_BOOL TipcConnSetAutoFlushSize(conn, auto_flush_size) 
T_IPC_CONN conn; 
T_INT4 auto_flush_size; 

Arguments

conn — connection to set auto flush size for

auto_flush_size — auto flush size (in bytes)

Return Values

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

Diagnostics

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

Description

TipcConnSetAutoFlushSize sets the auto flush size of a connection. The auto flush size is used to control how much outgoing data (in bytes) is buffered before being automatically flushed to the other end of connection. The default for the auto flush size is 8192 bytes. The auto flush size 0 can be used to disable all buffering and force each outgoing message to be flushed immediately. The auto flush size T_IPC_NO_AUTO_FLUSH_SIZE can be used to disable all automatic flushing of outgoing messages. See TipcConnGetAutoFlushSize for more information on auto flush sizes.

Caution

None

See Also

TipcConnGetAutoFlushSize

Examples

This example sets the auto flush size of a connection with TipcConnSetAutoFlushSize to 0 bytes, which causes all outgoing messages to be automatically flushed when sent:

if (!TipcConnSetAutoFlushSize(conn, 0)) { 
  return;  /* error */ 
}