Structure representing a "virtual" SIP subscription. More...
Data Fields | ||
| int | body_changed | |
| struct ast_sip_pubsub_body_generator * | body_generator | |
| struct ast_str * | body_text | |
| struct { | ||
| size_t current | ||
| struct ast_sip_subscription ** elems | ||
| size_t max | ||
| } | children | |
| struct ao2_container * | datastores | |
| char * | display_name | |
| unsigned int | full_state | |
| const struct ast_sip_subscription_handler * | handler | |
| struct ast_json * | persistence_data | |
| char | resource [0] | |
| pjsip_evsub_state | subscription_state | |
| struct sip_subscription_tree * | tree | |
| pjsip_sip_uri * | uri | |
| unsigned int | version | |
Detailed Description
Structure representing a "virtual" SIP subscription.
This structure serves a dual purpose. Structurally, it is the constructed tree of subscriptions based on the resources being subscribed to. API-wise, this serves as the handle that subscription handlers use in order to interact with the pubsub API.
Definition at line 699 of file res_pjsip_pubsub.c.
Field Documentation
◆ body_changed
| int body_changed |
Indicator that the body text has changed since the last notification
Definition at line 713 of file res_pjsip_pubsub.c.
Referenced by generate_notify_body().
◆ body_generator
| struct ast_sip_pubsub_body_generator* body_generator |
Body generator for NOTIFYs
Definition at line 707 of file res_pjsip_pubsub.c.
◆ body_text
| struct ast_str* body_text |
Saved NOTIFY body text for this subscription
Definition at line 711 of file res_pjsip_pubsub.c.
Referenced by generate_notify_body().
◆ [struct]
| struct { ... } children |
Vector of child subscriptions
Referenced by cmp_subscription_childrens(), create_subscription_tree(), destroy_subscriptions(), and generate_notify_body().
◆ current
| size_t current |
Definition at line 709 of file res_pjsip_pubsub.c.
◆ datastores
| struct ao2_container* datastores |
Subscription datastores set up by handlers
Definition at line 701 of file res_pjsip_pubsub.c.
Referenced by ast_sip_subscription_add_datastore(), ast_sip_subscription_get_datastore(), ast_sip_subscription_get_datastores(), and ast_sip_subscription_remove_datastore().
◆ display_name
| char* display_name |
Display Name of resource
Definition at line 725 of file res_pjsip_pubsub.c.
Referenced by allocate_subscription(), and cmp_subscription_childrens().
◆ elems
| struct ast_sip_subscription* * elems |
Definition at line 709 of file res_pjsip_pubsub.c.
◆ full_state
| unsigned int full_state |
For lists, indicates if full state should always be communicated.
Definition at line 719 of file res_pjsip_pubsub.c.
◆ handler
| const struct ast_sip_subscription_handler* handler |
The handler for this subscription
Definition at line 703 of file res_pjsip_pubsub.c.
Referenced by cli_list_subscriptions_detail(), cli_show_subscription_common(), cli_show_subscriptions_detail(), initial_notify_task(), pubsub_on_rx_refresh(), send_notify(), and sip_subscription_to_ami().
◆ max
| size_t max |
Definition at line 709 of file res_pjsip_pubsub.c.
◆ persistence_data
| struct ast_json* persistence_data |
Data to be persisted with the subscription
Definition at line 723 of file res_pjsip_pubsub.c.
Referenced by ast_sip_subscription_get_persistence_data(), and ast_sip_subscription_set_persistence_data().
◆ resource
| char resource[0] |
Name of resource being subscribed to
Definition at line 727 of file res_pjsip_pubsub.c.
Referenced by allocate_subscription(), ast_sip_subscription_set_persistence_data(), cli_list_subscriptions_detail(), cli_show_subscription_common(), cli_show_subscriptions_detail(), cmp_subscription_childrens(), create_virtual_subscriptions(), initial_notify_task(), pubsub_on_refresh_timeout(), pubsub_on_rx_refresh(), serialized_send_notify(), sub_tree_subscription_terminate_cb(), subscription_persistence_remove(), subscription_persistence_update(), and subscription_tree_destructor().
◆ subscription_state
| pjsip_evsub_state subscription_state |
The current state of the subscription
Definition at line 715 of file res_pjsip_pubsub.c.
Referenced by pubsub_on_refresh_timeout(), send_notify(), and serialized_send_notify().
◆ tree
| struct sip_subscription_tree* tree |
Pointer to the base of the tree
Definition at line 705 of file res_pjsip_pubsub.c.
Referenced by allocate_subscription(), ast_sip_subscription_set_persistence_data(), and create_virtual_subscriptions().
◆ uri
| pjsip_sip_uri* uri |
URI associated with the subscription
Definition at line 721 of file res_pjsip_pubsub.c.
◆ version
| unsigned int version |
For lists, the current version to place in the RLMI body
Definition at line 717 of file res_pjsip_pubsub.c.
Referenced by ParsingContext::next(), and pubsub_on_rx_refresh().
The documentation for this struct was generated from the following file:
