Changeset 1071:6ca6cadf209c in freeDiameter for include

Timestamp:

May 2, 2013, 12:22:31 PM (11 years ago)

Author:

Sebastien Decugis <sdecugis@freediameter.net>

Branch:

default

Phase:

public

Message:

Implement the fd_stat_getstats function; changed prototype of fd_fifo_length.

Location:

include/freeDiameter

Files:

• libfdcore.h (modified) (2 diffs)
• libfdproto.h (modified) (1 diff)

include/freeDiameter/libfdcore.h

@@ -1097 +1097 @@
  *  stat          : Which queue is being queried
  *  peer          : (depending on the stat parameter) which peer is being queried
- *  len           : (out) The number of items in the queue currently
- *  max           : (out) The max number of items the queue accepts before becoming blocking -- 0 means no max.
+ *  current_count : (out) The number of items in the queue currently
+ *  limit_count   : (out) The max number of items the queue accepts before becoming blocking -- 0 means no max.
  *  highest_count : (out) The highest count the queue has reached since startup
  *  total_count   : (out) Total number of items that this queue has processed (always growing, use deltas for monitoring)
@@ -1114 +1114 @@
  */
 int fd_stat_getstats(enum fd_stat_type stat, struct peer_hdr * peer, 
-                        int * len, int * max, int * highest_count, long long * total_count, 
+                        int * current_count, int * limit_count, int * highest_count, long long * total_count,
                         struct timespec * total, struct timespec * blocking, struct timespec * last);
 

include/freeDiameter/libfdproto.h

@@ -3032 +3032 @@
 
 /*
+ * FUNCTION:    fd_fifo_getstats
+ *
+ * PARAMETERS:
+ *  queue         : The queue from which to retrieve the information.
+ *  current_count : How many items in the queue at the time of execution. This changes each time an item is pushed or poped.
+ *  limit_count   : The maximum number of items allowed in this queue. This is specified during queue creation.
+ *  highest_count : The maximum number of items this queue has contained. This enables to see if limit_count count was reached.
+ *  total_count   : the total number of items that went through the queue (already pop'd). Always increasing.
+ *  total         : Cumulated time all items spent in this queue, including blocking time (always growing, use deltas for monitoring)
+ *  blocking      : Cumulated time threads trying to post new items were blocked (queue full).
+ *  last          : For the last element retrieved from the queue, how long it take between posting (including blocking) and poping
+ *  
+ * DESCRIPTION: 
+ *  Retrieve the timing information associated with a queue, for monitoring purpose.
+ *
+ * RETURN VALUE:
+ *  0           : The statistics have been updated.
+ *  EINVAL      : A parameter is invalid.
+ */
+int fd_fifo_getstats( struct fifo * queue, int * current_count, int * limit_count, int * highest_count, long long * total_count, 
+                                           struct timespec * total, struct timespec * blocking, struct timespec * last);
+
+/*
  * FUNCTION:    fd_fifo_length
  *
  * PARAMETERS:
  *  queue       : The queue from which to retrieve the number of elements.
- *  length      : Upon success, the current number of elements in the queue is stored here.
- *  max         : the maximum number of elements as specified during creation. Can be NULL.
- *
- * DESCRIPTION: 
- *  Retrieve the number of elements in a queue.
- *
- * RETURN VALUE:
- *  0           : The length of the queue has been written.
- *  EINVAL      : A parameter is invalid.
- */
-int fd_fifo_length ( struct fifo * queue, int * length, int * max);
-int fd_fifo_length_noerr ( struct fifo * queue ); /* no error checking version */
-
-/*
- * FUNCTION:    fd_fifo_getstats
- *
- * PARAMETERS:
- *  queue       : The queue from which to retrieve the timings information.
- *  items       : the total number of items that went through the queue (already pop'd). Always increasing.
- *  total       : Cumulated time all items spent in this queue, including blocking time (always growing, use deltas for monitoring)
- *  blocking    : Cumulated time threads trying to post new items were blocked (queue full).
- *  last        : For the last element retrieved from the queue, how long it take between posting (including blocking) and poping
- *  
- * DESCRIPTION: 
- *  Retrieve the timing information associated with a queue, for monitoring purpose.
- *
- * RETURN VALUE:
- *  0           : The statistics have been updated.
- *  EINVAL      : A parameter is invalid.
- */
-int fd_fifo_getstats( struct fifo * queue, long long *items, struct timespec * total, struct timespec * blocking, struct timespec * last);
-
+ *
+ * DESCRIPTION: 
+ *  Retrieve the number of elements in a queue, without error checking.
+ *
+ * RETURN VALUE:
+ *  The number of items currently queued.
+ */
+int fd_fifo_length ( struct fifo * queue );
 
 /*