Navigation



Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed
  • include/freeDiameter/libfdproto.h

    r1078 r1082  
    29892989
    29902990/*
     2991 * FUNCTION:    fd_fifo_getstats
     2992 *
     2993 * PARAMETERS:
     2994 *  queue         : The queue from which to retrieve the information.
     2995 *  current_count : How many items in the queue at the time of execution. This changes each time an item is pushed or poped.
     2996 *  limit_count   : The maximum number of items allowed in this queue. This is specified during queue creation.
     2997 *  highest_count : The maximum number of items this queue has contained. This enables to see if limit_count count was reached.
     2998 *  total_count   : the total number of items that went through the queue (already pop'd). Always increasing.
     2999 *  total         : Cumulated time all items spent in this queue, including blocking time (always growing, use deltas for monitoring)
     3000 *  blocking      : Cumulated time threads trying to post new items were blocked (queue full).
     3001 *  last          : For the last element retrieved from the queue, how long it take between posting (including blocking) and poping
     3002 * 
     3003 * DESCRIPTION:
     3004 *  Retrieve the timing information associated with a queue, for monitoring purpose.
     3005 *
     3006 * RETURN VALUE:
     3007 *  0           : The statistics have been updated.
     3008 *  EINVAL      : A parameter is invalid.
     3009 */
     3010int fd_fifo_getstats( struct fifo * queue, int * current_count, int * limit_count, int * highest_count, long long * total_count,
     3011                                           struct timespec * total, struct timespec * blocking, struct timespec * last);
     3012
     3013/*
    29913014 * FUNCTION:    fd_fifo_length
    29923015 *
    29933016 * PARAMETERS:
    29943017 *  queue       : The queue from which to retrieve the number of elements.
    2995  *  length      : Upon success, the current number of elements in the queue is stored here.
    2996  *  max         : the maximum number of elements as specified during creation. Can be NULL.
    2997  *
    2998  * DESCRIPTION:
    2999  *  Retrieve the number of elements in a queue.
    3000  *
    3001  * RETURN VALUE:
    3002  *  0           : The length of the queue has been written.
    3003  *  EINVAL      : A parameter is invalid.
    3004  */
    3005 int fd_fifo_length ( struct fifo * queue, int * length, int * max);
    3006 int fd_fifo_length_noerr ( struct fifo * queue ); /* no error checking version */
    3007 
    3008 /*
    3009  * FUNCTION:    fd_fifo_getstats
    3010  *
    3011  * PARAMETERS:
    3012  *  queue       : The queue from which to retrieve the timings information.
    3013  *  items       : the total number of items that went through the queue (already pop'd). Always increasing.
    3014  *  total       : Cumulated time all items spent in this queue, including blocking time (always growing, use deltas for monitoring)
    3015  *  blocking    : Cumulated time threads trying to post new items were blocked (queue full).
    3016  *  last        : For the last element retrieved from the queue, how long it take between posting (including blocking) and poping
    3017  * 
    3018  * DESCRIPTION:
    3019  *  Retrieve the timing information associated with a queue, for monitoring purpose.
    3020  *
    3021  * RETURN VALUE:
    3022  *  0           : The statistics have been updated.
    3023  *  EINVAL      : A parameter is invalid.
    3024  */
    3025 int fd_fifo_getstats( struct fifo * queue, long long *items, struct timespec * total, struct timespec * blocking, struct timespec * last);
    3026 
     3018 *
     3019 * DESCRIPTION:
     3020 *  Retrieve the number of elements in a queue, without error checking.
     3021 *
     3022 * RETURN VALUE:
     3023 *  The number of items currently queued.
     3024 */
     3025int fd_fifo_length ( struct fifo * queue );
    30273026
    30283027/*
Note: See TracChangeset for help on using the changeset viewer.