A tree of SIP subscriptions. More...
Data Fields | |
| pjsip_dialog * | dlg |
| struct ast_sip_endpoint * | endpoint |
| pjsip_evsub * | evsub |
| struct ast_sip_sched_task * | expiration_task |
| int | is_list |
| struct { | |
| struct sip_subscription_tree * next | |
| } | next |
| unsigned int | notification_batch_interval |
| int | notify_sched_id |
| struct subscription_persistence * | persistence |
| enum ast_sip_subscription_role | role |
| struct ast_sip_subscription * | root |
| unsigned int | send_scheduled_notify |
| struct ast_taskprocessor * | serializer |
| enum sip_subscription_tree_state | state |
| pjsip_transport * | transport |
Detailed Description
A tree of SIP subscriptions.
Because of the ability to subscribe to resource lists, a SIP subscription can result in a tree of subscriptions being created. This structure represents the information relevant to the subscription as a whole, to include the underlying PJSIP structure for the subscription.
Definition at line 431 of file res_pjsip_pubsub.c.
Field Documentation
◆ dlg
| pjsip_dialog* dlg |
The underlying PJSIP dialog
Definition at line 443 of file res_pjsip_pubsub.c.
Referenced by allocate_subscription(), ast_sip_subscription_get_dialog(), ast_sip_subscription_get_header(), ast_sip_subscription_get_remote_uri(), ast_sip_subscription_notify(), cli_complete_subscription_common(), cli_list_subscriptions_detail(), cli_show_subscription_common(), cli_show_subscriptions_detail(), create_subscription_tree(), initial_notify_task(), pubsub_on_evsub_state(), pubsub_on_refresh_timeout(), serialized_send_notify(), sip_subscription_to_ami(), subscription_persistence_create(), subscription_persistence_update(), subscription_setup_dialog(), subscription_tree_destructor(), and subscription_unreference_dialog().
◆ endpoint
| struct ast_sip_endpoint* endpoint |
The endpoint with which the subscription is communicating
Definition at line 433 of file res_pjsip_pubsub.c.
Referenced by allocate_subscription_tree(), ast_sip_subscription_destroy(), ast_sip_subscription_get_endpoint(), cli_list_subscriptions_detail(), cli_show_subscriptions_detail(), destroy_subscription(), remove_subscription(), sip_subscription_send_request(), sip_subscription_to_ami(), subscription_persistence_create(), subscription_persistence_remove(), subscription_persistence_update(), subscription_setup_dialog(), and subscription_tree_destructor().
◆ evsub
| pjsip_evsub* evsub |
The underlying PJSIP event subscription structure
Definition at line 441 of file res_pjsip_pubsub.c.
Referenced by ast_sip_create_subscription(), create_subscription_tree(), initial_notify_task(), pubsub_on_evsub_state(), pubsub_on_rx_refresh(), pubsub_on_rx_subscribe_request(), send_notify(), serialized_pubsub_on_client_refresh(), sip_subscription_accept(), sip_subscription_send_request(), sip_subscription_to_ami(), sub_persistence_recreate(), sub_tree_subscription_terminate_cb(), and subscription_setup_dialog().
◆ expiration_task
| struct ast_sip_sched_task* expiration_task |
On asterisk restart, this is the task data used to restart the expiration timer if pjproject isn't capable of restarting the timer.
Definition at line 462 of file res_pjsip_pubsub.c.
Referenced by initial_notify_task(), pubsub_on_evsub_state(), and pubsub_on_rx_refresh().
◆ is_list
| int is_list |
Is this subscription to a list?
Definition at line 453 of file res_pjsip_pubsub.c.
Referenced by create_subscription_tree(), SwaggerType::load(), pubsub_on_rx_refresh(), send_notify(), and sip_subscription_accept().
◆ next [1/2]
| struct sip_subscription_tree* next |
Definition at line 455 of file res_pjsip_pubsub.c.
Referenced by for_each_subscription(), and remove_subscription().
◆ next [2/2]
| struct { ... } next |
Next item in the list
◆ notification_batch_interval
| unsigned int notification_batch_interval |
Interval to use for batching notifications
Definition at line 445 of file res_pjsip_pubsub.c.
Referenced by ast_sip_subscription_notify(), create_subscription_tree(), and schedule_notification().
◆ notify_sched_id
| int notify_sched_id |
Scheduler ID for batched notification
Definition at line 447 of file res_pjsip_pubsub.c.
Referenced by allocate_subscription_tree(), schedule_notification(), and serialized_send_notify().
◆ persistence
| struct subscription_persistence* persistence |
Persistence information
Definition at line 439 of file res_pjsip_pubsub.c.
Referenced by allocate_subscription(), ast_sip_subscription_set_persistence_data(), cli_subscription_expiry(), create_subscription_tree(), initial_notify_task(), pubsub_on_rx_subscribe_request(), send_notify(), sub_tree_subscription_terminate_cb(), subscription_persistence_remove(), and subscription_persistence_update().
◆ role
| enum ast_sip_subscription_role role |
The role for this subscription
Definition at line 437 of file res_pjsip_pubsub.c.
Referenced by ami_subscription_detail_inbound(), ami_subscription_detail_outbound(), cli_complete_subscription_inbound(), cli_complete_subscription_outbound(), cli_list_subscriptions_inbound(), cli_list_subscriptions_outbound(), cli_show_subscription_inbound(), cli_show_subscription_outbound(), cli_show_subscriptions_inbound(), cli_show_subscriptions_outbound(), create_subscription_tree(), and sip_subscription_to_ami().
◆ root
| struct ast_sip_subscription* root |
The root of the subscription tree
Definition at line 451 of file res_pjsip_pubsub.c.
Referenced by ast_sip_subscription_notify(), cli_list_subscriptions_detail(), cli_show_subscription_common(), cli_show_subscriptions_detail(), create_subscription_tree(), initial_notify_task(), pubsub_on_evsub_state(), pubsub_on_refresh_timeout(), remove_subscription(), send_notify(), serialized_send_notify(), sip_subscription_to_ami(), sub_tree_subscription_terminate_cb(), subscription_persistence_remove(), subscription_persistence_update(), and subscription_tree_destructor().
◆ send_scheduled_notify
| unsigned int send_scheduled_notify |
Indicator if scheduled batched notification should be sent
Definition at line 449 of file res_pjsip_pubsub.c.
Referenced by schedule_notification(), send_notify(), and serialized_send_notify().
◆ serializer
| struct ast_taskprocessor* serializer |
Serializer on which to place operations for this subscription
Definition at line 435 of file res_pjsip_pubsub.c.
Referenced by allocate_subscription_tree(), ast_sip_subscription_get_serializer(), initial_notify_task(), pubsub_on_client_refresh(), pubsub_on_rx_refresh(), pubsub_on_rx_subscribe_request(), pubsub_on_server_timeout(), sched_cb(), sub_persistence_recreate(), sub_tree_transport_cb(), subscription_setup_dialog(), and subscription_tree_destructor().
◆ state
Subscription tree state
Definition at line 457 of file res_pjsip_pubsub.c.
Referenced by ast_sip_subscription_notify(), pubsub_on_evsub_state(), pubsub_on_refresh_timeout(), pubsub_on_rx_refresh(), pubsub_on_server_timeout(), serialized_pubsub_on_refresh_timeout(), serialized_send_notify(), and sub_tree_subscription_terminate_cb().
◆ transport
| pjsip_transport* transport |
The transport the subscription was received on. Only used for reliable transports.
Definition at line 466 of file res_pjsip_pubsub.c.
Referenced by subscription_persistence_remove(), and subscription_persistence_update().
The documentation for this struct was generated from the following file:
