I_RecDefs.h File Reference

Public Rec defines and types. More...

#include "Compatability.h"
#include "ink_mutex.h"
#include "ink_rwlock.h"
#include "I_RecMutex.h"

Include dependency graph for I_RecDefs.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	rec::detail::is_valid_persistence< RECP_PERSISTENT >
struct	rec::detail::is_valid_persistence< RECP_NON_PERSISTENT >
union	RecData
struct	RecRawStat
struct	RecRawStatBlock
Namespaces
namespace	rec
namespace	rec::detail
Defines
#define	STAT_PROCESSOR
#define	RecStringNull   NULL
#define	REC_PERSISTENCE_TYPE(P)   rec::detail::is_valid_persistence<P>::value
#define	REC_VAR_NAME_DELIMITOR   '.'
#define	REC_VAR_NAME_WILDCARD   '*'
Typedefs
typedef int64_t	RecInt
typedef float	RecFloat
typedef char *	RecString
typedef const char *	RecStringConst
typedef int64_t	RecCounter
typedef int8_t	RecByte
typedef bool	RecBool
typedef int(*	RecConfigUpdateCb )(const char *name, RecDataT data_type, RecData data, void *cookie)
typedef int(*	RecStatUpdateFunc )(const char *name, RecDataT data_type, RecData *data, RecRawStatBlock *rsb, int id, void *cookie)
typedef int(*	RecRawStatSyncCb )(const char *name, RecDataT data_type, RecData *data, RecRawStatBlock *rsb, int id)
Enumerations
enum	RecErrT { REC_ERR_FAIL = -1, REC_ERR_OKAY = 0 }
enum	RecT {   RECT_NULL = 0x00, RECT_CONFIG = 0x01, RECT_PROCESS = 0x02, RECT_NODE = 0x04,   RECT_CLUSTER = 0x08, RECT_LOCAL = 0x10, RECT_PLUGIN = 0x20, RECT_ALL = 0x3F }
enum	RecDataT {   RECD_NULL = 0, RECD_INT, RECD_FLOAT, RECD_STRING,   RECD_COUNTER, RECD_CONST, RECD_FX, RECD_MAX }
enum	RecPersistT { RECP_NULL, RECP_PERSISTENT, RECP_NON_PERSISTENT }
enum	RecUpdateT {   RECU_NULL, RECU_DYNAMIC, RECU_RESTART_TS, RECU_RESTART_TM,   RECU_RESTART_TC }
enum	RecCheckT { RECC_NULL, RECC_STR, RECC_INT, RECC_IP }
enum	RecModeT { RECM_NULL, RECM_CLIENT, RECM_SERVER, RECM_STAND_ALONE }
enum	RecAccessT { RECA_NULL, RECA_NO_ACCESS, RECA_READ_ONLY }

---

Detailed Description

Public Rec defines and types.

License

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition in file I_RecDefs.h.

---

Define Documentation

#define REC_PERSISTENCE_TYPE

(

P

)

rec::detail::is_valid_persistence<P>::value

Definition at line 115 of file I_RecDefs.h.

#define REC_VAR_NAME_DELIMITOR   '.'

Definition at line 201 of file I_RecDefs.h.

Referenced by RecTree::rec_tree_get(), and RecTree::rec_tree_insert().

#define REC_VAR_NAME_WILDCARD   '*'

Definition at line 202 of file I_RecDefs.h.

Referenced by RecTree::rec_tree_get().

#define RecStringNull   NULL

Definition at line 48 of file I_RecDefs.h.

#define STAT_PROCESSOR

Definition at line 32 of file I_RecDefs.h.

---

Typedef Documentation

typedef bool RecBool

Definition at line 56 of file I_RecDefs.h.

typedef int8_t RecByte

Definition at line 55 of file I_RecDefs.h.

typedef int(* RecConfigUpdateCb)(const char *name, RecDataT data_type, RecData data, void *cookie)

Definition at line 193 of file I_RecDefs.h.

typedef int64_t RecCounter

Definition at line 54 of file I_RecDefs.h.

typedef float RecFloat

Definition at line 51 of file I_RecDefs.h.

typedef int64_t RecInt

Definition at line 50 of file I_RecDefs.h.

typedef int(* RecRawStatSyncCb)(const char *name, RecDataT data_type, RecData *data, RecRawStatBlock *rsb, int id)

Definition at line 195 of file I_RecDefs.h.

typedef int(* RecStatUpdateFunc)(const char *name, RecDataT data_type, RecData *data, RecRawStatBlock *rsb, int id, void *cookie)

Definition at line 194 of file I_RecDefs.h.

typedef char* RecString

Definition at line 52 of file I_RecDefs.h.

typedef const char* RecStringConst

Definition at line 53 of file I_RecDefs.h.

---

Enumeration Type Documentation

enum RecAccessT

Enumerator:

RECA_NULL
RECA_NO_ACCESS
RECA_READ_ONLY

Definition at line 142 of file I_RecDefs.h.

enum RecCheckT

Enumerator:

RECC_NULL
RECC_STR
RECC_INT
RECC_IP

Definition at line 126 of file I_RecDefs.h.

enum RecDataT

Enumerator:

RECD_NULL
RECD_INT
RECD_FLOAT
RECD_STRING
RECD_COUNTER
RECD_CONST
RECD_FX
RECD_MAX

Definition at line 70 of file I_RecDefs.h.

enum RecErrT

Enumerator:

REC_ERR_FAIL
REC_ERR_OKAY

Definition at line 38 of file I_RecDefs.h.

enum RecModeT

Enumerator:

RECM_NULL
RECM_CLIENT
RECM_SERVER
RECM_STAND_ALONE

Definition at line 134 of file I_RecDefs.h.

enum RecPersistT

Enumerator:

RECP_NULL
RECP_PERSISTENT
RECP_NON_PERSISTENT

Definition at line 85 of file I_RecDefs.h.

enum RecT

Enumerator:

RECT_NULL
RECT_CONFIG
RECT_PROCESS
RECT_NODE
RECT_CLUSTER
RECT_LOCAL
RECT_PLUGIN
RECT_ALL

Definition at line 58 of file I_RecDefs.h.

enum RecUpdateT

Enumerator:

RECU_NULL
RECU_DYNAMIC
RECU_RESTART_TS
RECU_RESTART_TM
RECU_RESTART_TC

Definition at line 117 of file I_RecDefs.h.