The FreeRADIUS server  $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
tmpl_priv.h
Go to the documentation of this file.
1 #pragma once
2 /*
3  * This program is free software; you can redistribute it and/or modify
4  * it under the terms of the GNU General Public License as published by
5  * the Free Software Foundation; either version 2, or (at your option)
6  * any later version.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software Foundation,
15  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16  */
17 
18 /**
19  * $Id: f710250cd13f11b3a81707ccb9d319a2ca1ea1ed $
20  *
21  * @file unlang/tmpl_priv.h
22  * @brief Declarations for the unlang tmpl interface
23  *
24  * @copyright 2006-2019 The FreeRADIUS server project
25  */
26 #include "unlang_priv.h"
27 #include <freeradius-devel/server/exec.h>
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 /** A tmpl stack entry
34  *
35  * Represents a single tmpl
36  */
37 typedef struct {
38  TALLOC_CTX *ctx; //!< for allocating value boxes
39  fr_value_box_list_t *out; //!< output list if the exec succeeds
40  fr_value_box_list_t list; //!< our intermediate working list
41 
42  void *rctx; //!< for resume
43  fr_unlang_tmpl_resume_t resume; //!< resumption handler
44  fr_unlang_tmpl_signal_t signal; //!< signal handler
45 
46  union {
47  fr_exec_state_t exec;
48  };
49 
50  unlang_tmpl_args_t args; //!< Arguments that control how the
51  ///< tmpl is evaluated.
53 
54 #ifdef __cplusplus
55 }
56 #endif
fr_value_box_list_t * out
output list if the exec succeeds
Definition: tmpl_priv.h:39
unlang_tmpl_args_t args
Arguments that control how the tmpl is evaluated.
Definition: tmpl_priv.h:50
TALLOC_CTX * ctx
for allocating value boxes
Definition: tmpl_priv.h:38
fr_unlang_tmpl_resume_t resume
resumption handler
Definition: tmpl_priv.h:43
fr_value_box_list_t list
our intermediate working list
Definition: tmpl_priv.h:40
void * rctx
for resume
Definition: tmpl_priv.h:42
fr_unlang_tmpl_signal_t signal
signal handler
Definition: tmpl_priv.h:44
A tmpl stack entry.
Definition: tmpl_priv.h:37
unlang_action_t(* fr_unlang_tmpl_resume_t)(rlm_rcode_t *p_result, request_t *request, void *rctx)
A callback for when the request is resumed.
Definition: tmpl.h:108
void(* fr_unlang_tmpl_signal_t)(request_t *request, void *rctx, fr_signal_t action)
A callback when the request gets a fr_signal_t.
Definition: tmpl.h:97
Arguments for evaluating different types of tmpls.
Definition: tmpl.h:47
Private interpreter structures and functions.