/usr/include/yuma/agt/agt_not.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 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 | /*
* 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_not
#define _H_agt_not
/* FILE: agt_not.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
NETCONF Notifications DM module support
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
30-may-09 abb Begun.
*/
#include <xmlstring.h>
#ifndef _H_dlq
#include "dlq.h"
#endif
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
#ifndef _H_obj
#include "obj.h"
#endif
#ifndef _H_ses
#include "ses.h"
#endif
#ifndef _H_status
#include "status.h"
#endif
#ifndef _H_tstamp
#include "tstamp.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* C O N S T A N T S *
* *
*********************************************************************/
#define AGT_NOT_MODULE1 (const xmlChar *)"notifications"
#define AGT_NOT_MODULE2 (const xmlChar *)"nc-notifications"
/* agt_not_subscription_t flags */
/* if set, stopTime is in the future */
#define AGT_NOT_FL_FUTURESTOP bit0
/* if set, replayComplete is ready to be sent */
#define AGT_NOT_FL_RC_READY bit1
/* if set replayComplete has been sent */
#define AGT_NOT_FL_RC_DONE bit2
/* if set, notificationComplete is ready to be sent */
#define AGT_NOT_FL_NC_READY bit3
/* if set, notificationComplete has been sent */
#define AGT_NOT_FL_NC_DONE bit4
/********************************************************************
* *
* T Y P E S *
* *
*********************************************************************/
/* per-subscription state */
typedef enum agt_not_state_t_ {
/* none == cleared memory; not set */
AGT_NOT_STATE_NONE,
/* init == during initialization */
AGT_NOT_STATE_INIT,
/* replay == during sending of selected replay buffer */
AGT_NOT_STATE_REPLAY,
/* timed == stopTime in future, after replayComplete
* but before notificationComplete
*/
AGT_NOT_STATE_TIMED,
/* live == live delivery mode (no stopTime given) */
AGT_NOT_STATE_LIVE,
/* shutdown == forced shutdown mode;
* notificationComplete is being sent
*/
AGT_NOT_STATE_SHUTDOWN
} agt_not_state_t;
/* server supported stream types */
typedef enum agt_not_stream_t_ {
AGT_NOT_STREAM_NONE,
AGT_NOT_STREAM_NETCONF
} agt_not_stream_t;
/* one notification message that will be sent to all
* subscriptions and kept in the replay buffer (notificationQ)
*/
typedef struct agt_not_msg_t_ {
dlq_hdr_t qhdr;
obj_template_t *notobj;
dlq_hdr_t payloadQ; /* Q of val_value_t */
uint32 msgid;
xmlChar eventTime[TSTAMP_MIN_SIZE];
val_value_t *msg; /* /notification element */
val_value_t *event; /* ptr inside msg for filter */
} agt_not_msg_t;
/* one subscription that will be kept in the subscriptionQ */
typedef struct agt_not_subscription_t_ {
dlq_hdr_t qhdr;
ses_cb_t *scb; /* back-ptr to session */
ses_id_t sid; /* used when scb deleted */
xmlChar *stream;
agt_not_stream_t streamid;
op_filtertyp_t filtertyp;
val_value_t *filterval;
val_value_t *selectval;
xmlChar createTime[TSTAMP_MIN_SIZE];
xmlChar *startTime; /* converted to UTC */
xmlChar *stopTime; /* converted to UTC */
uint32 flags;
agt_not_msg_t *firstreplaymsg; /* back-ptr; could be zapped */
agt_not_msg_t *lastreplaymsg; /* back-ptr; could be zapped */
agt_not_msg_t *lastmsg; /* back-ptr; could be zapped */
uint32 firstreplaymsgid; /* w/firstreplaymsg is deleted */
uint32 lastreplaymsgid; /* w/lastreplaymsg is deleted */
uint32 lastmsgid; /* w/ lastmsg is deleted */
agt_not_state_t state;
} agt_not_subscription_t;
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/********************************************************************
* FUNCTION agt_not_init
*
* INIT 1:
* Initialize the server notification module data structures
*
* INPUTS:
* none
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_not_init (void);
/********************************************************************
* FUNCTION agt_not_init2
*
* INIT 2:
* Initialize the monitoring data structures
* This must be done after the <running> config is loaded
*
* INPUTS:
* none
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_not_init2 (void);
/********************************************************************
* FUNCTION agt_not_cleanup
*
* Cleanup the module data structures
*
* INPUTS:
* none
* RETURNS:
* none
*********************************************************************/
extern void
agt_not_cleanup (void);
/********************************************************************
* FUNCTION agt_not_send_notifications
*
* Send out some notifications to the configured subscriptions
* if needed.
*
* Simple design:
* go through all the subscriptions and send at most one
* notification to each one if needed. This will build
* in some throttling based on the ncxserver select loop
* timeout (or however this function is called).
*
* OUTPUTS:
* notifications may be written to some active sessions
*
* RETURNS:
* number of notifications sent;
* used for simple burst throttling
*********************************************************************/
extern uint32
agt_not_send_notifications (void);
/********************************************************************
* FUNCTION agt_not_clean_eventlog
*
* Remove any delivered notifications when the replay buffer
* size is set to zero
*
*********************************************************************/
extern void
agt_not_clean_eventlog (void);
/********************************************************************
* FUNCTION agt_not_remove_subscription
*
* Remove and expire a subscription with the specified session ID.
* The session is being removed.
*
* INPUTS:
* sid == session ID to use
*********************************************************************/
extern void
agt_not_remove_subscription (ses_id_t sid);
/********************************************************************
* FUNCTION agt_not_new_notification
*
* Malloc and initialize the fields in an agt_not_msg_t
*
* INPUTS:
* eventType == object template of the event type
*
* RETURNS:
* pointer to the malloced and initialized struct or NULL if an error
*********************************************************************/
extern agt_not_msg_t *
agt_not_new_notification (obj_template_t *eventType);
/********************************************************************
* FUNCTION agt_not_free_notification
*
* Scrub the memory in an agt_not_template_t by freeing all
* the sub-fields and then freeing the entire struct itself
* The struct must be removed from any queue it is in before
* this function is called.
*
* INPUTS:
* notif == agt_not_template_t to delete
*********************************************************************/
extern void
agt_not_free_notification (agt_not_msg_t *notif);
/********************************************************************
* FUNCTION agt_not_add_to_payload
*
* Queue the specified value node into the payloadQ
* for the specified notification
*
* INPUTS:
* notif == notification to send
* val == value to add to payloadQ
* !!! THIS IS LIVE MALLOCED MEMORY PASSED OFF
* !!! TO THIS FUNCTION. IT WILL BE FREED LATER
* !!! DO NOT CALL val_free_value
* !!! AFTER THIS CALL
*
* OUTPUTS:
* val added to the notif->payloadQ
*
*********************************************************************/
extern void
agt_not_add_to_payload (agt_not_msg_t *notif,
val_value_t *val);
/********************************************************************
* FUNCTION agt_not_queue_notification
*
* Queue the specified notification in the replay log.
* It will be sent to all the active subscriptions
* as needed.
*
* INPUTS:
* notif == notification to send
* !!! THIS IS LIVE MALLOCED MEMORY PASSED OFF
* !!! TO THIS FUNCTION. IT WILL BE FREED LATER
* !!! DO NOT CALL agt_not_free_notification
* !!! AFTER THIS CALL
*
* OUTPUTS:
* message added to the notificationQ
*
*********************************************************************/
extern void
agt_not_queue_notification (agt_not_msg_t *notif);
/********************************************************************
* FUNCTION agt_not_is_replay_event
*
* Check if the specified notfication is the replayComplete
* or notificationComplete notification events
*
* INPUTS:
* notifobj == notification object to check
*
* RETURNS:
* TRUE if the notification object is one of the special
* replay buffer events
* FALSE otherwise
*********************************************************************/
extern boolean
agt_not_is_replay_event (const obj_template_t *notifobj);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_agt_not */
|