TipcConnGetGmdNumPending

Name

TipcConnGetGmdNumPending — get the number of outgoing GMD messages still pending on a connection

Synopsis

T_BOOL TipcConnGetGmdNumPending(conn, gmd_num_pending_return) 
T_IPC_CONN conn; 
T_INT4 *gmd_num_pending_return; 

Arguments

conn — connection to get pending message count from

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, FALSE otherwise.

Diagnostics

If TipcConnGetGmdNumPending fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcConnGetGmdNumPending gets the number of GMD messages sent on the connection that have been neither acknowledged nor explicitly deleted from the GMD area. Messages are deleted from the GMD area when a GMD_ACK message is received and also, by default, when a GMD_FAILURE message is processed.

Caution

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

See Also

TipcSrvGetGmdNumPending

Examples

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

T_INT4 num_pending; 
 
do { 
  if (!TipcConnMainLoop(conn, 1.0)) { 
    return;  /* error */ 
  } 
  if (!TipcConnGetGmdNumPending(conn, &num_pending)) { 
    return;  /* error */ 
  } 
} while (num_pending > 0);