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

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

Include dependency graph for process.h:

Go to the source code of this file.

Macros
#define	PROCESS_CONF_OFFSET(_x) offsetof(PROCESS_INST, sections._x)

#define	PROCESS_RCTX process_rctx_t
	Convenience macro for providing CONF_SECTION offsets in section compilation arrays.

#define	PROCESS_RCTX_RESULT result

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

#define	RESULT_UNUSED UNUSED

Detailed Description

Declarations for functions which process packet state machines.

Id: 500e3061c3050406ee666f89b59aea77ef979367

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.

Macro Definition Documentation

◆ PROCESS_CONF_OFFSET

#define PROCESS_CONF_OFFSET ( _x ) offsetof(PROCESS_INST, sections._x)

Definition at line 79 of file process.h.

◆ PROCESS_RCTX

#define PROCESS_RCTX process_rctx_t

Convenience macro for providing CONF_SECTION offsets in section compilation arrays.

Definition at line 68 of file process.h.

◆ PROCESS_RCTX_RESULT

#define PROCESS_RCTX_RESULT result

Definition at line 76 of file process.h.

◆ PROCESS_TRACE

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

Trace each state function as it's entered.

Definition at line 55 of file process.h.

◆ RESULT_UNUSED

#define RESULT_UNUSED UNUSED

Definition at line 80 of file process.h.