TipcSrvConnFlush

Name

TipcSrvConnFlush — flush buffered outgoing messages on the connection

Synopsis

T_BOOL TipcSrvConnFlush(srv) 
T_IPC_SRV srv; 

Arguments

srv — connection handle to RTserver

Return Values

TRUE if any data was successfully flushed to the connection handle to RTserver, FALSE otherwise.

Diagnostics

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

Description

TipcSrvConnFlush flushes buffered outgoing messages on the connection handle to RTserver by calling TipcConnFlush. See TipcConnFlush for more information on flushing outgoing messages.

TipcSrvConnFlush may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvConnFlush returns FALSE immediately. See TipcSrvConnOpen on automatic creation of connections and warm connections to RTserver.

Caution

None

See Also

TipcConnFlush, TipcSrvConnMsgSend

Examples

This example shows how to use TipcSrvConnFlush to flush a message to the connection handle to RTserver:

if (!TipcSrvConnMsgSend(srv, msg, TRUE)) { 
  return;  /* error */ 
}  
 
if (!TipcSrvConnFlush(srv)) { 
    return;  /* error */ 
}