sysrepo  1.4.58
YANG datastore
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Subscriptions

Every *_subscribe() call will return a subscription structure. It is possible to subscribe using an existing subscription and then multiple events will be handled by a single subscription. By default, there is a dedicated thread for handling all the events in a subscription structure so no further action is required.

If this is not desired, it is possible to handle events on a subscription without a separate thread. When subscribing, the flag SR_SUBSCR_NO_THREAD needs to be used so that the thread is not created. Be careful, if you use it, the subscription exists and events can occur but they are not being handled so they can time out, for example, unless processed manually. That can be achieved by a function that processes all pending events on a subscription. sr_process_events() can either be called periodically or only when there are actual events. This can be learnt by the subscription event pipe being ready for reading.

Subscription API

Change Subscriptions

These are the most common kinds of subscriptions. A callback can be set to be called when specific data changes occur so that it can appropriately react and adjust the system or whatever it manages accordingly. There can be many subscribers for the same data and arbitrary XPath filters can be applied.

On changes, the callback is called with an event. By default, there are always 2 events following one after the other. On change, the new datastore content is prepared but not written yet and so the changes can be refused for any reason. If they are not, the changes are committed and hence visible for any subsequent operations. Right after that done event is generated and callbacks called. It is no longer possible to revert the changes. In case at least one of the callbacks has failed during change event, the whole commit is aborted. Callbacks that already processed the change event successfully will be called with abort event so they can revert them and keep Sysrepo and the system consistent.

There is one special event update that is generated only for subscriptions that request it. This event occurs before any of the other ones mentioned before because it allows to further modify the data changes that are being handled. Callback with this event can fail and cause the changes to be immediately refused.

Also, a subscription can request enabled event on SR_DS_RUNNING datastore and get the current configuration at the time of subscribing. This event is normally followed by done event, just like change event. However, enabled event is generated even if the current configuration is empty (so there will be no changes available in the callback)!

When subscribing to operational datastore changes, only push changes are acknowledged and callbacks called. Pull subscriptions are ignored.

On the events update and change, the callback can return a special SR_ERR_CALLBACK_SHELVE value. This causes the event not to be processed and simply skipped (shelved). When all the events on the subscription are processed next time, this subscription callback with the same event is called again. This special return value can be returned several times but be careful for the timeout not to elapse! Typically, this whole mechanism is used only when the events are handled by the application, not by a Sysrepo thread (SR_SUBSCR_NO_THREAD). Otherwise the application does not have full control over calling the event processing function sr_process_events() (strictly speaking, it can be called directly even if Sysrepo thread is handling this subscription, but there is likely no use-case).

For each of these events, the changes are retrieved using an iterator, which can be created several times and optionally with only selected changes.

It is important to be aware of the effect of subscribing to running data on operational datastore.

Change Data Subscription API

RPC/Action Subscriptions

All the functions can be used for both RPCs and actions. If there are no matching subscriptions, the RPC/action cannot even be sent. Callbacks work as one would expect, on rpc event they are provided each with the input and can fail or succeed with optionally generating some output that is sent back to the original sender. There can be predicates on the subscription XPath filtering only specific RPC/action instances.

In case there are several subscriptions matching a single RPC/action, it is best to make sure there is only one subscription with the lowest priority (will be called last). This (main) subscription will be the one generating output for the sender (previous outputs will be overwritten) and, additionally, will never receive the abort event (in case it fails, only all the other higher priority callbacks will be aborted).

RPC subscriptions can also return SR_ERR_CALLBACK_SHELVE on rpc event.

RPC/Action Subscription API

Notification Subscriptions

Notifications are supported by specific subscriptions that allow them to be sent and received. Sent notification are also stored for possible future replay if the particular module was configued that way (mentioned in schemas).

When subscribing to notifications, there are several options that can be specified and which follow the definitions from NETCONF Notifications RFC. Normally, all notifications are real-time. If replay is requested, these are replay notifications. If a replay finished and the subscription changes into a standard one, replay complete notification is delivered. Lastly, once the subscription should be terminated because its stop time was reached, stop is received before removing the subscription.

Notification Subscription API

Operational Subscriptions

Operational subscriptions allow providing data that are requested by clients. Commonly, these can be used to read the current state of a device, for example, and then return them as state data nodes. However, they can also be used to provide configuration data nodes. In that case they should return only the configuration that is actually in-use by the managed device. Much more details and explanations can be found in the NMDA RFC.

Operational callback is not called unless its data are required so keep these rules in mind:

  • if the parent of the provided data does not exist in the operational datastore, neither can its descendants, see operational data for details about data existence;

    Example: If you subscribed for providing /mod:config-container/config-list/state-leaf, your callback would be called for every existing instance of /mod:config-container/config-list, not at all if there was none.

  • in case there are nested subscriptions, the deeper ones are called last so their parents can be created;

    Example: If you subscribed to /mod:config-container/config-list and /mod:config-container/config-list/state-leaf, the former callback would be called before the latter, so whatever list instances were created in that first call, only for those would then the leaf value be retrieved.

  • if a filter is used that does not select the data provided by a callback, this callback is usually not called. This redundancy check is performed only textually so it will never cover all the cases.

    Example: If you subscribed to /mod:config-container/config-list[key="val"] and then /mod:config-container/state-list/* was requested, your callback would not be called. Neither would it be called when /mod:config-container/config-list[key="val2"] was requested. However, if /mod:config-container/config-list/key[.="val2"] was used as the filter (even though there is no reason to use such a path), the callback would be called and the returned data filtered out later.

Finally, just like configuration and RPC subscription, operational subscription callback can return SR_ERR_CALLBACK_SHELVE.

Operational Data Subscription API