Data Structures
struct	ds_arguments_t
	Structure defining the arguments for Monitoring methods. More...

struct	ds_array_t
	The container object for monitoring array types. More...

struct	ds_monauth_t
	Monitoring credentials object. More...

struct	ds_monitor_t
	The container object for all monitoring values. More...

Macros
#define	TYPE_ACTIVE 64
	Indicates whether the datatype is "active". More...

#define	TYPE_ACTIVE2 128
	Indicates whether the active type isn't a callback. More...

#define	TYPE_ARRAY 32
	Indicates whether the datatype is an array. More...

#define	TYPE_BINARY 1
	Binary property type. More...

#define	TYPE_BOOLEAN 11
	Boolean property type. More...

#define	TYPE_DOUBLE 9
	Double property type. More...

#define	TYPE_HIERARCHY 1024
	Indicates whether this data forms part of a heirarchy. More...

#define	TYPE_KEY 512
	Indicates whether this datatype forms part of the primary key. More...

#define	TYPE_LLONG 7
	Long long property type. More...

#define	TYPE_LONG 5
	Long property type. More...

#define	TYPE_METHOD 256
	Indicates whether this datatype is a method. More...

#define	TYPE_NONE 0
	A place marker. More...

#define	TYPE_OPTIONAL 2048

#define	TYPE_PRIMITIVE_MASK 31
	Mask to isolate the primitive data type. More...

#define	TYPE_RELATION 20
	Indicates that the property is a relation. More...

#define	TYPE_SHORT 3
	Short property type. More...

#define	TYPE_STRING 2
	String property type. More...

#define	TYPE_TIMESTAMP 10
	Timestamp property type. More...

#define	TYPE_ULLONG 8
	Unsigned long long property type. More...

#define	TYPE_ULONG 6
	Unsigned long property type. More...

#define	TYPE_USHORT 4
	Unsigned short property type. More...

Typedefs
typedef ds_monitor_t (	ds_monitor_active_cb) (char templatename, char key, char *propertyname)
	Definition of the function type used for active request callbacks. More...

typedef int(*	ds_monitor_authenticator_t) (ds_monauth_t *credentials)
	Definition of the function type used for monitoring authentication callback. More...

typedef ds_monitor_t (	ds_monitor_method_cb) (char templatename, char key, char property, int argc, char argv[])
	Definition of the function type used for method calls. More...

Detailed Description

Macro Definition Documentation

#define TYPE_ACTIVE 64

Indicates whether the datatype is "active".

#define TYPE_ACTIVE2 128

Indicates whether the active type isn't a callback.

There are two forms of active monitoring types:

A function callback is supplied that provides that data
An address is supplied where the data can be obtained

If TYPE_ACTIVE2 then the same value is supplied for all groups of the template type

#define TYPE_ARRAY 32

Indicates whether the datatype is an array.

#define TYPE_BINARY 1

Binary property type.

#define TYPE_BOOLEAN 11

Boolean property type.

The Boolean value has the value 0 or 1

#define TYPE_DOUBLE 9

Double property type.

#define TYPE_HIERARCHY 1024

Indicates whether this data forms part of a heirarchy.

#define TYPE_KEY 512

Indicates whether this datatype forms part of the primary key.

#define TYPE_LLONG 7

Long long property type.

#define TYPE_LONG 5

Long property type.

#define TYPE_METHOD 256

Indicates whether this datatype is a method.

#define TYPE_NONE 0

A place marker.

#define TYPE_OPTIONAL 2048

For the type of the argument within a ds_arguments_t, this value can be or'd to indicate to the monitoring system that this argument is optional. All arguments after this particular argument should naturally be optional.

#define TYPE_PRIMITIVE_MASK 31

Mask to isolate the primitive data type.

#define TYPE_RELATION 20

Indicates that the property is a relation.

#define TYPE_SHORT 3

Short property type.

#define TYPE_STRING 2

String property type.

#define TYPE_TIMESTAMP 10

Timestamp property type.

The timestamp should be supplied in milliseconds

#define TYPE_ULLONG 8

Unsigned long long property type.

#define TYPE_ULONG 6

Unsigned long property type.

#define TYPE_USHORT 4

Unsigned short property type.

Typedef Documentation

typedef ds_monitor_t*(* ds_monitor_active_cb) (char *templatename, char *key, char *propertyname)

Definition of the function type used for active request callbacks.

Parameters

templatename	The templatename of the property being requested
key	The primarykey of the property being requested
propertyname	The propertyname being requested

Returns: ds_monitor_t A populated ds_monitor_t object

typedef int(* ds_monitor_authenticator_t) (ds_monauth_t *credentials)

Definition of the function type used for monitoring authentication callback.

Parameters

credentials User credentials to be authenticated

Return values

0	- User is not permitted to connect
1	- User is permitted to connect

See also: ds_monitor_set_auth()

typedef ds_monitor_t*(* ds_monitor_method_cb) (char *templatename, char *key, char *property, int argc, char *argv[])

Definition of the function type used for method calls.

Parameters

templatename	The templatename of the method being called
key	The primarykey of the method being called
propertyname	The propertyname of the method being requested
argc	Number of arguments
argv	Array of arguments

Returns: ds_monitor_t A populated ds_monitor_t object

argv[0] contains the propertyname this method is being called for

Data Structures

Macros

Typedefs

Detailed Description

Macro Definition Documentation

Typedef Documentation