res_pjsip: Add 'suppress_q850_reason_headers' option to endpoint
[asterisk/asterisk.git] / include / asterisk / res_pjsip.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #ifndef _RES_PJSIP_H
20 #define _RES_PJSIP_H
21
22 #include <pjsip.h>
23 /* Needed for SUBSCRIBE, NOTIFY, and PUBLISH method definitions */
24 #include <pjsip_simple.h>
25 #include <pjsip/sip_transaction.h>
26 #include <pj/timer.h>
27 #include <pjlib.h>
28
29 #include "asterisk/stringfields.h"
30 /* Needed for struct ast_sockaddr */
31 #include "asterisk/netsock2.h"
32 /* Needed for linked list macros */
33 #include "asterisk/linkedlists.h"
34 /* Needed for ast_party_id */
35 #include "asterisk/channel.h"
36 /* Needed for ast_sorcery */
37 #include "asterisk/sorcery.h"
38 /* Needed for ast_dnsmgr */
39 #include "asterisk/dnsmgr.h"
40 /* Needed for ast_endpoint */
41 #include "asterisk/endpoints.h"
42 /* Needed for ast_t38_ec_modes */
43 #include "asterisk/udptl.h"
44 /* Needed for pj_sockaddr */
45 #include <pjlib.h>
46 /* Needed for ast_rtp_dtls_cfg struct */
47 #include "asterisk/rtp_engine.h"
48 /* Needed for AST_VECTOR macro */
49 #include "asterisk/vector.h"
50 /* Needed for ast_sip_for_each_channel_snapshot struct */
51 #include "asterisk/stasis_channels.h"
52 #include "asterisk/stasis_endpoints.h"
53
54 /* Forward declarations of PJSIP stuff */
55 struct pjsip_rx_data;
56 struct pjsip_module;
57 struct pjsip_tx_data;
58 struct pjsip_dialog;
59 struct pjsip_transport;
60 struct pjsip_tpfactory;
61 struct pjsip_tls_setting;
62 struct pjsip_tpselector;
63
64 /*! \brief Maximum number of ciphers supported for a TLS transport */
65 #define SIP_TLS_MAX_CIPHERS 64
66
67 /*!
68  * \brief Structure for SIP transport information
69  */
70 struct ast_sip_transport_state {
71         /*! \brief Transport itself */
72         struct pjsip_transport *transport;
73         /*! \brief Transport factory */
74         struct pjsip_tpfactory *factory;
75         /*!
76          * Transport id
77          * \since 13.8.0
78          */
79         char *id;
80         /*!
81          * Transport type
82          * \since 13.8.0
83          */
84         enum ast_transport type;
85         /*!
86          * Address and port to bind to
87          * \since 13.8.0
88          */
89         pj_sockaddr host;
90         /*!
91          * TLS settings
92          * \since 13.8.0
93          */
94         pjsip_tls_setting tls;
95         /*!
96          * Configured TLS ciphers
97          * \since 13.8.0
98          */
99         pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
100         /*!
101          * Optional local network information, used for NAT purposes.
102          * "deny" (set) means that it's in the local network. Use the
103          * ast_sip_transport_is_nonlocal and ast_sip_transport_is_local
104          * macro's.
105          * \since 13.8.0
106          */
107         struct ast_ha *localnet;
108         /*!
109          * DNS manager for refreshing the external signaling address
110          * \since 13.8.0
111          */
112         struct ast_dnsmgr_entry *external_signaling_address_refresher;
113         /*!
114          * Optional external signaling address information
115          * \since 13.8.0
116          */
117         struct ast_sockaddr external_signaling_address;
118         /*!
119          * DNS manager for refreshing the external media address
120          * \since 13.18.0
121          */
122         struct ast_dnsmgr_entry *external_media_address_refresher;
123         /*!
124          * Optional external signaling address information
125          * \since 13.18.0
126          */
127         struct ast_sockaddr external_media_address;
128 };
129
130 #define ast_sip_transport_is_nonlocal(transport_state, addr) \
131         (!transport_state->localnet || ast_apply_ha(transport_state->localnet, addr) == AST_SENSE_ALLOW)
132
133 #define ast_sip_transport_is_local(transport_state, addr) \
134         (transport_state->localnet && ast_apply_ha(transport_state->localnet, addr) != AST_SENSE_ALLOW)
135
136 /*
137  * \brief Transport to bind to
138  */
139 struct ast_sip_transport {
140         /*! Sorcery object details */
141         SORCERY_OBJECT(details);
142         AST_DECLARE_STRING_FIELDS(
143                 /*! Certificate of authority list file */
144                 AST_STRING_FIELD(ca_list_file);
145                 /*! Certificate of authority list path */
146                 AST_STRING_FIELD(ca_list_path);
147                 /*! Public certificate file */
148                 AST_STRING_FIELD(cert_file);
149                 /*! Optional private key of the certificate file */
150                 AST_STRING_FIELD(privkey_file);
151                 /*! Password to open the private key */
152                 AST_STRING_FIELD(password);
153                 /*! External signaling address */
154                 AST_STRING_FIELD(external_signaling_address);
155                 /*! External media address */
156                 AST_STRING_FIELD(external_media_address);
157                 /*! Optional domain to use for messages if provided could not be found */
158                 AST_STRING_FIELD(domain);
159                 );
160         /*! Type of transport */
161         enum ast_transport type;
162         /*!
163          * \deprecated Moved to ast_sip_transport_state
164          * \version 13.8.0 deprecated
165          * Address and port to bind to
166          */
167         pj_sockaddr host;
168         /*! Number of simultaneous asynchronous operations */
169         unsigned int async_operations;
170         /*! Optional external port for signaling */
171         unsigned int external_signaling_port;
172         /*!
173          * \deprecated Moved to ast_sip_transport_state
174          * \version 13.7.1 deprecated
175          * TLS settings
176          */
177         pjsip_tls_setting tls;
178         /*!
179          * \deprecated Moved to ast_sip_transport_state
180          * \version 13.7.1 deprecated
181          * Configured TLS ciphers
182          */
183         pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
184         /*!
185          * \deprecated Moved to ast_sip_transport_state
186          * \version 13.7.1 deprecated
187          * Optional local network information, used for NAT purposes
188          */
189         struct ast_ha *localnet;
190         /*!
191          * \deprecated Moved to ast_sip_transport_state
192          * \version 13.7.1 deprecated
193          * DNS manager for refreshing the external address
194          */
195         struct ast_dnsmgr_entry *external_address_refresher;
196         /*!
197          * \deprecated Moved to ast_sip_transport_state
198          * \version 13.7.1 deprecated
199          * Optional external address information
200          */
201         struct ast_sockaddr external_address;
202         /*!
203          * \deprecated
204          * \version 13.7.1 deprecated
205          * Transport state information
206          */
207         struct ast_sip_transport_state *state;
208         /*! QOS DSCP TOS bits */
209         unsigned int tos;
210         /*! QOS COS value */
211         unsigned int cos;
212         /*! Write timeout */
213         int write_timeout;
214         /*! Allow reload */
215         int allow_reload;
216         /*! Automatically send requests out the same transport requests have come in on */
217         int symmetric_transport;
218 };
219
220 #define SIP_SORCERY_DOMAIN_ALIAS_TYPE "domain_alias"
221
222 /*!
223  * Details about a SIP domain alias
224  */
225 struct ast_sip_domain_alias {
226         /*! Sorcery object details */
227         SORCERY_OBJECT(details);
228         AST_DECLARE_STRING_FIELDS(
229                 /*! Domain to be aliased to */
230                 AST_STRING_FIELD(domain);
231         );
232 };
233
234 /*!
235  * \brief Structure for SIP nat hook information
236  */
237 struct ast_sip_nat_hook {
238         /*! Sorcery object details */
239         SORCERY_OBJECT(details);
240         /*! Callback for when a message is going outside of our local network */
241         void (*outgoing_external_message)(struct pjsip_tx_data *tdata, struct ast_sip_transport *transport);
242 };
243
244 /*!
245  * \brief Contact associated with an address of record
246  */
247 struct ast_sip_contact {
248         /*! Sorcery object details, the id is the aor name plus a random string */
249         SORCERY_OBJECT(details);
250         AST_DECLARE_STRING_FIELDS(
251                 /*! Full URI of the contact */
252                 AST_STRING_FIELD(uri);
253                 /*! Outbound proxy to use for qualify */
254                 AST_STRING_FIELD(outbound_proxy);
255                 /*! Path information to place in Route headers */
256                 AST_STRING_FIELD(path);
257                 /*! Content of the User-Agent header in REGISTER request */
258                 AST_STRING_FIELD(user_agent);
259                 /*! The name of the aor this contact belongs to */
260                 AST_STRING_FIELD(aor);
261                 /*! Asterisk Server name */
262                 AST_STRING_FIELD(reg_server);
263                 /*! IP-address of the Via header in REGISTER request */
264                 AST_STRING_FIELD(via_addr);
265                 /*! Content of the Call-ID header in REGISTER request */
266                 AST_STRING_FIELD(call_id);
267                 /*! The name of the endpoint that added the contact */
268                 AST_STRING_FIELD(endpoint_name);
269         );
270         /*! Absolute time that this contact is no longer valid after */
271         struct timeval expiration_time;
272         /*! Frequency to send OPTIONS requests to contact. 0 is disabled. */
273         unsigned int qualify_frequency;
274         /*! If true authenticate the qualify challenge response if needed */
275         int authenticate_qualify;
276         /*! Qualify timeout. 0 is diabled. */
277         double qualify_timeout;
278         /*! Endpoint that added the contact, only available in observers */
279         struct ast_sip_endpoint *endpoint;
280         /*! Port of the Via header in REGISTER request */
281         int via_port;
282         /*! If true delete the contact on Asterisk restart/boot */
283         int prune_on_boot;
284 };
285
286 /*!
287  * \brief Status type for a contact.
288  */
289 enum ast_sip_contact_status_type {
290         /*! Frequency > 0, but no response from remote uri */
291         UNAVAILABLE,
292         /*! Frequency > 0, and got response from remote uri */
293         AVAILABLE,
294         /*! Default last status, and when a contact status object is not found */
295         UNKNOWN,
296         /*! Frequency == 0, has a contact, but don't know status (non-qualified) */
297         CREATED,
298         REMOVED,
299 };
300
301 /*!
302  * \brief A contact's status.
303  *
304  * \detail Maintains a contact's current status and round trip time
305  *         if available.
306  */
307 struct ast_sip_contact_status {
308         AST_DECLARE_STRING_FIELDS(
309                 /*! The original contact's URI */
310                 AST_STRING_FIELD(uri);
311                 /*! The name of the aor this contact_status belongs to */
312                 AST_STRING_FIELD(aor);
313         );
314         /*! The round trip time in microseconds */
315         int64_t rtt;
316         /*! Current status for a contact (default - unavailable) */
317         enum ast_sip_contact_status_type status;
318         /*! Last status for a contact (default - unavailable) */
319         enum ast_sip_contact_status_type last_status;
320         /*! Name of the contact */
321         char name[0];
322 };
323
324 /*!
325  * \brief A SIP address of record
326  */
327 struct ast_sip_aor {
328         /*! Sorcery object details, the id is the AOR name */
329         SORCERY_OBJECT(details);
330         AST_DECLARE_STRING_FIELDS(
331                 /*! Voicemail boxes for this AOR */
332                 AST_STRING_FIELD(mailboxes);
333                 /*! Outbound proxy for OPTIONS requests */
334                 AST_STRING_FIELD(outbound_proxy);
335         );
336         /*! Minimum expiration time */
337         unsigned int minimum_expiration;
338         /*! Maximum expiration time */
339         unsigned int maximum_expiration;
340         /*! Default contact expiration if one is not provided in the contact */
341         unsigned int default_expiration;
342         /*! Frequency to send OPTIONS requests to AOR contacts. 0 is disabled. */
343         unsigned int qualify_frequency;
344         /*! If true authenticate the qualify challenge response if needed */
345         int authenticate_qualify;
346         /*! Maximum number of external contacts, 0 to disable */
347         unsigned int max_contacts;
348         /*! Whether to remove any existing contacts not related to an incoming REGISTER when it comes in */
349         unsigned int remove_existing;
350         /*! Any permanent configured contacts */
351         struct ao2_container *permanent_contacts;
352         /*! Determines whether SIP Path headers are supported */
353         unsigned int support_path;
354         /*! Qualify timeout. 0 is diabled. */
355         double qualify_timeout;
356         /* Voicemail extension to set in Message-Account */
357         char *voicemail_extension;
358 };
359
360 /*!
361  * \brief A wrapper for contact that adds the aor_id and
362  * a consistent contact id.  Used by ast_sip_for_each_contact.
363  */
364 struct ast_sip_contact_wrapper {
365         /*! The id of the parent aor. */
366         char *aor_id;
367         /*! The id of contact in form of aor_id/contact_uri. */
368         char *contact_id;
369         /*! Pointer to the actual contact. */
370         struct ast_sip_contact *contact;
371 };
372
373 /*!
374  * \brief DTMF modes for SIP endpoints
375  */
376 enum ast_sip_dtmf_mode {
377         /*! No DTMF to be used */
378         AST_SIP_DTMF_NONE,
379         /* XXX Should this be 2833 instead? */
380         /*! Use RFC 4733 events for DTMF */
381         AST_SIP_DTMF_RFC_4733,
382         /*! Use DTMF in the audio stream */
383         AST_SIP_DTMF_INBAND,
384         /*! Use SIP INFO DTMF (blech) */
385         AST_SIP_DTMF_INFO,
386         /*! Use SIP 4733 if supported by the other side or INBAND if not */
387         AST_SIP_DTMF_AUTO,
388         /*! Use SIP 4733 if supported by the other side or INFO DTMF (blech) if not */
389         AST_SIP_DTMF_AUTO_INFO,
390 };
391
392 /*!
393  * \brief Methods of storing SIP digest authentication credentials.
394  *
395  * Note that both methods result in MD5 digest authentication being
396  * used. The two methods simply alter how Asterisk determines the
397  * credentials for a SIP authentication
398  */
399 enum ast_sip_auth_type {
400         /*! Credentials stored as a username and password combination */
401         AST_SIP_AUTH_TYPE_USER_PASS,
402         /*! Credentials stored as an MD5 sum */
403         AST_SIP_AUTH_TYPE_MD5,
404         /*! Credentials not stored this is a fake auth */
405         AST_SIP_AUTH_TYPE_ARTIFICIAL
406 };
407
408 #define SIP_SORCERY_AUTH_TYPE "auth"
409
410 struct ast_sip_auth {
411         /*! Sorcery ID of the auth is its name */
412         SORCERY_OBJECT(details);
413         AST_DECLARE_STRING_FIELDS(
414                 /*! Identification for these credentials */
415                 AST_STRING_FIELD(realm);
416                 /*! Authentication username */
417                 AST_STRING_FIELD(auth_user);
418                 /*! Authentication password */
419                 AST_STRING_FIELD(auth_pass);
420                 /*! Authentication credentials in MD5 format (hash of user:realm:pass) */
421                 AST_STRING_FIELD(md5_creds);
422         );
423         /*! The time period (in seconds) that a nonce may be reused */
424         unsigned int nonce_lifetime;
425         /*! Used to determine what to use when authenticating */
426         enum ast_sip_auth_type type;
427 };
428
429 AST_VECTOR(ast_sip_auth_vector, const char *);
430
431 /*!
432  * \brief Different methods by which incoming requests can be matched to endpoints
433  */
434 enum ast_sip_endpoint_identifier_type {
435         /*! Identify based on user name in From header */
436         AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME = (1 << 0),
437         /*! Identify based on user name in Auth header first, then From header */
438         AST_SIP_ENDPOINT_IDENTIFY_BY_AUTH_USERNAME = (1 << 1),
439         /*! Identify based on source IP address */
440         AST_SIP_ENDPOINT_IDENTIFY_BY_IP = (1 << 2),
441         /*! Identify based on arbitrary headers */
442         AST_SIP_ENDPOINT_IDENTIFY_BY_HEADER = (1 << 3),
443 };
444 AST_VECTOR(ast_sip_identify_by_vector, enum ast_sip_endpoint_identifier_type);
445
446 enum ast_sip_session_refresh_method {
447         /*! Use reinvite to negotiate direct media */
448         AST_SIP_SESSION_REFRESH_METHOD_INVITE,
449         /*! Use UPDATE to negotiate direct media */
450         AST_SIP_SESSION_REFRESH_METHOD_UPDATE,
451 };
452
453 enum ast_sip_direct_media_glare_mitigation {
454         /*! Take no special action to mitigate reinvite glare */
455         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE,
456         /*! Do not send an initial direct media session refresh on outgoing call legs
457          * Subsequent session refreshes will be sent no matter the session direction
458          */
459         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING,
460         /*! Do not send an initial direct media session refresh on incoming call legs
461          * Subsequent session refreshes will be sent no matter the session direction
462          */
463         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING,
464 };
465
466 enum ast_sip_session_media_encryption {
467         /*! Invalid media encryption configuration */
468         AST_SIP_MEDIA_TRANSPORT_INVALID = 0,
469         /*! Do not allow any encryption of session media */
470         AST_SIP_MEDIA_ENCRYPT_NONE,
471         /*! Offer SDES-encrypted session media */
472         AST_SIP_MEDIA_ENCRYPT_SDES,
473         /*! Offer encrypted session media with datagram TLS key exchange */
474         AST_SIP_MEDIA_ENCRYPT_DTLS,
475 };
476
477 enum ast_sip_session_redirect {
478         /*! User portion of the target URI should be used as the target in the dialplan */
479         AST_SIP_REDIRECT_USER = 0,
480         /*! Target URI should be used as the target in the dialplan */
481         AST_SIP_REDIRECT_URI_CORE,
482         /*! Target URI should be used as the target within chan_pjsip itself */
483         AST_SIP_REDIRECT_URI_PJSIP,
484 };
485
486 /*!
487  * \brief Session timers options
488  */
489 struct ast_sip_timer_options {
490         /*! Minimum session expiration period, in seconds */
491         unsigned int min_se;
492         /*! Session expiration period, in seconds */
493         unsigned int sess_expires;
494 };
495
496 /*!
497  * \brief Endpoint configuration for SIP extensions.
498  *
499  * SIP extensions, in this case refers to features
500  * indicated in Supported or Required headers.
501  */
502 struct ast_sip_endpoint_extensions {
503         /*! Enabled SIP extensions */
504         unsigned int flags;
505         /*! Timer options */
506         struct ast_sip_timer_options timer;
507 };
508
509 /*!
510  * \brief Endpoint configuration for unsolicited MWI
511  */
512 struct ast_sip_mwi_configuration {
513         AST_DECLARE_STRING_FIELDS(
514                 /*! Configured voicemail boxes for this endpoint. Used for MWI */
515                 AST_STRING_FIELD(mailboxes);
516                 /*! Username to use when sending MWI NOTIFYs to this endpoint */
517                 AST_STRING_FIELD(fromuser);
518         );
519         /* Should mailbox states be combined into a single notification? */
520         unsigned int aggregate;
521         /* Should a subscribe replace unsolicited notifies? */
522         unsigned int subscribe_replaces_unsolicited;
523         /* Voicemail extension to set in Message-Account */
524         char *voicemail_extension;
525 };
526
527 /*!
528  * \brief Endpoint subscription configuration
529  */
530 struct ast_sip_endpoint_subscription_configuration {
531         /*! Indicates if endpoint is allowed to initiate subscriptions */
532         unsigned int allow;
533         /*! The minimum allowed expiration for subscriptions from endpoint */
534         unsigned int minexpiry;
535         /*! Message waiting configuration */
536         struct ast_sip_mwi_configuration mwi;
537         /* Context for SUBSCRIBE requests */
538         char context[AST_MAX_CONTEXT];
539 };
540
541 /*!
542  * \brief NAT configuration options for endpoints
543  */
544 struct ast_sip_endpoint_nat_configuration {
545         /*! Whether to force using the source IP address/port for sending responses */
546         unsigned int force_rport;
547         /*! Whether to rewrite the Contact header with the source IP address/port or not */
548         unsigned int rewrite_contact;
549 };
550
551 /*!
552  * \brief Party identification options for endpoints
553  *
554  * This includes caller ID, connected line, and redirecting-related options
555  */
556 struct ast_sip_endpoint_id_configuration {
557         struct ast_party_id self;
558         /*! Do we accept identification information from this endpoint */
559         unsigned int trust_inbound;
560         /*! Do we send private identification information to this endpoint? */
561         unsigned int trust_outbound;
562         /*! Do we send P-Asserted-Identity headers to this endpoint? */
563         unsigned int send_pai;
564         /*! Do we send Remote-Party-ID headers to this endpoint? */
565         unsigned int send_rpid;
566         /*! Do we send messages for connected line updates for unanswered incoming calls immediately to this endpoint? */
567         unsigned int rpid_immediate;
568         /*! Do we add Diversion headers to applicable outgoing requests/responses? */
569         unsigned int send_diversion;
570         /*! When performing connected line update, which method should be used */
571         enum ast_sip_session_refresh_method refresh_method;
572 };
573
574 /*!
575  * \brief Call pickup configuration options for endpoints
576  */
577 struct ast_sip_endpoint_pickup_configuration {
578         /*! Call group */
579         ast_group_t callgroup;
580         /*! Pickup group */
581         ast_group_t pickupgroup;
582         /*! Named call group */
583         struct ast_namedgroups *named_callgroups;
584         /*! Named pickup group */
585         struct ast_namedgroups *named_pickupgroups;
586 };
587
588 /*!
589  * \brief Configuration for one-touch INFO recording
590  */
591 struct ast_sip_info_recording_configuration {
592         AST_DECLARE_STRING_FIELDS(
593                 /*! Feature to enact when one-touch recording INFO with Record: On is received */
594                 AST_STRING_FIELD(onfeature);
595                 /*! Feature to enact when one-touch recording INFO with Record: Off is received */
596                 AST_STRING_FIELD(offfeature);
597         );
598         /*! Is one-touch recording permitted? */
599         unsigned int enabled;
600 };
601
602 /*!
603  * \brief Endpoint configuration options for INFO packages
604  */
605 struct ast_sip_endpoint_info_configuration {
606         /*! Configuration for one-touch recording */
607         struct ast_sip_info_recording_configuration recording;
608 };
609
610 /*!
611  * \brief RTP configuration for SIP endpoints
612  */
613 struct ast_sip_media_rtp_configuration {
614         AST_DECLARE_STRING_FIELDS(
615                 /*! Configured RTP engine for this endpoint. */
616                 AST_STRING_FIELD(engine);
617         );
618         /*! Whether IPv6 RTP is enabled or not */
619         unsigned int ipv6;
620         /*! Whether symmetric RTP is enabled or not */
621         unsigned int symmetric;
622         /*! Whether ICE support is enabled or not */
623         unsigned int ice_support;
624         /*! Whether to use the "ptime" attribute received from the endpoint or not */
625         unsigned int use_ptime;
626         /*! Do we use AVPF exclusively for this endpoint? */
627         unsigned int use_avpf;
628         /*! Do we force AVP, AVPF, SAVP, or SAVPF even for DTLS media streams? */
629         unsigned int force_avp;
630         /*! Do we use the received media transport in our answer SDP */
631         unsigned int use_received_transport;
632         /*! \brief DTLS-SRTP configuration information */
633         struct ast_rtp_dtls_cfg dtls_cfg;
634         /*! Should SRTP use a 32 byte tag instead of an 80 byte tag? */
635         unsigned int srtp_tag_32;
636         /*! Do we use media encryption? what type? */
637         enum ast_sip_session_media_encryption encryption;
638         /*! Do we want to optimistically support encryption if possible? */
639         unsigned int encryption_optimistic;
640         /*! Number of seconds between RTP keepalive packets */
641         unsigned int keepalive;
642         /*! Number of seconds before terminating channel due to lack of RTP (when not on hold) */
643         unsigned int timeout;
644         /*! Number of seconds before terminating channel due to lack of RTP (when on hold) */
645         unsigned int timeout_hold;
646         /*! Follow forked media with a different To tag */
647         unsigned int follow_early_media_fork;
648         /*! Accept updated SDPs on non-100rel 18X and 2XX responses with the same To tag */
649         unsigned int accept_multiple_sdp_answers;
650 };
651
652 /*!
653  * \brief Direct media options for SIP endpoints
654  */
655 struct ast_sip_direct_media_configuration {
656         /*! Boolean indicating if direct_media is permissible */
657         unsigned int enabled;
658         /*! When using direct media, which method should be used */
659         enum ast_sip_session_refresh_method method;
660         /*! Take steps to mitigate glare for direct media */
661         enum ast_sip_direct_media_glare_mitigation glare_mitigation;
662         /*! Do not attempt direct media session refreshes if a media NAT is detected */
663         unsigned int disable_on_nat;
664 };
665
666 struct ast_sip_t38_configuration {
667         /*! Whether T.38 UDPTL support is enabled or not */
668         unsigned int enabled;
669         /*! Error correction setting for T.38 UDPTL */
670         enum ast_t38_ec_modes error_correction;
671         /*! Explicit T.38 max datagram value, may be 0 to indicate the remote side can be trusted */
672         unsigned int maxdatagram;
673         /*! Whether NAT Support is enabled for T.38 UDPTL sessions or not */
674         unsigned int nat;
675         /*! Whether to use IPv6 for UDPTL or not */
676         unsigned int ipv6;
677 };
678
679 /*!
680  * \brief Media configuration for SIP endpoints
681  */
682 struct ast_sip_endpoint_media_configuration {
683         AST_DECLARE_STRING_FIELDS(
684                 /*! Optional media address to use in SDP */
685                 AST_STRING_FIELD(address);
686                 /*! SDP origin username */
687                 AST_STRING_FIELD(sdpowner);
688                 /*! SDP session name */
689                 AST_STRING_FIELD(sdpsession);
690         );
691         /*! RTP media configuration */
692         struct ast_sip_media_rtp_configuration rtp;
693         /*! Direct media options */
694         struct ast_sip_direct_media_configuration direct_media;
695         /*! T.38 (FoIP) options */
696         struct ast_sip_t38_configuration t38;
697         /*! Configured codecs */
698         struct ast_format_cap *codecs;
699         /*! Capabilities in topology form */
700         struct ast_stream_topology *topology;
701         /*! DSCP TOS bits for audio streams */
702         unsigned int tos_audio;
703         /*! Priority for audio streams */
704         unsigned int cos_audio;
705         /*! DSCP TOS bits for video streams */
706         unsigned int tos_video;
707         /*! Priority for video streams */
708         unsigned int cos_video;
709         /*! Is g.726 packed in a non standard way */
710         unsigned int g726_non_standard;
711         /*! Bind the RTP instance to the media_address */
712         unsigned int bind_rtp_to_media_address;
713         /*! Use RTCP-MUX */
714         unsigned int rtcp_mux;
715         /*! Maximum number of audio streams to offer/accept */
716         unsigned int max_audio_streams;
717         /*! Maximum number of video streams to offer/accept */
718         unsigned int max_video_streams;
719         /*! Use BUNDLE */
720         unsigned int bundle;
721         /*! Enable webrtc settings and defaults */
722         unsigned int webrtc;
723 };
724
725 /*!
726  * \brief An entity with which Asterisk communicates
727  */
728 struct ast_sip_endpoint {
729         SORCERY_OBJECT(details);
730         AST_DECLARE_STRING_FIELDS(
731                 /*! Context to send incoming calls to */
732                 AST_STRING_FIELD(context);
733                 /*! Name of an explicit transport to use */
734                 AST_STRING_FIELD(transport);
735                 /*! Outbound proxy to use */
736                 AST_STRING_FIELD(outbound_proxy);
737                 /*! Explicit AORs to dial if none are specified */
738                 AST_STRING_FIELD(aors);
739                 /*! Musiconhold class to suggest that the other side use when placing on hold */
740                 AST_STRING_FIELD(mohsuggest);
741                 /*! Configured tone zone for this endpoint. */
742                 AST_STRING_FIELD(zone);
743                 /*! Configured language for this endpoint. */
744                 AST_STRING_FIELD(language);
745                 /*! Default username to place in From header */
746                 AST_STRING_FIELD(fromuser);
747                 /*! Domain to place in From header */
748                 AST_STRING_FIELD(fromdomain);
749                 /*! Context to route incoming MESSAGE requests to */
750                 AST_STRING_FIELD(message_context);
751                 /*! Accountcode to auto-set on channels */
752                 AST_STRING_FIELD(accountcode);
753                 /*! If set, we'll push incoming MWI NOTIFYs to stasis using this mailbox */
754                 AST_STRING_FIELD(incoming_mwi_mailbox);
755         );
756         /*! Configuration for extensions */
757         struct ast_sip_endpoint_extensions extensions;
758         /*! Configuration relating to media */
759         struct ast_sip_endpoint_media_configuration media;
760         /*! SUBSCRIBE/NOTIFY configuration options */
761         struct ast_sip_endpoint_subscription_configuration subscription;
762         /*! NAT configuration */
763         struct ast_sip_endpoint_nat_configuration nat;
764         /*! Party identification options */
765         struct ast_sip_endpoint_id_configuration id;
766         /*! Configuration options for INFO packages */
767         struct ast_sip_endpoint_info_configuration info;
768         /*! Call pickup configuration */
769         struct ast_sip_endpoint_pickup_configuration pickup;
770         /*! Inbound authentication credentials */
771         struct ast_sip_auth_vector inbound_auths;
772         /*! Outbound authentication credentials */
773         struct ast_sip_auth_vector outbound_auths;
774         /*! DTMF mode to use with this endpoint */
775         enum ast_sip_dtmf_mode dtmf;
776         /*! Method(s) by which the endpoint should be identified. */
777         enum ast_sip_endpoint_identifier_type ident_method;
778         /*! Order of the method(s) by which the endpoint should be identified. */
779         struct ast_sip_identify_by_vector ident_method_order;
780         /*! Boolean indicating if ringing should be sent as inband progress */
781         unsigned int inband_progress;
782         /*! Pointer to the persistent Asterisk endpoint */
783         struct ast_endpoint *persistent;
784         /*! The number of channels at which busy device state is returned */
785         unsigned int devicestate_busy_at;
786         /*! Whether fax detection is enabled or not (CNG tone detection) */
787         unsigned int faxdetect;
788         /*! Determines if transfers (using REFER) are allowed by this endpoint */
789         unsigned int allowtransfer;
790         /*! Method used when handling redirects */
791         enum ast_sip_session_redirect redirect_method;
792         /*! Variables set on channel creation */
793         struct ast_variable *channel_vars;
794         /*! Whether to place a 'user=phone' parameter into the request URI if user is a number */
795         unsigned int usereqphone;
796         /*! Whether to pass through hold and unhold using re-invites with recvonly and sendrecv */
797         unsigned int moh_passthrough;
798         /*! Access control list */
799         struct ast_acl_list *acl;
800         /*! Restrict what IPs are allowed in the Contact header (for registration) */
801         struct ast_acl_list *contact_acl;
802         /*! The number of seconds into call to disable fax detection.  (0 = disabled) */
803         unsigned int faxdetect_timeout;
804         /*! Override the user on the outgoing Contact header with this value. */
805         char *contact_user;
806         /*! Whether to response SDP offer with single most preferred codec. */
807         unsigned int preferred_codec_only;
808         /*! Do we allow an asymmetric RTP codec? */
809         unsigned int asymmetric_rtp_codec;
810         /*! Do we allow overlap dialling? */
811         unsigned int allow_overlap;
812         /*! Whether to notifies all the progress details on blind transfer */
813         unsigned int refer_blind_progress;
814         /*! Whether to notifies dialog-info 'early' on INUSE && RINGING state */
815         unsigned int notify_early_inuse_ringing;
816         /*! Suppress Q.850 Reason headers on this endpoint */
817         unsigned int suppress_q850_reason_headers;
818 };
819
820 /*! URI parameter for symmetric transport */
821 #define AST_SIP_X_AST_TXP "x-ast-txp"
822 #define AST_SIP_X_AST_TXP_LEN 9
823
824 /*!
825  * \brief Initialize an auth vector with the configured values.
826  *
827  * \param vector Vector to initialize
828  * \param auth_names Comma-separated list of names to set in the array
829  * \retval 0 Success
830  * \retval non-zero Failure
831  */
832 int ast_sip_auth_vector_init(struct ast_sip_auth_vector *vector, const char *auth_names);
833
834 /*!
835  * \brief Free contents of an auth vector.
836  *
837  * \param array Vector whose contents are to be freed
838  */
839 void ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector);
840
841 /*!
842  * \brief Possible returns from ast_sip_check_authentication
843  */
844 enum ast_sip_check_auth_result {
845     /*! Authentication needs to be challenged */
846     AST_SIP_AUTHENTICATION_CHALLENGE,
847     /*! Authentication succeeded */
848     AST_SIP_AUTHENTICATION_SUCCESS,
849     /*! Authentication failed */
850     AST_SIP_AUTHENTICATION_FAILED,
851     /*! Authentication encountered some internal error */
852     AST_SIP_AUTHENTICATION_ERROR,
853 };
854
855 /*!
856  * \brief An interchangeable way of handling digest authentication for SIP.
857  *
858  * An authenticator is responsible for filling in the callbacks provided below. Each is called from a publicly available
859  * function in res_sip. The authenticator can use configuration or other local policy to determine whether authentication
860  * should take place and what credentials should be used when challenging and authenticating a request.
861  */
862 struct ast_sip_authenticator {
863     /*!
864      * \brief Check if a request requires authentication
865      * See ast_sip_requires_authentication for more details
866      */
867     int (*requires_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
868         /*!
869          * \brief Check that an incoming request passes authentication.
870          *
871          * The tdata parameter is useful for adding information such as digest challenges.
872          *
873          * \param endpoint The endpoint sending the incoming request
874          * \param rdata The incoming request
875          * \param tdata Tentative outgoing request.
876          */
877         enum ast_sip_check_auth_result (*check_authentication)(struct ast_sip_endpoint *endpoint,
878                         pjsip_rx_data *rdata, pjsip_tx_data *tdata);
879 };
880
881 /*!
882  * \brief an interchangeable way of responding to authentication challenges
883  *
884  * An outbound authenticator takes incoming challenges and formulates a new SIP request with
885  * credentials.
886  */
887 struct ast_sip_outbound_authenticator {
888         /*!
889          * \brief Create a new request with authentication credentials
890          *
891          * \param auths A vector of IDs of auth sorcery objects
892          * \param challenge The SIP response with authentication challenge(s)
893          * \param old_request The request that received the auth challenge(s)
894          * \param new_request The new SIP request with challenge response(s)
895          * \retval 0 Successfully created new request
896          * \retval -1 Failed to create a new request
897          */
898         int (*create_request_with_auth)(const struct ast_sip_auth_vector *auths, struct pjsip_rx_data *challenge,
899                         struct pjsip_tx_data *old_request, struct pjsip_tx_data **new_request);
900 };
901
902 /*!
903  * \brief An entity responsible for identifying the source of a SIP message
904  */
905 struct ast_sip_endpoint_identifier {
906     /*!
907      * \brief Callback used to identify the source of a message.
908      * See ast_sip_identify_endpoint for more details
909      */
910     struct ast_sip_endpoint *(*identify_endpoint)(pjsip_rx_data *rdata);
911 };
912
913 /*!
914  * \brief Contact retrieval filtering flags
915  */
916 enum ast_sip_contact_filter {
917         /*! \brief Default filter flags */
918         AST_SIP_CONTACT_FILTER_DEFAULT = 0,
919
920         /*! \brief Return only reachable or unknown contacts */
921         AST_SIP_CONTACT_FILTER_REACHABLE = (1 << 0),
922 };
923
924 /*!
925  * \brief Register a SIP service in Asterisk.
926  *
927  * This is more-or-less a wrapper around pjsip_endpt_register_module().
928  * Registering a service makes it so that PJSIP will call into the
929  * service at appropriate times. For more information about PJSIP module
930  * callbacks, see the PJSIP documentation. Asterisk modules that call
931  * this function will likely do so at module load time.
932  *
933  * \param module The module that is to be registered with PJSIP
934  * \retval 0 Success
935  * \retval -1 Failure
936  */
937 int ast_sip_register_service(pjsip_module *module);
938
939 /*!
940  * This is the opposite of ast_sip_register_service().  Unregistering a
941  * service means that PJSIP will no longer call into the module any more.
942  * This will likely occur when an Asterisk module is unloaded.
943  *
944  * \param module The PJSIP module to unregister
945  */
946 void ast_sip_unregister_service(pjsip_module *module);
947
948 /*!
949  * \brief Register a SIP authenticator
950  *
951  * An authenticator has three main purposes:
952  * 1) Determining if authentication should be performed on an incoming request
953  * 2) Gathering credentials necessary for issuing an authentication challenge
954  * 3) Authenticating a request that has credentials
955  *
956  * Asterisk provides a default authenticator, but it may be replaced by a
957  * custom one if desired.
958  *
959  * \param auth The authenticator to register
960  * \retval 0 Success
961  * \retval -1 Failure
962  */
963 int ast_sip_register_authenticator(struct ast_sip_authenticator *auth);
964
965 /*!
966  * \brief Unregister a SIP authenticator
967  *
968  * When there is no authenticator registered, requests cannot be challenged
969  * or authenticated.
970  *
971  * \param auth The authenticator to unregister
972  */
973 void ast_sip_unregister_authenticator(struct ast_sip_authenticator *auth);
974
975  /*!
976  * \brief Register an outbound SIP authenticator
977  *
978  * An outbound authenticator is responsible for creating responses to
979  * authentication challenges by remote endpoints.
980  *
981  * \param auth The authenticator to register
982  * \retval 0 Success
983  * \retval -1 Failure
984  */
985 int ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth);
986
987 /*!
988  * \brief Unregister an outbound SIP authenticator
989  *
990  * When there is no outbound authenticator registered, authentication challenges
991  * will be handled as any other final response would be.
992  *
993  * \param auth The authenticator to unregister
994  */
995 void ast_sip_unregister_outbound_authenticator(struct ast_sip_outbound_authenticator *auth);
996
997 /*!
998  * \brief Register a SIP endpoint identifier with a name.
999  *
1000  * An endpoint identifier's purpose is to determine which endpoint a given SIP
1001  * message has come from.
1002  *
1003  * Multiple endpoint identifiers may be registered so that if an endpoint
1004  * cannot be identified by one identifier, it may be identified by another.
1005  *
1006  * \param identifier The SIP endpoint identifier to register
1007  * \param name The name of the endpoint identifier
1008  * \retval 0 Success
1009  * \retval -1 Failure
1010  */
1011 int ast_sip_register_endpoint_identifier_with_name(struct ast_sip_endpoint_identifier *identifier,
1012                                                    const char *name);
1013
1014 /*!
1015  * \brief Register a SIP endpoint identifier
1016  *
1017  * An endpoint identifier's purpose is to determine which endpoint a given SIP
1018  * message has come from.
1019  *
1020  * Multiple endpoint identifiers may be registered so that if an endpoint
1021  * cannot be identified by one identifier, it may be identified by another.
1022  *
1023  * Asterisk provides two endpoint identifiers. One identifies endpoints based
1024  * on the user part of the From header URI. The other identifies endpoints based
1025  * on the source IP address.
1026  *
1027  * If the order in which endpoint identifiers is run is important to you, then
1028  * be sure to load individual endpoint identifier modules in the order you wish
1029  * for them to be run in modules.conf
1030  *
1031  * \note endpoint identifiers registered using this method (no name specified)
1032  *       are placed at the front of the endpoint identifiers list ahead of any
1033  *       named identifiers.
1034  *
1035  * \param identifier The SIP endpoint identifier to register
1036  * \retval 0 Success
1037  * \retval -1 Failure
1038  */
1039 int ast_sip_register_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
1040
1041 /*!
1042  * \brief Unregister a SIP endpoint identifier
1043  *
1044  * This stops an endpoint identifier from being used.
1045  *
1046  * \param identifier The SIP endoint identifier to unregister
1047  */
1048 void ast_sip_unregister_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
1049
1050 /*!
1051  * \brief Allocate a new SIP endpoint
1052  *
1053  * This will return an endpoint with its refcount increased by one. This reference
1054  * can be released using ao2_ref().
1055  *
1056  * \param name The name of the endpoint.
1057  * \retval NULL Endpoint allocation failed
1058  * \retval non-NULL The newly allocated endpoint
1059  */
1060 void *ast_sip_endpoint_alloc(const char *name);
1061
1062 /*!
1063  * \brief Change state of a persistent endpoint.
1064  *
1065  * \param endpoint_name The SIP endpoint name to change state.
1066  * \param state The new state
1067  * \retval 0 Success
1068  * \retval -1 Endpoint not found
1069  */
1070 int ast_sip_persistent_endpoint_update_state(const char *endpoint_name, enum ast_endpoint_state state);
1071
1072 /*!
1073  * \brief Publish the change of state for a contact.
1074  *
1075  * \param endpoint_name The SIP endpoint name.
1076  * \param contact_status The contact status.
1077  */
1078 void ast_sip_persistent_endpoint_publish_contact_state(const char *endpoint_name, const struct ast_sip_contact_status *contact_status);
1079
1080 /*!
1081  * \brief Retrieve the current status for a contact.
1082  *
1083  * \param contact The contact.
1084  *
1085  * \retval non-NULL Success
1086  * \retval NULL Status information not found
1087  *
1088  * \note The returned contact status object is immutable.
1089  */
1090 struct ast_sip_contact_status *ast_sip_get_contact_status(const struct ast_sip_contact *contact);
1091
1092 /*!
1093  * \brief Get a pointer to the PJSIP endpoint.
1094  *
1095  * This is useful when modules have specific information they need
1096  * to register with the PJSIP core.
1097  * \retval NULL endpoint has not been created yet.
1098  * \retval non-NULL PJSIP endpoint.
1099  */
1100 pjsip_endpoint *ast_sip_get_pjsip_endpoint(void);
1101
1102 /*!
1103  * \brief Get a pointer to the SIP sorcery structure.
1104  *
1105  * \retval NULL sorcery has not been initialized
1106  * \retval non-NULL sorcery structure
1107  */
1108 struct ast_sorcery *ast_sip_get_sorcery(void);
1109
1110 /*!
1111  * \brief Retrieve a named AOR
1112  *
1113  * \param aor_name Name of the AOR
1114  *
1115  * \retval NULL if not found
1116  * \retval non-NULL if found
1117  */
1118 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name);
1119
1120 /*!
1121  * \brief Retrieve the first bound contact for an AOR
1122  *
1123  * \param aor Pointer to the AOR
1124  * \retval NULL if no contacts available
1125  * \retval non-NULL if contacts available
1126  */
1127 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor);
1128
1129 /*!
1130  * \brief Retrieve the first bound contact for an AOR and filter based on flags
1131  * \since 13.16.0
1132  *
1133  * \param aor Pointer to the AOR
1134  * \param flags Filtering flags
1135  * \retval NULL if no contacts available
1136  * \retval non-NULL if contacts available
1137  */
1138 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact_filtered(const struct ast_sip_aor *aor,
1139         unsigned int flags);
1140
1141 /*!
1142  * \brief Retrieve all contacts currently available for an AOR
1143  *
1144  * \param aor Pointer to the AOR
1145  *
1146  * \retval NULL if no contacts available
1147  * \retval non-NULL if contacts available
1148  *
1149  * \warning
1150  * Since this function prunes expired contacts before returning, it holds a named write
1151  * lock on the aor.  If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.
1152  */
1153 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor);
1154
1155 /*!
1156  * \brief Retrieve all contacts currently available for an AOR and filter based on flags
1157  * \since 13.16.0
1158  *
1159  * \param aor Pointer to the AOR
1160  * \param flags Filtering flags
1161  *
1162  * \retval NULL if no contacts available
1163  * \retval non-NULL if contacts available
1164  *
1165  * \warning
1166  * Since this function prunes expired contacts before returning, it holds a named write
1167  * lock on the aor.  If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.
1168  */
1169 struct ao2_container *ast_sip_location_retrieve_aor_contacts_filtered(const struct ast_sip_aor *aor,
1170         unsigned int flags);
1171
1172 /*!
1173  * \brief Retrieve all contacts currently available for an AOR without locking the AOR
1174  * \since 13.9.0
1175  *
1176  * \param aor Pointer to the AOR
1177  *
1178  * \retval NULL if no contacts available
1179  * \retval non-NULL if contacts available
1180  *
1181  * \warning
1182  * This function should only be called if you already hold a named write lock on the aor.
1183  */
1184 struct ao2_container *ast_sip_location_retrieve_aor_contacts_nolock(const struct ast_sip_aor *aor);
1185
1186 /*!
1187  * \brief Retrieve all contacts currently available for an AOR without locking the AOR and filter based on flags
1188  * \since 13.16.0
1189  *
1190  * \param aor Pointer to the AOR
1191  * \param flags Filtering flags
1192  *
1193  * \retval NULL if no contacts available
1194  * \retval non-NULL if contacts available
1195  *
1196  * \warning
1197  * This function should only be called if you already hold a named write lock on the aor.
1198  */
1199 struct ao2_container *ast_sip_location_retrieve_aor_contacts_nolock_filtered(const struct ast_sip_aor *aor,
1200         unsigned int flags);
1201
1202 /*!
1203  * \brief Retrieve the first bound contact from a list of AORs
1204  *
1205  * \param aor_list A comma-separated list of AOR names
1206  * \retval NULL if no contacts available
1207  * \retval non-NULL if contacts available
1208  */
1209 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list);
1210
1211 /*!
1212  * \brief Retrieve all contacts from a list of AORs
1213  *
1214  * \param aor_list A comma-separated list of AOR names
1215  * \retval NULL if no contacts available
1216  * \retval non-NULL container (which must be freed) if contacts available
1217  */
1218 struct ao2_container *ast_sip_location_retrieve_contacts_from_aor_list(const char *aor_list);
1219
1220 /*!
1221  * \brief Retrieve the first bound contact AND the AOR chosen from a list of AORs
1222  *
1223  * \param aor_list A comma-separated list of AOR names
1224  * \param aor The chosen AOR
1225  * \param contact The chosen contact
1226  */
1227  void ast_sip_location_retrieve_contact_and_aor_from_list(const char *aor_list, struct ast_sip_aor **aor,
1228         struct ast_sip_contact **contact);
1229
1230 /*!
1231  * \brief Retrieve the first bound contact AND the AOR chosen from a list of AORs and filter based on flags
1232  * \since 13.16.0
1233  *
1234  * \param aor_list A comma-separated list of AOR names
1235  * \param flags Filtering flags
1236  * \param aor The chosen AOR
1237  * \param contact The chosen contact
1238  */
1239 void ast_sip_location_retrieve_contact_and_aor_from_list_filtered(const char *aor_list, unsigned int flags,
1240         struct ast_sip_aor **aor, struct ast_sip_contact **contact);
1241
1242 /*!
1243  * \brief Retrieve a named contact
1244  *
1245  * \param contact_name Name of the contact
1246  *
1247  * \retval NULL if not found
1248  * \retval non-NULL if found
1249  */
1250 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name);
1251
1252 /*!
1253  * \brief Add a new contact to an AOR
1254  *
1255  * \param aor Pointer to the AOR
1256  * \param uri Full contact URI
1257  * \param expiration_time Optional expiration time of the contact
1258  * \param path_info Path information
1259  * \param user_agent User-Agent header from REGISTER request
1260  * \param via_addr
1261  * \param via_port
1262  * \param call_id
1263  * \param endpoint The endpoint that resulted in the contact being added
1264  *
1265  * \retval -1 failure
1266  * \retval 0 success
1267  *
1268  * \warning
1269  * This function holds a named write lock on the aor.  If you already hold the lock
1270  * you should call ast_sip_location_add_contact_nolock instead.
1271  */
1272 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri,
1273         struct timeval expiration_time, const char *path_info, const char *user_agent,
1274         const char *via_addr, int via_port, const char *call_id,
1275         struct ast_sip_endpoint *endpoint);
1276
1277 /*!
1278  * \brief Add a new contact to an AOR without locking the AOR
1279  * \since 13.9.0
1280  *
1281  * \param aor Pointer to the AOR
1282  * \param uri Full contact URI
1283  * \param expiration_time Optional expiration time of the contact
1284  * \param path_info Path information
1285  * \param user_agent User-Agent header from REGISTER request
1286  * \param via_addr
1287  * \param via_port
1288  * \param call_id
1289  * \param endpoint The endpoint that resulted in the contact being added
1290  *
1291  * \retval -1 failure
1292  * \retval 0 success
1293  *
1294  * \warning
1295  * This function should only be called if you already hold a named write lock on the aor.
1296  */
1297 int ast_sip_location_add_contact_nolock(struct ast_sip_aor *aor, const char *uri,
1298         struct timeval expiration_time, const char *path_info, const char *user_agent,
1299         const char *via_addr, int via_port, const char *call_id,
1300         struct ast_sip_endpoint *endpoint);
1301
1302 /*!
1303  * \brief Create a new contact for an AOR without locking the AOR
1304  * \since 13.18.0
1305  *
1306  * \param aor Pointer to the AOR
1307  * \param uri Full contact URI
1308  * \param expiration_time Optional expiration time of the contact
1309  * \param path_info Path information
1310  * \param user_agent User-Agent header from REGISTER request
1311  * \param via_addr
1312  * \param via_port
1313  * \param call_id
1314  * \param prune_on_boot Non-zero if the contact cannot survive a restart/boot.
1315  * \param endpoint The endpoint that resulted in the contact being added
1316  *
1317  * \return The created contact or NULL on failure.
1318  *
1319  * \warning
1320  * This function should only be called if you already hold a named write lock on the aor.
1321  */
1322 struct ast_sip_contact *ast_sip_location_create_contact(struct ast_sip_aor *aor,
1323         const char *uri, struct timeval expiration_time, const char *path_info,
1324         const char *user_agent, const char *via_addr, int via_port, const char *call_id,
1325         int prune_on_boot, struct ast_sip_endpoint *endpoint);
1326
1327 /*!
1328  * \brief Update a contact
1329  *
1330  * \param contact New contact object with details
1331  *
1332  * \retval -1 failure
1333  * \retval 0 success
1334  */
1335 int ast_sip_location_update_contact(struct ast_sip_contact *contact);
1336
1337 /*!
1338 * \brief Delete a contact
1339 *
1340 * \param contact Contact object to delete
1341 *
1342 * \retval -1 failure
1343 * \retval 0 success
1344 */
1345 int ast_sip_location_delete_contact(struct ast_sip_contact *contact);
1346
1347 /*!
1348  * \brief Prune the prune_on_boot contacts
1349  * \since 13.18.0
1350  */
1351 void ast_sip_location_prune_boot_contacts(void);
1352
1353 /*!
1354  * \brief Callback called when an outbound request with authentication credentials is to be sent in dialog
1355  *
1356  * This callback will have the created request on it. The callback's purpose is to do any extra
1357  * housekeeping that needs to be done as well as to send the request out.
1358  *
1359  * This callback is only necessary if working with a PJSIP API that sits between the application
1360  * and the dialog layer.
1361  *
1362  * \param dlg The dialog to which the request belongs
1363  * \param tdata The created request to be sent out
1364  * \param user_data Data supplied with the callback
1365  *
1366  * \retval 0 Success
1367  * \retval -1 Failure
1368  */
1369 typedef int (*ast_sip_dialog_outbound_auth_cb)(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data);
1370
1371 /*!
1372  * \brief Set up outbound authentication on a SIP dialog
1373  *
1374  * This sets up the infrastructure so that all requests associated with a created dialog
1375  * can be re-sent with authentication credentials if the original request is challenged.
1376  *
1377  * \param dlg The dialog on which requests will be authenticated
1378  * \param endpoint The endpoint whom this dialog pertains to
1379  * \param cb Callback to call to send requests with authentication
1380  * \param user_data Data to be provided to the callback when it is called
1381  *
1382  * \retval 0 Success
1383  * \retval -1 Failure
1384  */
1385 int ast_sip_dialog_setup_outbound_authentication(pjsip_dialog *dlg, const struct ast_sip_endpoint *endpoint,
1386                 ast_sip_dialog_outbound_auth_cb cb, void *user_data);
1387
1388 /*!
1389  * \brief Retrieves a reference to the artificial auth.
1390  *
1391  * \retval The artificial auth
1392  */
1393 struct ast_sip_auth *ast_sip_get_artificial_auth(void);
1394
1395 /*!
1396  * \brief Retrieves a reference to the artificial endpoint.
1397  *
1398  * \retval The artificial endpoint
1399  */
1400 struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void);
1401
1402 /*! \defgroup pjsip_threading PJSIP Threading Model
1403  * @{
1404  * \page PJSIP PJSIP Threading Model
1405  *
1406  * There are three major types of threads that SIP will have to deal with:
1407  * \li Asterisk threads
1408  * \li PJSIP threads
1409  * \li SIP threadpool threads (a.k.a. "servants")
1410  *
1411  * \par Asterisk Threads
1412  *
1413  * Asterisk threads are those that originate from outside of SIP but within
1414  * Asterisk. The most common of these threads are PBX (channel) threads and
1415  * the autoservice thread. Most interaction with these threads will be through
1416  * channel technology callbacks. Within these threads, it is fine to handle
1417  * Asterisk data from outside of SIP, but any handling of SIP data should be
1418  * left to servants, \b especially if you wish to call into PJSIP for anything.
1419  * Asterisk threads are not registered with PJLIB, so attempting to call into
1420  * PJSIP will cause an assertion to be triggered, thus causing the program to
1421  * crash.
1422  *
1423  * \par PJSIP Threads
1424  *
1425  * PJSIP threads are those that originate from handling of PJSIP events, such
1426  * as an incoming SIP request or response, or a transaction timeout. The role
1427  * of these threads is to process information as quickly as possible so that
1428  * the next item on the SIP socket(s) can be serviced. On incoming messages,
1429  * Asterisk automatically will push the request to a servant thread. When your
1430  * module callback is called, processing will already be in a servant. However,
1431  * for other PJSIP events, such as transaction state changes due to timer
1432  * expirations, your module will be called into from a PJSIP thread. If you
1433  * are called into from a PJSIP thread, then you should push whatever processing
1434  * is needed to a servant as soon as possible. You can discern if you are currently
1435  * in a SIP servant thread using the \ref ast_sip_thread_is_servant function.
1436  *
1437  * \par Servants
1438  *
1439  * Servants are where the bulk of SIP work should be performed. These threads
1440  * exist in order to do the work that Asterisk threads and PJSIP threads hand
1441  * off to them. Servant threads register themselves with PJLIB, meaning that
1442  * they are capable of calling PJSIP and PJLIB functions if they wish.
1443  *
1444  * \par Serializer
1445  *
1446  * Tasks are handed off to servant threads using the API call \ref ast_sip_push_task.
1447  * The first parameter of this call is a serializer. If this pointer
1448  * is NULL, then the work will be handed off to whatever servant can currently handle
1449  * the task. If this pointer is non-NULL, then the task will not be executed until
1450  * previous tasks pushed with the same serializer have completed. For more information
1451  * on serializers and the benefits they provide, see \ref ast_threadpool_serializer
1452  *
1453  * \par Scheduler
1454  *
1455  * Some situations require that a task run periodically or at a future time.  Normally
1456  * the ast_sched functionality would be used but ast_sched only uses 1 thread for all
1457  * tasks and that thread isn't registered with PJLIB and therefore can't do any PJSIP
1458  * related work.
1459  *
1460  * ast_sip_sched uses ast_sched only as a scheduled queue.  When a task is ready to run,
1461  * it's pushed to a Serializer to be invoked asynchronously by a Servant.  This ensures
1462  * that the task is executed in a PJLIB registered thread and allows the ast_sched thread
1463  * to immediately continue processing the queue.  The Serializer used by ast_sip_sched
1464  * is one of your choosing or a random one from the res_pjsip pool if you don't choose one.
1465  *
1466  * \note
1467  *
1468  * Do not make assumptions about individual threads based on a corresponding serializer.
1469  * In other words, just because several tasks use the same serializer when being pushed
1470  * to servants, it does not mean that the same thread is necessarily going to execute those
1471  * tasks, even though they are all guaranteed to be executed in sequence.
1472  */
1473
1474 typedef int (*ast_sip_task)(void *user_data);
1475
1476 /*!
1477  * \brief Create a new serializer for SIP tasks
1478  * \since 13.8.0
1479  *
1480  * See \ref ast_threadpool_serializer for more information on serializers.
1481  * SIP creates serializers so that tasks operating on similar data will run
1482  * in sequence.
1483  *
1484  * \param name Name of the serializer. (must be unique)
1485  *
1486  * \retval NULL Failure
1487  * \retval non-NULL Newly-created serializer
1488  */
1489 struct ast_taskprocessor *ast_sip_create_serializer(const char *name);
1490
1491 struct ast_serializer_shutdown_group;
1492
1493 /*!
1494  * \brief Create a new serializer for SIP tasks
1495  * \since 13.8.0
1496  *
1497  * See \ref ast_threadpool_serializer for more information on serializers.
1498  * SIP creates serializers so that tasks operating on similar data will run
1499  * in sequence.
1500  *
1501  * \param name Name of the serializer. (must be unique)
1502  * \param shutdown_group Group shutdown controller. (NULL if no group association)
1503  *
1504  * \retval NULL Failure
1505  * \retval non-NULL Newly-created serializer
1506  */
1507 struct ast_taskprocessor *ast_sip_create_serializer_group(const char *name, struct ast_serializer_shutdown_group *shutdown_group);
1508
1509 /*!
1510  * \brief Determine the distributor serializer for the SIP message.
1511  * \since 13.10.0
1512  *
1513  * \param rdata The incoming message.
1514  *
1515  * \retval Calculated distributor serializer on success.
1516  * \retval NULL on error.
1517  */
1518 struct ast_taskprocessor *ast_sip_get_distributor_serializer(pjsip_rx_data *rdata);
1519
1520 /*!
1521  * \brief Set a serializer on a SIP dialog so requests and responses are automatically serialized
1522  *
1523  * Passing a NULL serializer is a way to remove a serializer from a dialog.
1524  *
1525  * \param dlg The SIP dialog itself
1526  * \param serializer The serializer to use
1527  */
1528 void ast_sip_dialog_set_serializer(pjsip_dialog *dlg, struct ast_taskprocessor *serializer);
1529
1530 /*!
1531  * \brief Set an endpoint on a SIP dialog so in-dialog requests do not undergo endpoint lookup.
1532  *
1533  * \param dlg The SIP dialog itself
1534  * \param endpoint The endpoint that this dialog is communicating with
1535  */
1536 void ast_sip_dialog_set_endpoint(pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
1537
1538 /*!
1539  * \brief Get the endpoint associated with this dialog
1540  *
1541  * This function increases the refcount of the endpoint by one. Release
1542  * the reference once you are finished with the endpoint.
1543  *
1544  * \param dlg The SIP dialog from which to retrieve the endpoint
1545  * \retval NULL No endpoint associated with this dialog
1546  * \retval non-NULL The endpoint.
1547  */
1548 struct ast_sip_endpoint *ast_sip_dialog_get_endpoint(pjsip_dialog *dlg);
1549
1550 /*!
1551  * \brief Pushes a task to SIP servants
1552  *
1553  * This uses the serializer provided to determine how to push the task.
1554  * If the serializer is NULL, then the task will be pushed to the
1555  * servants directly. If the serializer is non-NULL, then the task will be
1556  * queued behind other tasks associated with the same serializer.
1557  *
1558  * \param serializer The serializer to which the task belongs. Can be NULL
1559  * \param sip_task The task to execute
1560  * \param task_data The parameter to pass to the task when it executes
1561  * \retval 0 Success
1562  * \retval -1 Failure
1563  */
1564 int ast_sip_push_task(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1565
1566 /*!
1567  * \brief Push a task to SIP servants and wait for it to complete.
1568  *
1569  * Like \ref ast_sip_push_task except that it blocks until the task
1570  * completes.  If the current thread is a SIP servant thread then the
1571  * task executes immediately.  Otherwise, the specified serializer
1572  * executes the task and the current thread waits for it to complete.
1573  *
1574  * \note PJPROJECT callbacks tend to have locks already held when
1575  * called.
1576  *
1577  * \warning \b Never hold locks that may be acquired by a SIP servant
1578  * thread when calling this function.  Doing so may cause a deadlock
1579  * if all SIP servant threads are blocked waiting to acquire the lock
1580  * while the thread holding the lock is waiting for a free SIP servant
1581  * thread.
1582  *
1583  * \warning \b Use of this function in an ao2 destructor callback is a
1584  * bad idea.  You don't have control over which thread executes the
1585  * destructor.  Attempting to shift execution to another thread with
1586  * this function is likely to cause deadlock.
1587  *
1588  * \param serializer The SIP serializer to execute the task if the
1589  * current thread is not a SIP servant.  NULL if any of the default
1590  * serializers can be used.
1591  * \param sip_task The task to execute
1592  * \param task_data The parameter to pass to the task when it executes
1593  *
1594  * \note The sip_task() return value may need to be distinguished from
1595  * the failure to push the task.
1596  *
1597  * \return sip_task() return value on success.
1598  * \retval -1 Failure to push the task.
1599  */
1600 int ast_sip_push_task_wait_servant(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1601
1602 /*!
1603  * \brief Push a task to SIP servants and wait for it to complete.
1604  * \deprecated Replaced with ast_sip_push_task_wait_servant().
1605  */
1606 int ast_sip_push_task_synchronous(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1607
1608 /*!
1609  * \brief Push a task to the serializer and wait for it to complete.
1610  *
1611  * Like \ref ast_sip_push_task except that it blocks until the task is
1612  * completed by the specified serializer.  If the specified serializer
1613  * is the current thread then the task executes immediately.
1614  *
1615  * \note PJPROJECT callbacks tend to have locks already held when
1616  * called.
1617  *
1618  * \warning \b Never hold locks that may be acquired by a SIP servant
1619  * thread when calling this function.  Doing so may cause a deadlock
1620  * if all SIP servant threads are blocked waiting to acquire the lock
1621  * while the thread holding the lock is waiting for a free SIP servant
1622  * thread for the serializer to execute in.
1623  *
1624  * \warning \b Never hold locks that may be acquired by the serializer
1625  * when calling this function.  Doing so will cause a deadlock.
1626  *
1627  * \warning \b Never use this function in the pjsip monitor thread (It
1628  * is a SIP servant thread).  This is likely to cause a deadlock.
1629  *
1630  * \warning \b Use of this function in an ao2 destructor callback is a
1631  * bad idea.  You don't have control over which thread executes the
1632  * destructor.  Attempting to shift execution to another thread with
1633  * this function is likely to cause deadlock.
1634  *
1635  * \param serializer The SIP serializer to execute the task.  NULL if
1636  * any of the default serializers can be used.
1637  * \param sip_task The task to execute
1638  * \param task_data The parameter to pass to the task when it executes
1639  *
1640  * \note It is generally better to call
1641  * ast_sip_push_task_wait_servant() if you pass NULL for the
1642  * serializer parameter.
1643  *
1644  * \note The sip_task() return value may need to be distinguished from
1645  * the failure to push the task.
1646  *
1647  * \return sip_task() return value on success.
1648  * \retval -1 Failure to push the task.
1649  */
1650 int ast_sip_push_task_wait_serializer(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1651
1652 /*!
1653  * \brief Determine if the current thread is a SIP servant thread
1654  *
1655  * \retval 0 This is not a SIP servant thread
1656  * \retval 1 This is a SIP servant thread
1657  */
1658 int ast_sip_thread_is_servant(void);
1659
1660 /*!
1661  * \brief Task flags for the res_pjsip scheduler
1662  *
1663  * The default is AST_SIP_SCHED_TASK_FIXED
1664  *                | AST_SIP_SCHED_TASK_DATA_NOT_AO2
1665  *                | AST_SIP_SCHED_TASK_DATA_NO_CLEANUP
1666  *                | AST_SIP_SCHED_TASK_PERIODIC
1667  */
1668 enum ast_sip_scheduler_task_flags {
1669         /*!
1670          * The defaults
1671          */
1672         AST_SIP_SCHED_TASK_DEFAULTS = (0 << 0),
1673
1674         /*!
1675          * Run at a fixed interval.
1676          * Stop scheduling if the callback returns <= 0.
1677          * Any other value is ignored.
1678          */
1679         AST_SIP_SCHED_TASK_FIXED = (0 << 0),
1680         /*!
1681          * Run at a variable interval.
1682          * Stop scheduling if the callback returns <= 0.
1683          * Any other return value is used as the new interval.
1684          */
1685         AST_SIP_SCHED_TASK_VARIABLE = (1 << 0),
1686
1687         /*!
1688          * The task data is not an AO2 object.
1689          */
1690         AST_SIP_SCHED_TASK_DATA_NOT_AO2 = (0 << 1),
1691         /*!
1692          * The task data is an AO2 object.
1693          * A reference count will be held by the scheduler until
1694          * after the task has run for the final time (if ever).
1695          */
1696         AST_SIP_SCHED_TASK_DATA_AO2 = (1 << 1),
1697
1698         /*!
1699          * Don't take any cleanup action on the data
1700          */
1701         AST_SIP_SCHED_TASK_DATA_NO_CLEANUP = (0 << 3),
1702         /*!
1703          * If AST_SIP_SCHED_TASK_DATA_AO2 is set, decrement the reference count
1704          * otherwise call ast_free on it.
1705          */
1706         AST_SIP_SCHED_TASK_DATA_FREE = ( 1 << 3 ),
1707
1708         /*!
1709          * \brief The task is scheduled at multiples of interval
1710          * \see Interval
1711          */
1712         AST_SIP_SCHED_TASK_PERIODIC = (0 << 4),
1713         /*!
1714          * \brief The next invocation of the task is at last finish + interval
1715          * \see Interval
1716          */
1717         AST_SIP_SCHED_TASK_DELAY = (1 << 4),
1718         /*!
1719          * \brief The scheduled task's events are tracked in the debug log.
1720          * \details
1721          * Schedule events such as scheduling, running, rescheduling, canceling,
1722          * and destroying are logged about the task.
1723          */
1724         AST_SIP_SCHED_TASK_TRACK = (1 << 5),
1725 };
1726
1727 /*!
1728  * \brief Scheduler task data structure
1729  */
1730 struct ast_sip_sched_task;
1731
1732 /*!
1733  * \brief Schedule a task to run in the res_pjsip thread pool
1734  * \since 13.9.0
1735  *
1736  * \param serializer The serializer to use.  If NULL, don't use a serializer (see note below)
1737  * \param interval The invocation interval in milliseconds (see note below)
1738  * \param sip_task The task to invoke
1739  * \param name An optional name to associate with the task
1740  * \param task_data Optional data to pass to the task
1741  * \param flags One of enum ast_sip_scheduler_task_type
1742  *
1743  * \returns Pointer to \ref ast_sip_sched_task ao2 object which must be dereferenced when done.
1744  *
1745  * \paragraph Serialization
1746  *
1747  * Specifying a serializer guarantees serialized execution but NOT specifying a serializer
1748  * may still result in tasks being effectively serialized if the thread pool is busy.
1749  * The point of the serializer BTW is not to prevent parallel executions of the SAME task.
1750  * That happens automatically (see below).  It's to prevent the task from running at the same
1751  * time as other work using the same serializer, whether or not it's being run by the scheduler.
1752  *
1753  * \paragraph Interval
1754  *
1755  * The interval is used to calculate the next time the task should run.  There are two models.
1756  *
1757  * \ref AST_SIP_SCHED_TASK_PERIODIC specifies that the invocations of the task occur at the
1758  * specific interval.  That is, every \ref "interval" milliseconds, regardless of how long the task
1759  * takes. If the task takes longer than \ref interval, it will be scheduled at the next available
1760  * multiple of \ref interval.  For exmaple: If the task has an interval of 60 seconds and the task
1761  * takes 70 seconds, the next invocation will happen at 120 seconds.
1762  *
1763  * \ref AST_SIP_SCHED_TASK_DELAY specifies that the next invocation of the task should start
1764  * at \ref interval milliseconds after the current invocation has finished.
1765  *
1766  */
1767 struct ast_sip_sched_task *ast_sip_schedule_task(struct ast_taskprocessor *serializer,
1768         int interval, ast_sip_task sip_task, const char *name, void *task_data,
1769         enum ast_sip_scheduler_task_flags flags);
1770
1771 /*!
1772  * \brief Cancels the next invocation of a task
1773  * \since 13.9.0
1774  *
1775  * \param schtd The task structure pointer
1776  * \retval 0 Success
1777  * \retval -1 Failure
1778  * \note Only cancels future invocations not the currently running invocation.
1779  */
1780 int ast_sip_sched_task_cancel(struct ast_sip_sched_task *schtd);
1781
1782 /*!
1783  * \brief Cancels the next invocation of a task by name
1784  * \since 13.9.0
1785  *
1786  * \param name The task name
1787  * \retval 0 Success
1788  * \retval -1 Failure
1789  * \note Only cancels future invocations not the currently running invocation.
1790  */
1791 int ast_sip_sched_task_cancel_by_name(const char *name);
1792
1793 /*!
1794  * \brief Gets the last start and end times of the task
1795  * \since 13.9.0
1796  *
1797  * \param schtd The task structure pointer
1798  * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
1799  * \param[out] last_start Pointer to a timeval structure to contain the time when last started
1800  * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
1801  * \retval 0 Success
1802  * \retval -1 Failure
1803  * \note Any of the pointers can be NULL if you don't need them.
1804  */
1805 int ast_sip_sched_task_get_times(struct ast_sip_sched_task *schtd,
1806         struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
1807
1808 /*!
1809  * \brief Gets the last start and end times of the task by name
1810  * \since 13.9.0
1811  *
1812  * \param name The task name
1813  * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
1814  * \param[out] last_start Pointer to a timeval structure to contain the time when last started
1815  * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
1816  * \retval 0 Success
1817  * \retval -1 Failure
1818  * \note Any of the pointers can be NULL if you don't need them.
1819  */
1820 int ast_sip_sched_task_get_times_by_name(const char *name,
1821         struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
1822
1823 /*!
1824  * \brief Gets the number of milliseconds until the next invocation
1825  * \since 13.9.0
1826  *
1827  * \param schtd The task structure pointer
1828  * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
1829  */
1830 int ast_sip_sched_task_get_next_run(struct ast_sip_sched_task *schtd);
1831
1832 /*!
1833  * \brief Gets the number of milliseconds until the next invocation
1834  * \since 13.9.0
1835  *
1836  * \param name The task name
1837  * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
1838  */
1839 int ast_sip_sched_task_get_next_run_by_name(const char *name);
1840
1841 /*!
1842  * \brief Checks if the task is currently running
1843  * \since 13.9.0
1844  *
1845  * \param schtd The task structure pointer
1846  * \retval 0 not running
1847  * \retval 1 running
1848  */
1849 int ast_sip_sched_is_task_running(struct ast_sip_sched_task *schtd);
1850
1851 /*!
1852  * \brief Checks if the task is currently running
1853  * \since 13.9.0
1854  *
1855  * \param name The task name
1856  * \retval 0 not running or not found
1857  * \retval 1 running
1858  */
1859 int ast_sip_sched_is_task_running_by_name(const char *name);
1860
1861 /*!
1862  * \brief Gets the task name
1863  * \since 13.9.0
1864  *
1865  * \param schtd The task structure pointer
1866  * \retval 0 success
1867  * \retval 1 failure
1868  */
1869 int ast_sip_sched_task_get_name(struct ast_sip_sched_task *schtd, char *name, size_t maxlen);
1870
1871 /*!
1872  *  @}
1873  */
1874
1875 /*!
1876  * \brief SIP body description
1877  *
1878  * This contains a type and subtype that will be added as
1879  * the "Content-Type" for the message as well as the body
1880  * text.
1881  */
1882 struct ast_sip_body {
1883         /*! Type of the body, such as "application" */
1884         const char *type;
1885         /*! Subtype of the body, such as "sdp" */
1886         const char *subtype;
1887         /*! The text to go in the body */
1888         const char *body_text;
1889 };
1890
1891 /*!
1892  * \brief General purpose method for creating a UAC dialog with an endpoint
1893  *
1894  * \param endpoint A pointer to the endpoint
1895  * \param aor_name Optional name of the AOR to target, may even be an explicit SIP URI
1896  * \param request_user Optional user to place into the target URI
1897  *
1898  * \retval non-NULL success
1899  * \retval NULL failure
1900  */
1901 pjsip_dialog *ast_sip_create_dialog_uac(const struct ast_sip_endpoint *endpoint, const char *aor_name, const char *request_user);
1902
1903 /*!
1904  * \brief General purpose method for creating a UAS dialog with an endpoint
1905  *
1906  * \param endpoint A pointer to the endpoint
1907  * \param rdata The request that is starting the dialog
1908  * \param[out] status On failure, the reason for failure in creating the dialog
1909  */
1910 pjsip_dialog *ast_sip_create_dialog_uas(const struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pj_status_t *status);
1911
1912 /*!
1913  * \brief General purpose method for creating an rdata structure using specific information
1914  * \since 13.15.0
1915  *
1916  * \param rdata[out] The rdata structure that will be populated
1917  * \param packet A SIP message
1918  * \param src_name The source IP address of the message
1919  * \param src_port The source port of the message
1920  * \param transport_type The type of transport the message was received on
1921  * \param local_name The local IP address the message was received on
1922  * \param local_port The local port the message was received on
1923  * \param contact_uri The contact URI of the message
1924  *
1925  * \retval 0 success
1926  * \retval -1 failure
1927  */
1928 int ast_sip_create_rdata_with_contact(pjsip_rx_data *rdata, char *packet,
1929         const char *src_name, int src_port, char *transport_type, const char *local_name,
1930         int local_port, const char *contact_uri);
1931
1932 /*!
1933  * \brief General purpose method for creating an rdata structure using specific information
1934  *
1935  * \param rdata[out] The rdata structure that will be populated
1936  * \param packet A SIP message
1937  * \param src_name The source IP address of the message
1938  * \param src_port The source port of the message
1939  * \param transport_type The type of transport the message was received on
1940  * \param local_name The local IP address the message was received on
1941  * \param local_port The local port the message was received on
1942  *
1943  * \retval 0 success
1944  * \retval -1 failure
1945  */
1946 int ast_sip_create_rdata(pjsip_rx_data *rdata, char *packet, const char *src_name,
1947         int src_port, char *transport_type, const char *local_name, int local_port);
1948
1949 /*!
1950  * \brief General purpose method for creating a SIP request
1951  *
1952  * Its typical use would be to create one-off requests such as an out of dialog
1953  * SIP MESSAGE.
1954  *
1955  * The request can either be in- or out-of-dialog. If in-dialog, the
1956  * dlg parameter MUST be present. If out-of-dialog the endpoint parameter
1957  * MUST be present. If both are present, then we will assume that the message
1958  * is to be sent in-dialog.
1959  *
1960  * The uri parameter can be specified if the request should be sent to an explicit
1961  * URI rather than one configured on the endpoint.
1962  *
1963  * \param method The method of the SIP request to send
1964  * \param dlg Optional. If specified, the dialog on which to request the message.
1965  * \param endpoint Optional. If specified, the request will be created out-of-dialog to the endpoint.
1966  * \param uri Optional. If specified, the request will be sent to this URI rather
1967  * than one configured for the endpoint.
1968  * \param contact The contact with which this request is associated for out-of-dialog requests.
1969  * \param[out] tdata The newly-created request
1970  *
1971  * The provided contact is attached to tdata with its reference bumped, but will
1972  * not survive for the entire lifetime of tdata since the contact is cleaned up
1973  * when all supplements have completed execution.
1974  *
1975  * \retval 0 Success
1976  * \retval -1 Failure
1977  */
1978 int ast_sip_create_request(const char *method, struct pjsip_dialog *dlg,
1979                 struct ast_sip_endpoint *endpoint, const char *uri,
1980                 struct ast_sip_contact *contact, pjsip_tx_data **tdata);
1981
1982 /*!
1983  * \brief General purpose method for sending a SIP request
1984  *
1985  * This is a companion function for \ref ast_sip_create_request. The request
1986  * created there can be passed to this function, though any request may be
1987  * passed in.
1988  *
1989  * This will automatically set up handling outbound authentication challenges if
1990  * they arrive.
1991  *
1992  * \param tdata The request to send
1993  * \param dlg Optional. The dialog in which the request is sent.  Otherwise it is out-of-dialog.
1994  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
1995  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
1996  * \param callback Callback to be called upon receipt of out-of-dialog response.
1997  *
1998  * \retval 0 Success
1999  * \retval -1 Failure (out-of-dialog callback will not be called.)
2000  */
2001 int ast_sip_send_request(pjsip_tx_data *tdata, struct pjsip_dialog *dlg,
2002         struct ast_sip_endpoint *endpoint, void *token,
2003         void (*callback)(void *token, pjsip_event *e));
2004
2005 /*!
2006  * \brief General purpose method for sending an Out-Of-Dialog SIP request
2007  *
2008  * This is a companion function for \ref ast_sip_create_request. The request
2009  * created there can be passed to this function, though any request may be
2010  * passed in.
2011  *
2012  * This will automatically set up handling outbound authentication challenges if
2013  * they arrive.
2014  *
2015  * \param tdata The request to send
2016  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
2017  * \param timeout.  If non-zero, after the timeout the transaction will be terminated
2018  * and the callback will be called with the PJSIP_EVENT_TIMER type.
2019  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
2020  * \param callback Callback to be called upon receipt of out-of-dialog response.
2021  *
2022  * \retval 0 Success
2023  * \retval -1 Failure (out-of-dialog callback will not be called.)
2024  *
2025  * \note Timeout processing:
2026  * There are 2 timers associated with this request, PJSIP timer_b which is
2027  * set globally in the "system" section of pjsip.conf, and the timeout specified
2028  * on this call.  The timer that expires first (before normal completion) will
2029  * cause the callback to be run with e->body.tsx_state.type = PJSIP_EVENT_TIMER.
2030  * The timer that expires second is simply ignored and the callback is not run again.
2031  */
2032 int ast_sip_send_out_of_dialog_request(pjsip_tx_data *tdata,
2033         struct ast_sip_endpoint *endpoint, int timeout, void *token,
2034         void (*callback)(void *token, pjsip_event *e));
2035
2036 /*!
2037  * \brief General purpose method for creating a SIP response
2038  *
2039  * Its typical use would be to create responses for out of dialog
2040  * requests.
2041  *
2042  * \param rdata The rdata from the incoming request.
2043  * \param st_code The response code to transmit.
2044  * \param contact The contact with which this request is associated.
2045  * \param[out] tdata The newly-created response
2046  *
2047  * The provided contact is attached to tdata with its reference bumped, but will
2048  * not survive for the entire lifetime of tdata since the contact is cleaned up
2049  * when all supplements have completed execution.
2050  *
2051  * \retval 0 Success
2052  * \retval -1 Failure
2053  */
2054 int ast_sip_create_response(const pjsip_rx_data *rdata, int st_code,
2055         struct ast_sip_contact *contact, pjsip_tx_data **p_tdata);
2056
2057 /*!
2058  * \brief Send a response to an out of dialog request
2059  *
2060  * Use this function sparingly, since this does not create a transaction
2061  * within PJSIP. This means that if the request is retransmitted, it is
2062  * your responsibility to detect this and not process the same request
2063  * twice, and to send the same response for each retransmission.
2064  *
2065  * \param res_addr The response address for this response
2066  * \param tdata The response to send
2067  * \param endpoint The ast_sip_endpoint associated with this response
2068  *
2069  * \retval 0 Success
2070  * \retval -1 Failure
2071  */
2072 int ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
2073
2074 /*!
2075  * \brief Send a stateful response to an out of dialog request
2076  *
2077  * This creates a transaction within PJSIP, meaning that if the request
2078  * that we are responding to is retransmitted, we will not attempt to
2079  * re-handle the request.
2080  *
2081  * \param rdata The request that is being responded to
2082  * \param tdata The response to send
2083  * \param endpoint The ast_sip_endpoint associated with this response
2084  *
2085  * \since 13.4.0
2086  *
2087  * \retval 0 Success
2088  * \retval -1 Failure
2089  */
2090 int ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
2091
2092 /*!
2093  * \brief Determine if an incoming request requires authentication
2094  *
2095  * This calls into the registered authenticator's requires_authentication callback
2096  * in order to determine if the request requires authentication.
2097  *
2098  * If there is no registered authenticator, then authentication will be assumed
2099  * not to be required.
2100  *
2101  * \param endpoint The endpoint from which the request originates
2102  * \param rdata The incoming SIP request
2103  * \retval non-zero The request requires authentication
2104  * \retval 0 The request does not require authentication
2105  */
2106 int ast_sip_requires_authentication(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2107
2108 /*!
2109  * \brief Method to determine authentication status of an incoming request
2110  *
2111  * This will call into a registered authenticator. The registered authenticator will
2112  * do what is necessary to determine whether the incoming request passes authentication.
2113  * A tentative response is passed into this function so that if, say, a digest authentication
2114  * challenge should be sent in the ensuing response, it can be added to the response.
2115  *
2116  * \param endpoint The endpoint from the request was sent
2117  * \param rdata The request to potentially authenticate
2118  * \param tdata Tentative response to the request
2119  * \return The result of checking authentication.
2120  */
2121 enum ast_sip_check_auth_result ast_sip_check_authentication(struct ast_sip_endpoint *endpoint,
2122                 pjsip_rx_data *rdata, pjsip_tx_data *tdata);
2123
2124 /*!
2125  * \brief Create a response to an authentication challenge
2126  *
2127  * This will call into an outbound authenticator's create_request_with_auth callback
2128  * to create a new request with authentication credentials. See the create_request_with_auth
2129  * callback in the \ref ast_sip_outbound_authenticator structure for details about
2130  * the parameters and return values.
2131  */
2132 int ast_sip_create_request_with_auth(const struct ast_sip_auth_vector *auths, pjsip_rx_data *challenge,
2133                 pjsip_tx_data *tdata, pjsip_tx_data **new_request);
2134
2135 /*!
2136  * \brief Determine the endpoint that has sent a SIP message
2137  *
2138  * This will call into each of the registered endpoint identifiers'
2139  * identify_endpoint() callbacks until one returns a non-NULL endpoint.
2140  * This will return an ao2 object. Its reference count will need to be
2141  * decremented when completed using the endpoint.
2142  *
2143  * \param rdata The inbound SIP message to use when identifying the endpoint.
2144  * \retval NULL No matching endpoint
2145  * \retval non-NULL The matching endpoint
2146  */
2147 struct ast_sip_endpoint *ast_sip_identify_endpoint(pjsip_rx_data *rdata);
2148
2149 /*!
2150  * \brief Set the outbound proxy for an outbound SIP message
2151  *
2152  * \param tdata The message to set the outbound proxy on
2153  * \param proxy SIP uri of the proxy
2154  * \retval 0 Success
2155  * \retval -1 Failure
2156  */
2157 int ast_sip_set_outbound_proxy(pjsip_tx_data *tdata, const char *proxy);
2158
2159 /*!
2160  * \brief Add a header to an outbound SIP message
2161  *
2162  * \param tdata The message to add the header to
2163  * \param name The header name
2164  * \param value The header value
2165  * \retval 0 Success
2166  * \retval -1 Failure
2167  */
2168 int ast_sip_add_header(pjsip_tx_data *tdata, const char *name, const char *value);
2169
2170 /*!
2171  * \brief Add a body to an outbound SIP message
2172  *
2173  * If this is called multiple times, the latest body will replace the current
2174  * body.
2175  *
2176  * \param tdata The message to add the body to
2177  * \param body The message body to add
2178  * \retval 0 Success
2179  * \retval -1 Failure
2180  */
2181 int ast_sip_add_body(pjsip_tx_data *tdata, const struct ast_sip_body *body);
2182
2183 /*!
2184  * \brief Add a multipart body to an outbound SIP message
2185  *
2186  * This will treat each part of the input vector as part of a multipart body and
2187  * add each part to the SIP message.
2188  *
2189  * \param tdata The message to add the body to
2190  * \param bodies The parts of the body to add
2191  * \retval 0 Success
2192  * \retval -1 Failure
2193  */
2194 int ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies);
2195
2196 /*!
2197  * \brief Append body data to a SIP message
2198  *
2199  * This acts mostly the same as ast_sip_add_body, except that rather than replacing
2200  * a body if it currently exists, it appends data to an existing body.
2201  *
2202  * \param tdata The message to append the body to
2203  * \param body The string to append to the end of the current body
2204  * \retval 0 Success
2205  * \retval -1 Failure
2206  */
2207 int ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text);
2208
2209 /*!
2210  * \brief Copy a pj_str_t into a standard character buffer.
2211  *
2212  * pj_str_t is not NULL-terminated. Any place that expects a NULL-
2213  * terminated string needs to have the pj_str_t copied into a separate
2214  * buffer.
2215  *
2216  * This method copies the pj_str_t contents into the destination buffer
2217  * and NULL-terminates the buffer.
2218  *
2219  * \param dest The destination buffer
2220  * \param src The pj_str_t to copy
2221  * \param size The size of the destination buffer.
2222  */
2223 void ast_copy_pj_str(char *dest, const pj_str_t *src, size_t size);
2224
2225 /*!
2226  * \brief Create and copy a pj_str_t into a standard character buffer.
2227  *
2228  * pj_str_t is not NULL-terminated. Any place that expects a NULL-
2229  * terminated string needs to have the pj_str_t copied into a separate
2230  * buffer.
2231  *
2232  * Copies the pj_str_t contents into a newly allocated buffer pointed to
2233  * by dest. NULL-terminates the buffer.
2234  *
2235  * \note Caller is responsible for freeing the allocated memory.
2236  *
2237  * \param dest [out] The destination buffer
2238  * \param src The pj_str_t to copy
2239  * \retval Number of characters copied or negative value on error
2240  */
2241 int ast_copy_pj_str2(char **dest, const pj_str_t *src);
2242
2243 /*!
2244  * \brief Get the looked-up endpoint on an out-of dialog request or response
2245  *
2246  * The function may ONLY be called on out-of-dialog requests or responses. For
2247  * in-dialog requests and responses, it is required that the user of the dialog
2248  * has the looked-up endpoint stored locally.
2249  *
2250  * This function should never return NULL if the message is out-of-dialog. It will
2251  * always return NULL if the message is in-dialog.
2252  *
2253  * This function will increase the reference count of the returned endpoint by one.
2254  * Release your reference using the ao2_ref function when finished.
2255  *
2256  * \param rdata Out-of-dialog request or response
2257  * \return The looked up endpoint
2258  */
2259 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata);
2260
2261 /*!
2262  * \brief Add 'user=phone' parameter to URI if enabled and user is a phone number.
2263  *
2264  * \param endpoint The endpoint to use for configuration
2265  * \param pool The memory pool to allocate the parameter from
2266  * \param uri The URI to check for user and to add parameter to
2267  */
2268 void ast_sip_add_usereqphone(const struct ast_sip_endpoint *endpoint, pj_pool_t *pool, pjsip_uri *uri);
2269
2270 /*!
2271  * \brief Retrieve any endpoints available to sorcery.
2272  *
2273  * \retval Endpoints available to sorcery, NULL if no endpoints found.
2274  */
2275 struct ao2_container *ast_sip_get_endpoints(void);
2276
2277 /*!
2278  * \brief Retrieve the default outbound endpoint.
2279  *
2280  * \retval The default outbound endpoint, NULL if not found.
2281  */
2282 struct ast_sip_endpoint *ast_sip_default_outbound_endpoint(void);
2283
2284 /*!
2285  * \brief Retrieve relevant SIP auth structures from sorcery
2286  *
2287  * \param auths Vector of sorcery IDs of auth credentials to retrieve
2288  * \param[out] out The retrieved auths are stored here
2289  */
2290 int ast_sip_retrieve_auths(const struct ast_sip_auth_vector *auths, struct ast_sip_auth **out);
2291
2292 /*!
2293  * \brief Clean up retrieved auth structures from memory
2294  *
2295  * Call this function once you have completed operating on auths
2296  * retrieved from \ref ast_sip_retrieve_auths
2297  *
2298  * \param auths An vector of auth structures to clean up
2299  * \param num_auths The number of auths in the vector
2300  */
2301 void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths);
2302
2303 /*!
2304  * \brief Checks if the given content type matches type/subtype.
2305  *
2306  * Compares the pjsip_media_type with the passed type and subtype and
2307  * returns the result of that comparison.  The media type parameters are
2308  * ignored.
2309  *
2310  * \param content_type The pjsip_media_type structure to compare
2311  * \param type The media type to compare
2312  * \param subtype The media subtype to compare
2313  * \retval 0 No match
2314  * \retval -1 Match
2315  */
2316 int ast_sip_is_content_type(pjsip_media_type *content_type, char *type, char *subtype);
2317
2318 /*!
2319  * \brief Send a security event notification for when an invalid endpoint is requested
2320  *
2321  * \param name Name of the endpoint requested
2322  * \param rdata Received message
2323  */
2324 void ast_sip_report_invalid_endpoint(const char *name, pjsip_rx_data *rdata);
2325
2326 /*!
2327  * \brief Send a security event notification for when an ACL check fails
2328  *
2329  * \param endpoint Pointer to the endpoint in use
2330  * \param rdata Received message
2331  * \param name Name of the ACL
2332  */
2333 void ast_sip_report_failed_acl(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *name);
2334
2335 /*!
2336  * \brief Send a security event notification for when a challenge response has failed
2337  *
2338  * \param endpoint Pointer to the endpoint in use
2339  * \param rdata Received message
2340  */
2341 void ast_sip_report_auth_failed_challenge_response(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2342
2343 /*!
2344  * \brief Send a security event notification for when authentication succeeds
2345  *
2346  * \param endpoint Pointer to the endpoint in use
2347  * \param rdata Received message
2348  */
2349 void ast_sip_report_auth_success(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2350
2351 /*!
2352  * \brief Send a security event notification for when an authentication challenge is sent
2353  *
2354  * \param endpoint Pointer to the endpoint in use
2355  * \param rdata Received message
2356  * \param tdata Sent message
2357  */
2358 void ast_sip_report_auth_challenge_sent(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata);
2359
2360 /*!
2361  * \brief Send a security event notification for when a request is not supported
2362  *
2363  * \param endpoint Pointer to the endpoint in use
2364  * \param rdata Received message
2365  * \param req_type the type of request
2366  */
2367 void ast_sip_report_req_no_support(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata,
2368                                    const char* req_type);
2369
2370 /*!
2371  * \brief Send a security event notification for when a memory limit is hit.
2372  *
2373  * \param endpoint Pointer to the endpoint in use
2374  * \param rdata Received message
2375  */
2376 void ast_sip_report_mem_limit(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2377
2378 int ast_sip_add_global_request_header(const char *name, const char *value, int replace);
2379 int ast_sip_add_global_response_header(const char *name, const char *value, int replace);
2380
2381 /*!
2382  * \brief Retrieves the value associated with the given key.
2383  *
2384  * \param ht the hash table/dictionary to search
2385  * \param key the key to find
2386  *
2387  * \retval the value associated with the key, NULL otherwise.
2388  */
2389 void *ast_sip_dict_get(void *ht, const char *key);
2390
2391 /*!
2392  * \brief Using the dictionary stored in mod_data array at a given id,
2393  *        retrieve the value associated with the given key.
2394  *
2395  * \param mod_data a module data array
2396  * \param id the mod_data array index
2397  * \param key the key to find
2398  *
2399  * \retval the value associated with the key, NULL otherwise.
2400  */
2401 #define ast_sip_mod_data_get(mod_data, id, key)         \
2402         ast_sip_dict_get(mod_data[id], key)
2403
2404 /*!
2405  * \brief Set the value for the given key.
2406  *
2407  * Note - if the hash table does not exist one is created first, the key/value
2408  * pair is set, and the hash table returned.
2409  *
2410  * \param pool the pool to allocate memory in
2411  * \param ht the hash table/dictionary in which to store the key/value pair
2412  * \param key the key to associate a value with
2413  * \param val the value to associate with a key
2414  *
2415  * \retval the given, or newly created, hash table.
2416  */
2417 void *ast_sip_dict_set(pj_pool_t* pool, void *ht,
2418                        const char *key, void *val);
2419
2420 /*!
2421  * \brief Utilizing a mod_data array for a given id, set the value
2422  *        associated with the given key.
2423  *
2424  * For a given structure's mod_data array set the element indexed by id to
2425  * be a dictionary containing the key/val pair.
2426  *
2427  * \param pool a memory allocation pool
2428  * \param mod_data a module data array
2429  * \param id the mod_data array index
2430  * \param key the key to find
2431  * \param val the value to associate with a key
2432  */
2433 #define ast_sip_mod_data_set(pool, mod_data, id, key, val)              \
2434         mod_data[id] = ast_sip_dict_set(pool, mod_data[id], key, val)
2435
2436 /*!
2437  * \brief For every contact on an AOR call the given 'on_contact' handler.
2438  *
2439  * \param aor the aor containing a list of contacts to iterate
2440  * \param on_contact callback on each contact on an AOR.  The object
2441  * received by the callback will be a ast_sip_contact_wrapper structure.
2442  * \param arg user data passed to handler
2443  * \retval 0 Success, non-zero on failure
2444  */
2445 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
2446                 ao2_callback_fn on_contact, void *arg);
2447
2448 /*!
2449  * \brief Handler used to convert a contact to a string.
2450  *
2451  * \param object the ast_sip_aor_contact_pair containing a list of contacts to iterate and the contact
2452  * \param arg user data passed to handler
2453  * \param flags
2454  * \retval 0 Success, non-zero on failure
2455  */
2456 int ast_sip_contact_to_str(void *object, void *arg, int flags);
2457
2458 /*!
2459  * \brief For every aor in the comma separated aors string call the
2460  *        given 'on_aor' handler.
2461  *
2462  * \param aors a comma separated list of aors
2463  * \param on_aor callback for each aor
2464  * \param arg user data passed to handler
2465  * \retval 0 Success, non-zero on failure
2466  */
2467 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg);
2468
2469 /*!
2470  * \brief For every auth in the array call the given 'on_auth' handler.
2471  *
2472  * \param array an array of auths
2473  * \param on_auth callback for each auth
2474  * \param arg user data passed to handler
2475  * \retval 0 Success, non-zero on failure
2476  */
2477 int ast_sip_for_each_auth(const struct ast_sip_auth_vector *array,
2478                           ao2_callback_fn on_auth, void *arg);
2479
2480 /*!
2481  * \brief Converts the given auth type to a string
2482  *
2483  * \param type the auth type to convert
2484  * \retval a string representative of the auth type
2485  */
2486 const char *ast_sip_auth_type_to_str(enum ast_sip_auth_type type);
2487
2488 /*!
2489  * \brief Converts an auths array to a string of comma separated values
2490  *
2491  * \param auths an auth array
2492  * \param buf the string buffer to write the object data
2493  * \retval 0 Success, non-zero on failure
2494  */
2495 int ast_sip_auths_to_str(const struct ast_sip_auth_vector *auths, char **buf);
2496
2497 /*!
2498  * \brief AMI variable container
2499  */
2500 struct ast_sip_ami {
2501         /*! Manager session */
2502         struct mansession *s;
2503         /*! Manager message */
2504         const struct message *m;
2505         /*! Manager Action ID */
2506         const char *action_id;
2507         /*! user specified argument data */
2508         void *arg;
2509         /*! count of objects */
2510         int count;
2511 };
2512
2513 /*!
2514  * \brief Creates a string to store AMI event data in.
2515  *
2516  * \param event the event to set
2517  * \param ami AMI session and message container
2518  * \retval an initialized ast_str or NULL on error.
2519  */
2520 struct ast_str *ast_sip_create_ami_event(const char *event,
2521                                          struct ast_sip_ami *ami);
2522
2523 /*!
2524  * \brief An entity responsible formatting endpoint information.
2525  */
2526 struct ast_sip_endpoint_formatter {
2527         /*!
2528          * \brief Callback used to format endpoint information over AMI.
2529          */
2530         int (*format_ami)(const struct ast_sip_endpoint *endpoint,
2531                           struct ast_sip_ami *ami);
2532         AST_RWLIST_ENTRY(ast_sip_endpoint_formatter) next;
2533 };
2534
2535 /*!
2536  * \brief Register an endpoint formatter.
2537  *
2538  * \param obj the formatter to register
2539  */
2540 void ast_sip_register_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
2541
2542 /*!
2543  * \brief Unregister an endpoint formatter.
2544  *
2545  * \param obj the formatter to unregister
2546  */
2547 void ast_sip_unregister_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
2548
2549 /*!
2550  * \brief Converts a sorcery object to a string of object properties.
2551  *
2552  * \param obj the sorcery object to convert
2553  * \param str the string buffer to write the object data
2554  * \retval 0 Success, non-zero on failure
2555  */
2556 int ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf);
2557
2558 /*!
2559  * \brief Formats the endpoint and sends over AMI.
2560  *
2561  * \param endpoint the endpoint to format and send
2562  * \param endpoint ami AMI variable container
2563  * \param count the number of formatters operated on
2564  * \retval 0 Success, otherwise non-zero on error
2565  */
2566 int ast_sip_format_endpoint_ami(struct ast_sip_endpoint *endpoint,
2567                                 struct ast_sip_ami *ami, int *count);
2568
2569 /*!
2570  * \brief Formats the contact and sends over AMI.
2571  *
2572  * \param obj a pointer an ast_sip_contact_wrapper structure
2573  * \param arg a pointer to an ast_sip_ami structure
2574  * \param flags ignored
2575  * \retval 0 Success, otherwise non-zero on error
2576  */
2577 int ast_sip_format_contact_ami(void *obj, void *arg, int flags);
2578
2579 /*!
2580  * \brief Format auth details for AMI.
2581  *
2582  * \param auths an auth array
2583  * \param ami ami variable container
2584  * \retval 0 Success, non-zero on failure
2585  */
2586 int ast_sip_format_auths_ami(const struct ast_sip_auth_vector *auths,
2587                              struct ast_sip_ami *ami);
2588
2589 /*!
2590  * \brief Retrieve the endpoint snapshot for an endpoint
2591  *
2592  * \param endpoint The endpoint whose snapshot is to be retreieved.
2593  * \retval The endpoint snapshot
2594  */
2595 struct ast_endpoint_snapshot *ast_sip_get_endpoint_snapshot(
2596         const struct ast_sip_endpoint *endpoint);
2597
2598 /*!
2599  * \brief Retrieve the device state for an endpoint.
2600  *
2601  * \param endpoint The endpoint whose state is to be retrieved.
2602  * \retval The device state.
2603  */
2604 const char *ast_sip_get_device_state(const struct ast_sip_endpoint *endpoint);
2605
2606 /*!
2607  * \brief For every channel snapshot on an endpoint snapshot call the given
2608  *        'on_channel_snapshot' handler.
2609  *
2610  * \param endpoint_snapshot snapshot of an endpoint
2611  * \param on_channel_snapshot callback for each channel snapshot
2612  * \param arg user data passed to handler
2613  * \retval 0 Success, non-zero on failure
2614  */
2615 int ast_sip_for_each_channel_snapshot(const struct ast_endpoint_snapshot *endpoint_snapshot,
2616                 ao2_callback_fn on_channel_snapshot,
2617                                       void *arg);
2618
2619 /*!
2620  * \brief For every channel snapshot on an endpoint all the given
2621  *        'on_channel_snapshot' handler.
2622  *
2623  * \param endpoint endpoint
2624  * \param on_channel_snapshot callback for each channel snapshot
2625  * \param arg user data passed to handler
2626  * \retval 0 Success, non-zero on failure
2627  */
2628 int ast_sip_for_each_channel(const struct ast_sip_endpoint *endpoint,
2629                 ao2_callback_fn on_channel_snapshot,
2630                                       void *arg);
2631
2632 enum ast_sip_supplement_priority {
2633         /*! Top priority. Supplements with this priority are those that need to run before any others */
2634         AST_SIP_SUPPLEMENT_PRIORITY_FIRST = 0,
2635         /*! Channel creation priority.
2636          * chan_pjsip creates a channel at this priority. If your supplement depends on being run before
2637          * or after channel creation, then set your priority to be lower or higher than this value.
2638          */
2639         AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL = 1000000,
2640         /*! Lowest priority. Supplements with this priority should be run after all other supplements */
2641         AST_SIP_SUPPLEMENT_PRIORITY_LAST = INT_MAX,
2642 };
2643
2644 /*!
2645  * \brief A supplement to SIP message processing
2646  *
2647  * These can be registered by any module in order to add
2648  * processing to incoming and outgoing SIP out of dialog
2649  * requests and responses
2650  */
2651 struct ast_sip_supplement {
2652         /*! Method on which to call the callbacks. If NULL, call on all methods */
2653         const char *method;
2654         /*! Priority for this supplement. Lower numbers are visited before higher numbers */
2655         enum ast_sip_supplement_priority priority;
2656         /*!
2657          * \brief Called on incoming SIP request
2658          * This method can indicate a failure in processing in its return. If there
2659          * is a failure, it is required that this method sends a response to the request.
2660          * This method is always called from a SIP servant thread.
2661          *
2662          * \note
2663          * The following PJSIP methods will not work properly:
2664          * pjsip_rdata_get_dlg()
2665          * pjsip_rdata_get_tsx()
2666          * The reason is that the rdata passed into this function is a cloned rdata structure,
2667          * and its module data is not copied during the cloning operation.
2668          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2669          *
2670          * \note
2671          * There is no guarantee that a channel will be present on the session when this is called.
2672          */
2673         int (*incoming_request)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2674         /*!
2675          * \brief Called on an incoming SIP response
2676          * This method is always called from a SIP servant thread.
2677          *
2678          * \note
2679          * The following PJSIP methods will not work properly:
2680          * pjsip_rdata_get_dlg()
2681          * pjsip_rdata_get_tsx()
2682          * The reason is that the rdata passed into this function is a cloned rdata structure,
2683          * and its module data is not copied during the cloning operation.
2684          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2685          *
2686          * \note
2687          * There is no guarantee that a channel will be present on the session when this is called.
2688          */
2689         void (*incoming_response)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2690         /*!
2691          * \brief Called on an outgoing SIP request
2692          * This method is always called from a SIP servant thread.
2693          */
2694         void (*outgoing_request)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2695         /*!
2696          * \brief Called on an outgoing SIP response
2697          * This method is always called from a SIP servant thread.
2698          */
2699         void (*outgoing_response)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2700         /*! Next item in the list */
2701         AST_LIST_ENTRY(ast_sip_supplement) next;
2702 };
2703
2704 /*!
2705  * \brief Register a supplement to SIP out of dialog processing
2706  *
2707  * This allows for someone to insert themselves in the processing of out
2708  * of dialog SIP requests and responses. This, for example could allow for
2709  * a module to set channel data based on headers in an incoming message.
2710  * Similarly, a module could reject an incoming request if desired.
2711  *
2712  * \param supplement The supplement to register
2713  * \retval 0 Success
2714  * \retval -1 Failure
2715  */
2716 void ast_sip_register_supplement(struct ast_sip_supplement *supplement);
2717
2718 /*!
2719  * \brief Unregister a an supplement to SIP out of dialog processing
2720  *
2721  * \param supplement The supplement to unregister
2722  */
2723 void ast_sip_unregister_supplement(struct ast_sip_supplement *supplement);
2724
2725 /*!
2726  * \brief Retrieve the global MWI taskprocessor high water alert trigger level.
2727  *
2728  * \since 13.12.0
2729  *
2730  * \retval the system MWI taskprocessor high water alert trigger level
2731  */
2732 unsigned int ast_sip_get_mwi_tps_queue_high(void);
2733
2734 /*!
2735  * \brief Retrieve the global MWI taskprocessor low water clear alert level.
2736  *
2737  * \since 13.12.0
2738  *
2739  * \retval the system MWI taskprocessor low water clear alert level
2740  */
2741 int ast_sip_get_mwi_tps_queue_low(void);
2742
2743 /*!
2744  * \brief Retrieve the global setting 'disable sending unsolicited mwi on startup'.
2745  * \since 13.12.0
2746  *
2747  * \retval non zero if disable.
2748  */
2749 unsigned int ast_sip_get_mwi_disable_initial_unsolicited(void);
2750
2751 /*!
2752  * \brief Retrieve the global setting 'ignore_uri_user_options'.
2753  * \since 13.12.0
2754  *
2755  * \retval non zero if ignore the user field options.
2756  */
2757 unsigned int ast_sip_get_ignore_uri_user_options(void);
2758
2759 /*!
2760  * \brief Truncate the URI user field options string if enabled.
2761  * \since 13.12.0
2762  *
2763  * \param str URI user field string to truncate if enabled
2764  *
2765  * \details
2766  * We need to be able to handle URI's looking like
2767  * "sip:1235557890;phone-context=national@x.x.x.x;user=phone"
2768  *
2769  * Where the URI user field is:
2770  * "1235557890;phone-context=national"
2771  *
2772  * When truncated the string will become:
2773  * "1235557890"
2774  */
2775 #define AST_SIP_USER_OPTIONS_TRUNCATE_CHECK(str)                                \
2776         do {                                                                                                            \
2777                 char *__semi = strchr((str), ';');                                              \
2778                 if (__semi && ast_sip_get_ignore_uri_user_options()) {  \
2779                         *__semi = '\0';                                                                         \
2780                 }                                                                                                               \
2781         } while (0)
2782
2783 /*!
2784  * \brief Retrieve the system debug setting (yes|no|host).
2785  *
2786  * \note returned string needs to be de-allocated by caller.
2787  *
2788  * \retval the system debug setting.
2789  */
2790 char *ast_sip_get_debug(void);
2791
2792 /*!
2793  * \brief Retrieve the global regcontext setting.
2794  *
2795  * \since 13.8.0
2796  *
2797  * \note returned string needs to be de-allocated by caller.
2798  *
2799  * \retval the global regcontext setting
2800  */
2801 char *ast_sip_get_regcontext(void);
2802
2803 /*!
2804  * \brief Retrieve the global endpoint_identifier_order setting.
2805  *
2806  * Specifies the order by which endpoint identifiers should be regarded.
2807  *
2808  * \retval the global endpoint_identifier_order value
2809  */
2810 char *ast_sip_get_endpoint_identifier_order(void);
2811
2812 /*!
2813  * \brief Retrieve the default voicemail extension.
2814  * \since 13.9.0
2815  *
2816  * \note returned string needs to be de-allocated by caller.
2817  *
2818  * \retval the default voicemail extension
2819  */
2820 char *ast_sip_get_default_voicemail_extension(void);
2821
2822 /*!
2823  * \brief Retrieve the global default realm.
2824  *
2825  * This is the value placed in outbound challenges' realm if there
2826  * is no better option (such as an auth-configured realm).
2827  *
2828  * \param[out] realm The default realm
2829  * \param size The buffer size of realm
2830  * \return nothing
2831  */
2832 void ast_sip_get_default_realm(char *realm, size_t size);
2833
2834 /*!
2835  * \brief Retrieve the global default from user.
2836  *
2837  * This is the value placed in outbound requests' From header if there
2838  * is no better option (such as an endpoint-configured from_user or
2839  * caller ID number).
2840  *
2841  * \param[out] from_user The default from user
2842  * \param size The buffer size of from_user
2843  * \return nothing
2844  */
2845 void ast_sip_get_default_from_user(char *from_user, size_t size);
2846
2847 /*!
2848  * \brief Retrieve the system keep alive interval setting.
2849  *
2850  * \retval the keep alive interval.
2851  */
2852 unsigned int ast_sip_get_keep_alive_interval(void);
2853
2854 /*!
2855  * \brief Retrieve the system contact expiration check interval setting.
2856  *
2857  * \retval the contact expiration check interval.
2858  */
2859 unsigned int ast_sip_get_contact_expiration_check_interval(void);
2860
2861 /*!
2862  * \brief Retrieve the system setting 'disable multi domain'.
2863  * \since 13.9.0
2864  *
2865  * \retval non zero if disable multi domain.
2866  */
2867 unsigned int ast_sip_get_disable_multi_domain(void);
2868
2869 /*!
2870  * \brief Retrieve the system max initial qualify time.
2871  *
2872  * \retval the maximum initial qualify time.
2873  */
2874 unsigned int ast_sip_get_max_initial_qualify_time(void);
2875
2876 /*!
2877  * \brief translate ast_sip_contact_status_type to character string.
2878  *
2879  * \retval the character string equivalent.
2880  */
2881
2882 const char *ast_sip_get_contact_status_label(const enum ast_sip_contact_status_type status);
2883 const char *ast_sip_get_contact_short_status_label(const enum ast_sip_contact_status_type status);
2884
2885 /*!
2886  * \brief Set a request to use the next value in the list of resolved addresses.
2887  *
2888  * \param tdata the tx data from the original request
2889  * \retval 0 No more addresses to try
2890  * \retval 1 The request was successfully re-intialized
2891  */
2892 int ast_sip_failover_request(pjsip_tx_data *tdata);
2893
2894 /*
2895  * \brief Retrieve the local host address in IP form
2896  *
2897  * \param af The address family to retrieve
2898  * \param addr A place to store the local host address
2899  *
2900  * \retval 0 success
2901  * \retval -1 failure
2902  *
2903  * \since 13.6.0
2904  */
2905 int ast_sip_get_host_ip(int af, pj_sockaddr *addr);
2906
2907 /*!
2908  * \brief Retrieve the local host address in string form
2909  *
2910  * \param af The address family to retrieve
2911  *
2912  * \retval non-NULL success
2913  * \retval NULL failure
2914  *
2915  * \since 13.6.0
2916  *
2917  * \note An empty string may be returned if the address family is valid but no local address exists
2918  */
2919 const char *ast_sip_get_host_ip_string(int af);
2920
2921 /*!
2922  * \brief Return the size of the SIP threadpool's task queue
2923  * \since 13.7.0
2924  */
2925 long ast_sip_threadpool_queue_size(void);
2926
2927 /*!
2928  * \brief Retrieve transport state
2929  * \since 13.7.1
2930  *
2931  * @param transport_id
2932  * @returns transport_state
2933  *
2934  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2935  */
2936 struct ast_sip_transport_state *ast_sip_get_transport_state(const char *transport_id);
2937
2938 /*!
2939  * \brief Retrieves all transport states
2940  * \since 13.7.1
2941  *
2942  * @returns ao2_container
2943  *
2944  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2945  */
2946 struct ao2_container *ast_sip_get_transport_states(void);
2947
2948 /*!
2949  * \brief Sets pjsip_tpselector from ast_sip_transport
2950  * \since 13.8.0
2951  *
2952  * \param transport The transport to be used
2953  * \param selector The selector to be populated
2954  * \retval 0 success
2955  * \retval -1 failure
2956  */
2957 int ast_sip_set_tpselector_from_transport(const struct ast_sip_transport *transport, pjsip_tpselector *selector);
2958
2959 /*!
2960  * \brief Sets pjsip_tpselector from ast_sip_transport
2961  * \since 13.8.0
2962  *
2963  * \param transport_name The name of the transport to be used
2964  * \param selector The selector to be populated
2965  * \retval 0 success
2966  * \retval -1 failure
2967  */
2968 int ast_sip_set_tpselector_from_transport_name(const char *transport_name, pjsip_tpselector *selector);
2969
2970 /*!
2971  * \brief Set name and number information on an identity header.
2972  *
2973  * \param pool Memory pool to use for string duplication
2974  * \param id_hdr A From, P-Asserted-Identity, or Remote-Party-ID header to modify
2975  * \param id The identity information to apply to the header
2976  */
2977 void ast_sip_modify_id_header(pj_pool_t *pool, pjsip_fromto_hdr *id_hdr,
2978         const struct ast_party_id *id);
2979
2980 /*!
2981  * \brief Retrieve the unidentified request security event thresholds
2982  * \since 13.8.0
2983  *
2984  * \param count The maximum number of unidentified requests per source ip to accumulate before emitting a security event
2985  * \param period The period in seconds over which to accumulate unidentified requests
2986  * \param prune_interval The interval in seconds at which expired entries will be pruned
2987  */
2988 void ast_sip_get_unidentified_request_thresholds(unsigned int *count, unsigned int *period,
2989         unsigned int *prune_interval);
2990
2991 /*!
2992  * \brief Get the transport name from an endpoint or request uri
2993  * \since 13.15.0
2994  *
2995  * \param endpoint
2996  * \param sip_uri
2997  * \param buf Buffer to receive transport name
2998  * \param buf_len Buffer length
2999  *
3000  * \retval 0 Success
3001  * \retval -1 Failure
3002  *
3003  * \note
3004  * If endpoint->transport is not NULL, it is returned in buf.
3005  * Otherwise if sip_uri has an 'x-ast-txp' parameter AND the sip_uri host is
3006  * an ip4 or ip6 address, its value is returned,
3007  */
3008 int ast_sip_get_transport_name(const struct ast_sip_endpoint *endpoint,
3009         pjsip_sip_uri *sip_uri, char *buf, size_t buf_len);
3010
3011 /*!
3012  * \brief Sets pjsip_tpselector from an endpoint or uri
3013  * \since 13.15.0
3014  *
3015  * \param endpoint If endpoint->transport is set, it's used
3016  * \param sip_uri If sip_uri contains a x-ast-txp parameter, it's used
3017  * \param selector The selector to be populated
3018  *
3019  * \retval 0 success
3020  * \retval -1 failure
3021  */
3022 int ast_sip_set_tpselector_from_ep_or_uri(const struct ast_sip_endpoint *endpoint,
3023         pjsip_sip_uri *sip_uri, pjsip_tpselector *selector);
3024
3025 /*!
3026  * \brief Set the transport on a dialog
3027  * \since 13.15.0
3028  *
3029  * \param endpoint
3030  * \param dlg
3031  * \param selector (optional)
3032  *
3033  * \note
3034  * This API calls ast_sip_get_transport_name(endpoint, dlg->target) and if the result is
3035  * non-NULL, calls pjsip_dlg_set_transport.  If 'selector' is non-NULL, it is updated with
3036  * the selector used.
3037  */
3038 int ast_sip_dlg_set_transport(const struct ast_sip_endpoint *endpoint, pjsip_dialog *dlg,
3039         pjsip_tpselector *selector);
3040
3041 /*!
3042  * \brief Convert the DTMF mode enum value into a string
3043  * \since 13.18.0
3044  *
3045  * \param dtmf the dtmf mode
3046  * \param buf Buffer to receive dtmf mode string
3047  * \param buf_len Buffer length
3048  *
3049  * \retval 0 Success
3050  * \retval -1 Failure
3051  *
3052  */
3053 int ast_sip_dtmf_to_str(const enum ast_sip_dtmf_mode dtmf,
3054         char *buf, size_t buf_len);
3055
3056 /*!
3057  * \brief Convert the DTMF mode name into an enum
3058  * \since 13.18.0
3059  *
3060  * \param dtmf_mode dtmf mode as a string
3061  *
3062  * \retval  >= 0 The enum value
3063  * \retval -1 Failure
3064  *
3065  */
3066 int ast_sip_str_to_dtmf(const char *dtmf_mode);
3067
3068 /*!
3069  * \brief Transport shutdown monitor callback.
3070  * \since 13.18.0
3071  *
3072  * \param data User data to know what to do when transport shuts down.
3073  *
3074  * \note The callback does not need to care that data is an ao2 object.
3075  *
3076  * \return Nothing
3077  */
3078 typedef void (*ast_transport_monitor_shutdown_cb)(void *data);
3079
3080 /*!
3081  * \brief Transport shutdown monitor data matcher
3082  * \since 13.20.0
3083  *
3084  * \param a User data to compare.
3085  * \param b User data to compare.
3086  *
3087  * \retval 1 The data objects match
3088  * \retval 0 The data objects don't match
3089  */
3090 typedef int (*ast_transport_monitor_data_matcher)(void *a, void *b);
3091
3092 enum ast_transport_monitor_reg {
3093         /*! \brief Successfully registered the transport monitor */
3094         AST_TRANSPORT_MONITOR_REG_SUCCESS,
3095         /*! \brief Replaced the already existing transport monitor with new one. */
3096         AST_TRANSPORT_MONITOR_REG_REPLACED,
3097         /*!
3098          * \brief Transport not found to monitor.
3099          * \note Transport is either already shutdown or is not reliable.
3100          */
3101         AST_TRANSPORT_MONITOR_REG_NOT_FOUND,
3102         /*! \brief Error while registering transport monitor. */
3103         AST_TRANSPORT_MONITOR_REG_FAILED,
3104 };
3105
3106 /*!
3107  * \brief Register a reliable transport shutdown monitor callback.
3108  * \since 13.20.0
3109  *
3110  * \param transport Transport to monitor for shutdown.
3111  * \param cb Who to call when transport is shutdown.
3112  * \param ao2_data Data to pass with the callback.
3113  *
3114  * \note The data object passed will have its reference count automatically
3115  * incremented by this call and automatically decremented after the callback
3116  * runs or when the callback is unregistered.
3117  *
3118  * There is no checking for duplicate registrations.
3119  *
3120  * \return enum ast_transport_monitor_reg
3121  */
3122 enum ast_transport_monitor_reg ast_sip_transport_monitor_register(pjsip_transport *transport,
3123         ast_transport_monitor_shutdown_cb cb, void *ao2_data);
3124
3125 /*!
3126  * \brief Unregister a reliable transport shutdown monitor
3127  * \since 13.20.0
3128  *
3129  * \param transport Transport to monitor for shutdown.
3130  * \param cb The callback that was used for the original register.
3131  * \param data Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object.
3132  *             If NULL, all monitors with the provided callbck are unregistered.
3133  * \param matches Matcher function that returns true if data matches the previously
3134  *                registered data object.  If NULL, a simple pointer comparison is done.
3135  *
3136  * \note The data object passed into the original register will have its reference count
3137  * automatically decremeneted.
3138  *
3139  * \return Nothing
3140  */
3141 void ast_sip_transport_monitor_unregister(pjsip_transport *transport,
3142         ast_transport_monitor_shutdown_cb cb, void *data, ast_transport_monitor_data_matcher matches);
3143
3144 /*!
3145  * \brief Unregister a transport shutdown monitor from all reliable transports
3146  * \since 13.20.0
3147  *
3148  * \param cb The callback that was used for the original register.
3149  * \param data Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object.
3150  *             If NULL, all monitors with the provided callbck are unregistered.
3151  * \param matches Matcher function that returns true if ao2_data matches the previously
3152  *                registered data object.  If NULL, a simple pointer comparison is done.
3153  *
3154  * \note The data object passed into the original register will have its reference count
3155  * automatically decremeneted.
3156  *
3157  * \return Nothing
3158  */
3159 void ast_sip_transport_monitor_unregister_all(ast_transport_monitor_shutdown_cb cb,
3160         void *data, ast_transport_monitor_data_matcher matches);
3161
3162 /*! Transport state notification registration element.  */
3163 struct ast_sip_tpmgr_state_callback {
3164         /*! PJPROJECT transport state notification callback */
3165         pjsip_tp_state_callback cb;
3166         AST_LIST_ENTRY(ast_sip_tpmgr_state_callback) node;
3167 };
3168
3169 /*!
3170  * \brief Register a transport state notification callback element.
3171  * \since 13.18.0
3172  *
3173  * \param element What we are registering.
3174  *
3175  * \return Nothing
3176  */
3177 void ast_sip_transport_state_register(struct ast_sip_tpmgr_state_callback *element);
3178
3179 /*!
3180  * \brief Unregister a transport state notification callback element.
3181  * \since 13.18.0
3182  *
3183  * \param element What we are unregistering.
3184  *
3185  * \return Nothing
3186  */
3187 void ast_sip_transport_state_unregister(struct ast_sip_tpmgr_state_callback *element);
3188
3189 #endif /* _RES_PJSIP_H */