time_series_clear

March 26, 2020 Contributors

Name

time_series_clear — Remove a bucket (specified by bucket number) in a monitor and return the removed bucket

Synopsis

#include "misc/time_series.h"

| void * **time_series_clear** ( | ts, |   |
|   | series_id, |   |
|   | bucket_number); |   |

time_series * <var class="pdparam">ts</var>;
int <var class="pdparam">series_id</var>;
unsigned short <var class="pdparam">bucket_number</var>;

Description

Note

This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.

Remove a bucket (specified by bucket number) in a monitor and return the removed bucket.

Caller should free the momory of the returned bucket.

Parameters

ts
  • the time series.
series_id
  • the sequence number of the monitor.
bucket_number
  • the bucket to remove. 0 corresponds to current bucket.

Return Values

the bucket or NULL if not found.