Updating System objects

Functions
void	infoob_add_data (object_t *obj, const int *fields, const char **values, int count)
	Adds an array of values to a system object. More...
void	infoob_add_data_generic (object_t *obj, const char **fieldnames, const char **values, int count)
	Adds an array of values to a system object. More...
int	infoob_add_field (const char *name, int flags)
	Creates a new field for updating system objects. More...
void	infoob_add_int (object_t *obj, int field, int value)
	Adds a numerical value to a system object. More...
void	infoob_add_int_generic (object_t *obj, const char *fieldname, int value)
	Adds a numerical value to a system object. More...
void	infoob_add_str (object_t *obj, int field, const char *value)
	Adds a value to a system object. More...
void	infoob_add_str_generic (object_t *obj, const char *fieldname, const char *value)
	Adds a value to a system object. More...
object_t *	infoob_new_object (const char *name)
	Creates a new system object. More...

Detailed Description

If you wish to use system objects, then you should create a function called auth_mod_init_objects() with the following prototype:

void auth_mod_init_objects()
{
   ...
}

This will be called after your auth_mod_init() has been called.

Note

It is not possible to define system objects in your initialisation function.

The following functions can be used to update RTTP system objects. System objects contain information about the status of the system, such as the state of the connection to DataSource applications and RTTP clients.

This example demonstrates how to update system values

Function Documentation

void infoob_add_data	(	object_t *	obj,
		const int *	fields,
		const char **	values,
		int	count
	)

Adds an array of values to a system object.

Parameters

obj	System object to add values to.
fields	Array of field numbers to add value to
values	Array of values to be added.
count	Number of entries in the array.

Deprecated:

Use infoob_add_data_generic instead

void infoob_add_data_generic	(	object_t *	obj,
		const char **	fieldnames,
		const char **	values,
		int	count
	)

Adds an array of values to a system object.

Parameters

obj	System object to add values to.
fieldnames	Array of field names to add values to
values	Array of values to be added.
count	Number of entries in the array.

int infoob_add_field	(	const char *	name,
		int	flags
	)

Creates a new field for updating system objects.

Parameters

name	Name of the field to be added.
flags	Unused.

Returns

Field number of the new field

Examples:

system.c.

void infoob_add_int	(	object_t *	obj,
		int	field,
		int	value
	)

Adds a numerical value to a system object.

Parameters

obj	System object to add value to.
field	Field number to add value to.
value	Value to be added.

Deprecated:

Use infoob_add_int_generic instead

Examples:

system.c.

void infoob_add_int_generic	(	object_t *	obj,
		const char *	fieldname,
		int	value
	)

Adds a numerical value to a system object.

Parameters

obj	System object to add value to.
fieldname	Field name to add value to.
value	Value to be added.

void infoob_add_str	(	object_t *	obj,
		int	field,
		const char *	value
	)

Adds a value to a system object.

Parameters

obj	System object to add value to.
field	Field number to add value to.
value	Value to be added.

Deprecated:

Use infoob_add_str_generic instead

Examples:

system.c.

void infoob_add_str_generic	(	object_t *	obj,
		const char *	fieldname,
		const char *	value
	)

Adds a value to a system object.

Parameters

obj	System object to add value to.
fieldname	Field name to add value to.
value	Value to be added.

object_t* infoob_new_object

(

const char *

name

)

Creates a new system object.

Parameters

name	of the object to be created.

Returns

New RTTP object

The name supplied will be prefixed with /SYSTEM/AUTH.

Examples:

system.c.