/usr/include/yuma/agt/agt_cb.h is in libyuma-dev 2.10-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 | /*
* Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef _H_agt_cb
#define _H_agt_cb
/* FILE: agt_cb.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
NETCONF Server Data Model callback handler
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
16-apr-07 abb Begun; split out from agt_ps.h
01-aug-08 abb Remove NCX specific stuff; YANG only now
*/
#include "agt.h"
#include "op.h"
#include "rpc.h"
#include "ses.h"
#include "status.h"
#include "val.h"
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* C O N S T A N T S *
* *
*********************************************************************/
/* symbolic tags for agt_cb_register_callback 'forall' boolean */
#define FORALL TRUE
#define FORONE FALSE
/********************************************************************
* *
* T Y P E S *
* *
*********************************************************************/
/* Callback function for server object handler
* Used to provide a callback sub-mode for
* a specific named object
*
* INPUTS:
* scb == session control block making the request
* msg == incoming rpc_msg_t in progress
* cbtyp == reason for the callback
* editop == the parent edit-config operation type, which
* is also used for all other callbacks
* that operate on objects
* newval == container object holding the proposed changes to
* apply to the current config, depending on
* the editop value. Will not be NULL.
* curval == current container values from the <running>
* or <candidate> configuration, if any. Could be NULL
* for create and other operations.
*
* RETURNS:
* status:
*/
typedef status_t
(*agt_cb_fn_t) (ses_cb_t *scb,
rpc_msg_t *msg,
agt_cbtyp_t cbtyp,
op_editop_t editop,
val_value_t *newval,
val_value_t *curval);
/* set of server object callback functions */
typedef struct agt_cb_fnset_t_ {
agt_cb_fn_t cbfn[AGT_NUM_CB];
} agt_cb_fnset_t;
typedef struct agt_cb_fnset_node_t_ {
dlq_hdr_t qhdr;
agt_cb_fnset_t* fnset_ptr;
} agt_cb_fnset_node_t;
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/********************************************************************
* FUNCTION agt_cb_init
*
* Init the server callback module
*
*********************************************************************/
extern void
agt_cb_init (void);
/********************************************************************
* FUNCTION agt_cb_cleanup
*
* Cleanup the server callback module
*
*********************************************************************/
extern void
agt_cb_cleanup (void);
/********************************************************************
* FUNCTION agt_cb_register_callback
*
* Register an object specific callback function
* use the same fn for all callback phases
* all phases will be invoked
*
*
* INPUTS:
* modname == module that defines the target object for
* these callback functions
* defpath == Xpath with default (or no) prefixes
* defining the object that will get the callbacks
* version == exact module revision date expected
* if condition not met then an error will
* be logged (TBD: force unload of module!)
* == NULL means use any version of the module
* cbfn == address of callback function to use for
* all callback phases
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_cb_register_callback (const xmlChar *modname,
const xmlChar *defpath,
const xmlChar *version,
const agt_cb_fn_t cbfn);
/********************************************************************
* FUNCTION agt_cb_register_callbacks
* !!!DEPRECATED - breaks multiple callbacks per obj id
* Use agt_cb_register_callback instead.
*
* Register an object specific callback function
* setup array of callbacks, could be different or NULL
* to skip that phase
*
* INPUTS:
* modname == module that defines the target object for
* these callback functions
* defpath == Xpath with default (or no) prefixes
* defining the object that will get the callbacks
* version == exact module revision date expected
* if condition not met then an error will
* be logged (TBD: force unload of module!)
* == NULL means use any version of the module
* cbfnset == address of callback function set to copy
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_cb_register_callbacks (const xmlChar *modname,
const xmlChar *defpath,
const xmlChar *version,
const agt_cb_fnset_t *cbfnset);
/********************************************************************
* FUNCTION agt_cb_unregister_callbacks
* !!!DEPRECATED - breaks multiple callbacks per obj id
* Use agt_cb_unregister_callbacks instead.
*
*
* Unregister all callback functions for a specific object
*
* INPUTS:
* modname == module containing the object for this callback
* defpath == definition XPath location
*
* RETURNS:
* none
*********************************************************************/
extern void
agt_cb_unregister_callbacks (const xmlChar *modname,
const xmlChar *defpath);
/********************************************************************
* FUNCTION agt_cb_unregister_callback
*
* Unregister all callback functions for a specific object with mathching
* callback function pointers.
*
* INPUTS:
* modname == module containing the object for this callback
* defpath == definition XPath location
* cbfn == pointer to registered callback function, if NULL will remove
* the first matching callback
*
* RETURNS:
* none
*********************************************************************/
extern void
agt_cb_unregister_callback(const xmlChar *modname,
const xmlChar *defpath,
const agt_cb_fn_t cbfn);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_agt_cb */
|