TipcSrvGetGmdNumPending

Name

TipcSrvGetGmdNumPending — get the number of outgoing GMD messages still pending on the connection to RTserver

Synopsis

T_BOOL TipcSrvGetGmdNumPending(gmd_num_pending_return) 
T_INT4 *gmd_num_pending_return; 

Arguments

gmd_num_pending_return — storage for pending message count

Return Values

TRUE if the number of pending GMD messages was successfully retrieved from the connection to RTserver, FALSE otherwise.

Diagnostics

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

Description

TipcSrvGetGmdNumPending gets the number of GMD messages published to RTserver that have not been acknowledged nor explicitly deleted from the GMD area. Messages are deleted from the GMD area when a GMD_ACK message is received and when a GMD_FAILURE message is processed. TipcSrvGetGmdNumPending may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvGetGmdNumPending gets the number of pending GMD messages from the warm connection. See TipcSrvCreate on creating connections and warm connections.

Caution

If TipcSrvGetGmdNumPending returns FALSE, it does not store a value in gmd_num_pending_return.

See Also

TipcConnGetGmdNumPending

Examples

This example loops processing messages until there are no more outgoing GMD messages pending on the connection to RTserver:

T_INT4 num_pending; 
do { 
  if (!TipcSrvMainLoop(1.0)) { 
    return;  /* error */ 
  } 
  if (!TipcSrvGetGmdNumPending(&num_pending)) { 
    return;  /* error */ 
  } 
} while (num_pending > 0);