Declarations for functions which process packet state machines. More...

#include <freeradius-devel/server/virtual_servers.h>
#include <freeradius-devel/server/pair.h>

Include dependency graph for process.h:

Data Structures
struct	fr_process_module_s
	Common public symbol definition for all process modules. More...

Macros
#define	PROCESS_TRACE RDEBUG3("Entered state %s", __FUNCTION__)
	Trace each state function as it's entered.

Typedefs
typedef struct fr_process_module_s	fr_process_module_t
	Common public symbol definition for all process modules.

Detailed Description

Declarations for functions which process packet state machines.

This is a convenience header to simplify defining packet processing state machines.

The following macros must be defined before this header is included:

PROCESS_INST the type of structure that holds instance data for the process module.
PROCESS_PACKET_TYPE an enum, or generic type (uint32) that can hold all valid packet types.
PROCESS_PACKET_CODE_VALID the name of a macro or function which accepts one argument and evaluates to true if the packet code is valid.

The following macros may (optionally) be defined before this header is included:

PROCESS_CODE_MAX the highest valid protocol packet code + 1.
PROCESS_CODE_DO_NOT_RESPOND The packet code that's used to indicate that no response should be sent.
PROCESS_STATE_EXTRA_FIELDS extra fields to add to the fr_process_state_t structure.

Copyright: 2021 The FreeRADIUS server project; 2021 Network RADIUS SAS (legal.nosp@m.@net.nosp@m.workr.nosp@m.adiu.nosp@m.s.com)

Definition in file process.h.

Data Structure Documentation

struct fr_process_module_s

Common public symbol definition for all process modules.

Definition at line 54 of file process.h.

Collaboration diagram for fr_process_module_s:

Data Fields
module_t	common	Common fields for all loadable modules.
virtual_server_compile_t const *	compile_list	list of processing sections
fr_dict_t const **	dict	pointer to local fr_dict_t *
fr_dict_attr_t const **	packet_type	Request packet types to look for finally sections for.
module_method_t	process	Process packets.

#define PROCESS_TRACE RDEBUG3("Entered state %s", __FUNCTION__)

Trace each state function as it's entered.

Definition at line 66 of file process.h.

Common public symbol definition for all process modules.