TipcSrvFlush

Name

TipcSrvFlush — flush buffered outgoing messages on the connection to RTserver

Synopsis

T_BOOL TipcSrvFlush() 

Arguments

None

Return Values

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

Diagnostics

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

Description

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

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

Caution

None

See Also

TipcConnFlush, TipcSrvMsgSend

Examples

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

if (!TipcSrvMsgSend(msg, TRUE)) { 
  return;  /* error */ 
}  
 
if (!TipcSrvFlush()) { 
    return;  /* error */ 
}