Return codes returned by modules and virtual server sections. More...

#include <freeradius-devel/util/table.h>
#include <freeradius-devel/unlang/action.h>

Include dependency graph for rcode.h:

Macros
#define	RETURN_UNLANG_DISALLOW RETURN_UNLANG_RCODE(RLM_MODULE_DISALLOW)

#define	RETURN_UNLANG_FAIL RETURN_UNLANG_RCODE(RLM_MODULE_FAIL)

#define	RETURN_UNLANG_HANDLED RETURN_UNLANG_RCODE(RLM_MODULE_HANDLED)

#define	RETURN_UNLANG_INVALID RETURN_UNLANG_RCODE(RLM_MODULE_INVALID)

#define	RETURN_UNLANG_NOOP RETURN_UNLANG_RCODE(RLM_MODULE_NOOP)

#define	RETURN_UNLANG_NOTFOUND RETURN_UNLANG_RCODE(RLM_MODULE_NOTFOUND)

#define	RETURN_UNLANG_OK RETURN_UNLANG_RCODE(RLM_MODULE_OK)

#define	RETURN_UNLANG_RCODE(_rcode) do { p_result->rcode = (_rcode); return UNLANG_ACTION_CALCULATE_RESULT; } while (0)

#define	RETURN_UNLANG_REJECT RETURN_UNLANG_RCODE(RLM_MODULE_REJECT)

#define	RETURN_UNLANG_TIMEOUT RETURN_UNLANG_RCODE(RLM_MODULE_TIMEOUT)

#define	RETURN_UNLANG_UPDATED RETURN_UNLANG_RCODE(RLM_MODULE_UPDATED)

#define	RLM_MODULE_USER_SECTION_REJECT
	Rcodes that translate to a user configurable section failing overall.

Enumerations
enum	rlm_rcode_t { RLM_MODULE_NOT_SET = 0 , RLM_MODULE_REJECT , RLM_MODULE_FAIL , RLM_MODULE_OK , RLM_MODULE_HANDLED , RLM_MODULE_INVALID , RLM_MODULE_DISALLOW , RLM_MODULE_NOTFOUND , RLM_MODULE_NOOP , RLM_MODULE_UPDATED , RLM_MODULE_TIMEOUT , RLM_MODULE_NUMCODES }
	Return codes indicating the result of the module call. More...

Variables
fr_table_num_sorted_t const	rcode_table []

size_t	rcode_table_len

Detailed Description

Return codes returned by modules and virtual server sections.

Id: b0b0d6b34a9ce9df8708903e33384158d0437ac7

Copyright: 2018 The FreeRADIUS server project

Definition in file rcode.h.

Macro Definition Documentation

◆ RETURN_UNLANG_DISALLOW

#define RETURN_UNLANG_DISALLOW RETURN_UNLANG_RCODE(RLM_MODULE_DISALLOW)

Definition at line 63 of file rcode.h.

◆ RETURN_UNLANG_FAIL

#define RETURN_UNLANG_FAIL RETURN_UNLANG_RCODE(RLM_MODULE_FAIL)

Definition at line 59 of file rcode.h.

◆ RETURN_UNLANG_HANDLED

#define RETURN_UNLANG_HANDLED RETURN_UNLANG_RCODE(RLM_MODULE_HANDLED)

Definition at line 61 of file rcode.h.

◆ RETURN_UNLANG_INVALID

#define RETURN_UNLANG_INVALID RETURN_UNLANG_RCODE(RLM_MODULE_INVALID)

Definition at line 62 of file rcode.h.

◆ RETURN_UNLANG_NOOP

#define RETURN_UNLANG_NOOP RETURN_UNLANG_RCODE(RLM_MODULE_NOOP)

Definition at line 65 of file rcode.h.

◆ RETURN_UNLANG_NOTFOUND

#define RETURN_UNLANG_NOTFOUND RETURN_UNLANG_RCODE(RLM_MODULE_NOTFOUND)

Definition at line 64 of file rcode.h.

◆ RETURN_UNLANG_OK

#define RETURN_UNLANG_OK RETURN_UNLANG_RCODE(RLM_MODULE_OK)

Definition at line 60 of file rcode.h.

◆ RETURN_UNLANG_RCODE

#define RETURN_UNLANG_RCODE ( _rcode ) do { p_result->rcode = (_rcode); return UNLANG_ACTION_CALCULATE_RESULT; } while (0)

Definition at line 57 of file rcode.h.

◆ RETURN_UNLANG_REJECT

#define RETURN_UNLANG_REJECT RETURN_UNLANG_RCODE(RLM_MODULE_REJECT)

Definition at line 58 of file rcode.h.

◆ RETURN_UNLANG_TIMEOUT

#define RETURN_UNLANG_TIMEOUT RETURN_UNLANG_RCODE(RLM_MODULE_TIMEOUT)

Definition at line 67 of file rcode.h.

◆ RETURN_UNLANG_UPDATED

#define RETURN_UNLANG_UPDATED RETURN_UNLANG_RCODE(RLM_MODULE_UPDATED)

Definition at line 66 of file rcode.h.

◆ RLM_MODULE_USER_SECTION_REJECT

#define RLM_MODULE_USER_SECTION_REJECT

Value:

        RLM_MODULE_REJECT:              \
        case RLM_MODULE_FAIL:           \
        case RLM_MODULE_INVALID:        \
        case RLM_MODULE_DISALLOW:       \
        case RLM_MODULE_TIMEOUT

Rcodes that translate to a user configurable section failing overall.

Definition at line 75 of file rcode.h.

Enumeration Type Documentation

◆ rlm_rcode_t

enum rlm_rcode_t

Return codes indicating the result of the module call.

All module functions must return one of the codes listed below (apart from RLM_MODULE_NUMCODES, which is used to check for validity).

Enumerator
RLM_MODULE_NOT_SET	Error resolving rcode (should not be returned by modules).
RLM_MODULE_REJECT	Immediately reject the request.
RLM_MODULE_FAIL	Module failed, don't reply.
RLM_MODULE_OK	The module is OK, continue.
RLM_MODULE_HANDLED	The module handled the request, so stop.
RLM_MODULE_INVALID	The module considers the request invalid.
RLM_MODULE_DISALLOW	Reject the request (user is locked out).
RLM_MODULE_NOTFOUND	User not found.
RLM_MODULE_NOOP	Module succeeded without doing anything.
RLM_MODULE_UPDATED	OK (pairs modified).
RLM_MODULE_TIMEOUT	Module (or section) timed out.
RLM_MODULE_NUMCODES	How many valid return codes there are.

Definition at line 40 of file rcode.h.

Variable Documentation

◆ rcode_table

fr_table_num_sorted_t const rcode_table[]

extern

Definition at line 35 of file rcode.c.

◆ rcode_table_len

size_t rcode_table_len