yumapro
24.10-2
YumaPro SDK
|
Supports original notifications (RFC 5277) using the <create-subscription> operation. More...
Data Structures | |
struct | agt_not_msg_t |
one notification message that will be sent to all subscriptions in the stream and kept in the replay buffer for that stream (notificationQ) More... | |
Typedefs | |
typedef uint32 | agt_not_subid_t |
subscription-id parameter | |
typedef void(* | agt_not_modify_filter_cbfn_t) (ses_cb_t *scb, agt_not_subid_t subid, agt_not_filtertyp_t filtyp, const val_value_t *new_filter) |
Modify Filter Callback. More... | |
typedef void(* | agt_not_delete_subscription_cbfn_t) (agt_not_subid_t subid, boolean kill_pending) |
Delete Subscription Callback. More... | |
typedef void(* | agt_not_check_push_cbfn_t) (ses_id_t sid) |
Check Push Callback. More... | |
typedef void(* | agt_not_module_removed_cbfn_t) (const ncx_module_t *mod) |
Remove Module Callback. More... | |
typedef void(* | agt_not_stream_cbfn_t) (const xmlChar *event_stream, agt_not_subevent_t subevent, void *cookie) |
Event Stream Callback. More... | |
Supports original notifications (RFC 5277) using the <create-subscription> operation.
Supports new notifications (RFC 8639) using the <establish-subscription> operation.
typedef void(* agt_not_check_push_cbfn_t) (ses_id_t sid) |
Check Push Callback.
Used by YANG Push to check periodic and simulated operational
sid | session ID to process (if PTHREADS version) == 0 to process all sessions |
typedef void(* agt_not_delete_subscription_cbfn_t) (agt_not_subid_t subid, boolean kill_pending) |
Delete Subscription Callback.
If the user invokes <delete-subscription> or <kill-subscription> then this callback will be invoked to remove the resources for the subscription
subid | subscription ID |
kill_pending | TRUE if a kill-subscription ot delete-subscription is still pending FALSE if subscription being deleted and all messages already done |
typedef void(* agt_not_modify_filter_cbfn_t) (ses_cb_t *scb, agt_not_subid_t subid, agt_not_filtertyp_t filtyp, const val_value_t *new_filter) |
Modify Filter Callback.
If a YANG Push subscription uses a filter-ref and that filter is modified, then this callback will be invoked. A configured filter is not allowed to be deleted if any subscriptions are using it
If the filter is not acceptable the subscription is expected to suspend or terminate itself
scb | session owning the subscription to use for access control |
subid | subscription ID |
filtyp | new filter type |
new_filter | new filter value (NULL if AGT_NOT_FILTER_EMPTY) |
typedef void(* agt_not_module_removed_cbfn_t) (const ncx_module_t *mod) |
Remove Module Callback.
Used by YANG Push to suspend subscriptions if they use a filter that has a target objct in this module
mod | module getting removed |
typedef void(* agt_not_stream_cbfn_t) (const xmlChar *event_stream, agt_not_subevent_t subevent, void *cookie) |
Event Stream Callback.
Used by SIL code to determine if events should be generated or not. The server will invoke the callback with an event stream sub-event type.
It is possible that subscription filters prevent specific events from reaching the subscriber. These corner-cases are ignored for this callback. Only subscriptions are tracked, not the actual notifications delivered on each subscription.
There will be one callback per event-stream so if multiple event streams are modified at once then these callbacks will be serialized, one per event-stream.
It is possible a callback will receive a redundant event, e.g., two 'active' events in a row. This is normal as the server does not maintain an event history for each callback, This can happen if the yumaworks-event-stream module is used to edit the stream configuration.
Note that the replay-buffer is not considered when determining if an event-stream is active or not. The replay feature is rarely used. This callback is used to determine if active client sessions are subscribed to the event-stream. The notification generator SHOULD NOT use this callback if the replay buffer is considered make the event-stream be active.
The callbacks done will depend on the registration parameters. For the modname
parameter:
stream_name
parameter:event_stream | event-stream name the event is for.
|
subevent | sub-event type being reported.
|
cookie | the cookie passed to the registration function |
enum agt_not_filtertyp_t |
enum agt_not_sterr_t |
stream error parameter numbers used internally for error reporting
enum agt_not_subevent_t |
Suspend subscription reasons Used internally instead of finding YANG identities.
Terminate subscription reasons.
Used internally instead of finding YANG identities