trigger.h File Reference

Execute scripts when a server event occurs. More...

#include <freeradius-devel/server/cf_util.h>
#include <freeradius-devel/server/module.h>
#include <freeradius-devel/server/request.h>
#include <freeradius-devel/unlang/interpret.h>
#include <freeradius-devel/util/pair.h>
#include <freeradius-devel/util/talloc.h>

Include dependency graph for trigger.h:

Go to the source code of this file.

Data Structures
struct	module_trigger_args_t
	Common values used by modules when building trigger args. More...

Typedefs
typedef int(*	fr_trigger_worker_t) (request_t *request, module_method_t process, void *ctx)

Functions
int	module_trigger_args_build (TALLOC_CTX *ctx, fr_pair_list_t *list, CONF_SECTION *cs, module_trigger_args_t *args))
	Build trigger args pair list for modules.
int	trigger (unlang_interpret_t *intp, CONF_SECTION const *cs, CONF_PAIR **trigger_cp, char const *name, bool rate_limit, fr_pair_list_t *args))
	Execute a trigger - call an executable to process an event.
void	trigger_args_afrom_server (TALLOC_CTX *ctx, fr_pair_list_t *list, char const *server, uint16_t port)
	Create trigger arguments to describe the server the pool connects to.
bool	trigger_enabled (void)
	Return whether triggers are enabled.
int	trigger_init (CONF_SECTION const *cs)

Detailed Description

Execute scripts when a server event occurs.

Id

c2602112ad32b10db4063b129bcf0e1cc5321559

Copyright

2015 The FreeRADIUS server project

Definition in file trigger.h.

---

Data Structure Documentation

module_trigger_args_t

struct module_trigger_args_t

Common values used by modules when building trigger args.

Definition at line 42 of file trigger.h.

Data Fields
char const *char const *	name	< Module name Instance name
uint16_t	port	Server port.
char const *	server	Server name / IP.

Typedef Documentation

fr_trigger_worker_t

typedef int(* fr_trigger_worker_t) (request_t *request, module_method_t process, void *ctx)

Definition at line 61 of file trigger.h.

Function Documentation

module_trigger_args_build()

int module_trigger_args_build	(	TALLOC_CTX *	ctx,
		fr_pair_list_t *	list,
		CONF_SECTION *	cs,
		module_trigger_args_t *	args
	)

Build trigger args pair list for modules.

Parameters

[in]	ctx	to allocate pairs in.
[in]	list	to populate.
[in]	cs	CONF_SECTION to search for a "trigger_args" section
[in]	args	Common module data which will populate default pairs

Definition at line 499 of file trigger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

trigger()

int trigger	(	unlang_interpret_t *	intp,
		CONF_SECTION const *	cs,
		CONF_PAIR **	trigger_cp,
		char const *	name,
		bool	rate_limit,
		fr_pair_list_t *	args
	)

Execute a trigger - call an executable to process an event.

A trigger ties a state change (e.g. connection up) in a module to an action (e.g. send an SNMP trap) defined in raddb/triggers.conf or in the trigger section of a module. There's no setup for triggers, the triggering code just calls this function with the name of the trigger to run, and an optional interpreter if the trigger should run asynchronously.

If no interpreter is passed in, the trigger runs synchronously, which is useful when the server is shutting down and we want to ensure that the trigger has completed before the server exits.

If an interpreter is passed in, the trigger runs asynchronously in that interpreter, allowing the server to continue processing packets while the trigger runs.

The name of each trigger is based on the module or portion of the server which runs the trigger, and is usually taken from the state when the module has a state change.

Triggers are separate from logs, because log messages are generally informational, are not time sensitive, and usually require log files to be parsed and filtered in order to find relevant information.

In contrast, triggers are something specific which the administrator needs to be notified about immediately and can't wait to post-process a log file.

Note

Calls to this function will be ignored if trigger_init has not been called.

Parameters

[in]	intp	Interpreter to run the trigger with. If this is NULL the trigger will be executed synchronously.
[in]	cs	to search for triggers in. If cs is not NULL, the portion after the last '.' in name is used for the trigger. If cs is NULL, the entire name is used to find the trigger in the global trigger section.
[in,out]	trigger_cp	Optional pointer to a CONF_PAIR pointer. If populated and the pointer is not NULL, this CONF_PAIR will be used rather than searching. If populated, and the pointer is NULL, the search will happen and the pointer will be populated with the found CONF_PAIR.
[in]	name	the path relative to the global trigger section ending in the trigger name e.g. module.ldap.pool.start.
[in]	rate_limit	whether to rate limit triggers.
[in]	args	to populate the trigger's request list with.

Returns

• 0 on success.
• -1 if the trigger is not defined.
• -2 if the trigger was rate limited.
• -3 on failure.

Definition at line 156 of file trigger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

trigger_args_afrom_server()

void trigger_args_afrom_server	(	TALLOC_CTX *	ctx,
		fr_pair_list_t *	list,
		char const *	server,
		uint16_t	port
	)

Create trigger arguments to describe the server the pool connects to.

Note

trigger_init must be called before calling this function, else it will return NULL.

Parameters

[in]	ctx	to allocate fr_pair_t s in.
[out]	list	to append Pool-Server and Pool-Port pairs to
[in]	server	we're connecting to.
[in]	port	on that server.

Definition at line 427 of file trigger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

trigger_enabled()

bool trigger_enabled

(

void

)

Return whether triggers are enabled.

Definition at line 95 of file trigger.c.

Here is the caller graph for this function:

trigger_init()

int trigger_init

(

CONF_SECTION const *

cs

)

Definition at line 619 of file trigger.c.

Here is the call graph for this function:

Here is the caller graph for this function: