module_priv.h File Reference

Declarations for the unlang module interface. More...

#include "unlang_priv.h"

Include dependency graph for module_priv.h:

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

Go to the source code of this file.

Data Structures
struct	unlang_frame_state_module_t
	A module stack entry. More...
struct	unlang_module_t
	A call to a module method. More...

Functions
static unlang_module_t *	unlang_generic_to_module (unlang_t const *p)
static unlang_t *	unlang_module_to_generic (unlang_module_t *p)

Detailed Description

Declarations for the unlang module interface.

Id

38c3aa94b815e6e61164f9e2d09456b7c3a3bf71

Copyright

2006-2019 The FreeRADIUS server project

Definition in file module_priv.h.

---

Data Structure Documentation

unlang_frame_state_module_t

struct unlang_frame_state_module_t

A module stack entry.

Represents a single module call on the unlang stack.

Definition at line 45 of file module_priv.h.

Collaboration diagram for unlang_frame_state_module_t:

Data Fields
void *	env_data	Expanded per call "call environment" tmpls.
call_env_result_t	env_result	Result of the previous call environment expansion.
fr_timer_t *	ev	retry timer just for this module.
module_instance_t const *	mi	Module instance to pass to callbacks.
char const *	previous_module	old request->module
void *	rctx	for resume / signal
request_t *	request
module_method_t	resume	resumption handler
fr_retry_t	retry	retry timers, etc.
unlang_module_retry_t	retry_cb	callback to run on timeout
module_method_t	retry_resume	which stops retries on resume
fr_signal_t	sigmask	Signals to block.
unlang_module_signal_t	signal	for signal handlers
module_thread_instance_t *	thread	thread-local data for this module. Caching is necessary in the frame state structure because the unlang_t tree is shared between all threads, so we can't cache thread-specific data in the unlang_t.
void *	timeout_rctx	rctx data to pass to timeout callback
int	unlang_indent	Record what this was when we entered the module.

unlang_module_t

struct unlang_module_t

A call to a module method.

Definition at line 35 of file module_priv.h.

Collaboration diagram for unlang_module_t:

Data Fields
call_env_t const *	call_env	The per call parsed call environment.
module_method_call_t	mmc	Everything needed to call a module method.
unlang_t	self	Common fields in all unlang_t tree nodes.

Function Documentation

unlang_generic_to_module()

static unlang_module_t * unlang_generic_to_module ( unlang_t const *  p )

inlinestatic

Definition at line 86 of file module_priv.h.

Here is the caller graph for this function:

unlang_module_to_generic()

static unlang_t * unlang_module_to_generic ( unlang_module_t *  p )

inlinestatic

Definition at line 92 of file module_priv.h.

Here is the caller graph for this function: