 |
yumapro
25.10-1
YumaPro SDK
|
|
yumapro
25.10-1
YumaPro SDK
|
subscription parms parameter block used by various subscribe APIs each API will ignore unused parameters More...
#include <agt_not.h>
Data Fields | |
| op_editop_t | editop |
| edit operation | |
| boolean | is_establish |
| is_establish flag to help match existing APIs | |
| agt_not_subid_t | id |
| subscription ID only provided if is_configured | |
| const xmlChar * | filter_name |
| filter name id a filter-ref parameter used | |
| const val_value_t * | subtree_filter |
| subtree containing the subtree-filter if used | |
| const val_value_t * | xpath_filter |
| leaf containing the XPath filter if used; need PCB from val to preserve namespace mappings from the client | |
| const val_value_t * | encoding |
| leaf containing the encoding parameter if set; need identityref details | |
| const val_value_t * | transport |
| leaf containing the transport parameter if set; need identityref details | |
| const xmlChar * | source_address |
| source address parameter is not supported yet in server | |
| const xmlChar * | purpose |
| admin string saved from configured subsctiption | |
| const val_value_t * | parentval |
| parentval of the parameters to handle additional unstable YANG Push 2 parameters | |
| uint8 | dscp |
| DSCP value to use for the subscription. | |
| const xmlChar * | stream |
| event stream subscription | |
| const xmlChar * | stop_time |
| the replay-start-time is read-only when used in configured subscriptions so not present here More... | |
| boolean | configured_replay |
| configured-replay leaf not supported yet causes entire replay buffer to be sent to receiver Since starts at boot-time replay buffer is empty | |
| boolean | is_datastore |
| datastore subscription flag | |
| ncx_nmda_ds_t | datastore_id |
| NMDA datastore ID if is_datastore true. | |
| boolean | is_periodic |
| TRUE for periodic subscription. | |
| boolean | period_set |
| used for period or dampening-period | |
| uint32 | period |
| period or dampening in centiseconds | |
| const xmlChar * | anchor_time |
| anchor time support starting 25.10-1 | |
| boolean | on_change |
| on-change datastore subscription flag | |
| boolean | sync_on_start |
| TRUE = sync-on-start requested by client (default) | |
| uint32 | included_changes |
| inverse of excluded-changes; all combinations supported | |
| boolean | delete_rcvrs_pending |
| internal fields : do not set | |
subscription parms parameter block used by various subscribe APIs each API will ignore unused parameters
Only intended for configured subscriptions
This is not intended for storage of these parameters so the string and struct pointers are const. The values will be strduped as needed or just used within the API function call
parameters do not need to persist past 'COMMIT phase function call
| const xmlChar* stop_time |
the replay-start-time is read-only when used in configured subscriptions so not present here
stop-time is not supported yet for configured subscriptions; only applies to event streams
1.9.5