diff options
| author | Harald Welte <laforge@gnumonks.org> | 2017-10-15 20:02:07 +0200 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2017-10-16 14:18:54 +0200 |
| commit | 17bbaa324b9873a965634c60f5696ebd57b5d6a1 (patch) | |
| tree | 38ba1d84c9415060d97abd34ec18f2b346a7041e /src | |
| parent | 781951bcf9864ae06741a0d76d3807e332a8faf9 (diff) | |
[doc] counter.[ch] Add Doxygen API documentation
This adds a more complete set of API documentation for all
osmo_counter relatedd functions and definitions.
Change-Id: I24283c05620ee86a8beb165af98a85d754549efb
Diffstat (limited to 'src')
| -rw-r--r-- | src/counter.c | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/src/counter.c b/src/counter.c index 6fa87ba3..29637779 100644 --- a/src/counter.c +++ b/src/counter.c @@ -29,8 +29,12 @@ static LLIST_HEAD(counters); +/*! Global talloc context for all osmo_counter allocations. */ void *tall_ctr_ctx; +/*! Allocate a new counter with given name. Allocates from tall_ctr_ctx + * \param[in] name Human-readable string name for the counter + * \returns Allocated counter on success; NULL on error */ struct osmo_counter *osmo_counter_alloc(const char *name) { struct osmo_counter *ctr = talloc_zero(tall_ctr_ctx, struct osmo_counter); @@ -44,12 +48,18 @@ struct osmo_counter *osmo_counter_alloc(const char *name) return ctr; } +/*! Release/Destroy a given counter + * \param[in] ctr Counter to be destroyed */ void osmo_counter_free(struct osmo_counter *ctr) { llist_del(&ctr->list); talloc_free(ctr); } +/*! Iterate over all counters; call \a handle_cunter call-back for each. + * \param[in] handle_counter Call-back to be called for each counter; aborts if rc < 0 + * \param[in] data Opaque data passed through to \a handle_counter function + * \returns 0 if all \a handle_counter calls successfull; negative on error */ int osmo_counters_for_each(int (*handle_counter)(struct osmo_counter *, void *), void *data) { @@ -65,6 +75,9 @@ int osmo_counters_for_each(int (*handle_counter)(struct osmo_counter *, void *), return rc; } +/*! Find a counter by its name. + * \param[in] name Name used to look-up/search counter + * \returns Counter on success; NULL if not found */ struct osmo_counter *osmo_counter_get_by_name(const char *name) { struct osmo_counter *ctr; @@ -76,6 +89,11 @@ struct osmo_counter *osmo_counter_get_by_name(const char *name) return NULL; } +/*! Compute difference between current and previous counter value. + * \param[in] ctr Counter of which the difference is to be computed + * \returns Delta value between current counter and previous counter. Please + * note that the actual counter values are unsigned long, while the + * difference is computed as signed integer! */ int osmo_counter_difference(struct osmo_counter *ctr) { int delta = ctr->value - ctr->previous; |