[Contents] [Index] [Help] [Browse <] [Browse >]


amarquee.library/QNumQueuedBytes           amarquee.library/QNumQueuedBytes

   NAME
    QNumQueuedBytes - Returns (approximately) the number of bytes of
                      user data are awaiting transmission by the 
                      QSession's TCP thread.

   SYNOPSIS
    #include 

    ULONG QNumQueuedBytes(struct QSession * session)

   FUNCTION
    Returns the number of bytes of data that have been sent to the TCP
    thread for this QSession, but have not yet been sent to the TCP stack
    by the TCP thread.  This value does not include any "overhead" 
    introduced by the AMarquee system messages or headers--it only
    tracks the sum of sizes of the user's queued data buffers.
    No thread synchronization is done, so the value returned should be 
    considered approximate only.  This function can be used to see
    if bytes are being queued faster than they are being sent, and
    thus take corrective action before too much memory is allocated for
    queued packets.

   INPUTS
    session - Pointer to the QSession struct you want information for.

   RESULTS
    Number of bytes currently being used to store queued transactions.
    
   EXAMPLE
    struct QSession * s;
    
    if (s = QNewSession("example.server.com", 2957, "ExampleProgram"))
    {
      ULONG numQueued;
      
      /* ... */
      
      numQueued = QNumQueuedBytes(s);
      printf("Currently there are %i bytes of data awaiting transmission\n",numQueued);
      
      /* ... */
      
      QFreeSession(s);
    }
    
   SEE ALSO
    QNumQueuedPackets
    

Converted on 24 Mar 2002 with RexxDoesAmigaGuide2HTML 2.1e(private) by Michael Ranner.