TSRecords(3ts)

TSRecords3ts

Traffic server maintains a set of records which cover both configuration values and statistics

Usage

#include <ts/ts.h>
TSReturnCode TSMgmtStringCreate(TSRecordType rec_type, const char *name, const TSMgmtString data_default, TSRecordUpdateType update_type, TSRecordCheckType check_type, const char *check_regex, TSRecordAccessType access_type)
TSReturnCode TSMgmtIntCreate(TSRecordType rec_type, const char *name, const TSMgmtInt data_default, TSRecordUpdateType update_type, TSRecordCheckType check_type, const char *check_regex, TSRecordAccessType access_type)

Overview

TSMgmtStringCreate() registers name as a configuration name and sets its various properties. If check_type is TS_RECORDCHECK_STR then check_reg must be point to a valid regular expression to use to check the string value.

If a plugin uses a value from records.config that is not built in to Traffic Server it must use this function or the value will be inaccessible and a warning for that name will be generated.

Return values

TSMgmtStringCreate() and TSMgmtIntCreate() return TS_SUCCESS if the management value was created and TS_ERROR if not.

Releases

3 releases since Debian 10 (Buster); the text changed 2 times.

  1. 10
  2. 11
  3. 12

From trafficserver-dev 9.2.5+ds-0+deb12u4 in Debian 12 (Bookworm). Parsed by carta from the page's man source.