b94269a32673e24194c5880922eba4882fd7fd0c
[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 };
817
818 /*! URI parameter for symmetric transport */
819 #define AST_SIP_X_AST_TXP "x-ast-txp"
820 #define AST_SIP_X_AST_TXP_LEN 9
821
822 /*!
823  * \brief Initialize an auth vector with the configured values.
824  *
825  * \param vector Vector to initialize
826  * \param auth_names Comma-separated list of names to set in the array
827  * \retval 0 Success
828  * \retval non-zero Failure
829  */
830 int ast_sip_auth_vector_init(struct ast_sip_auth_vector *vector, const char *auth_names);
831
832 /*!
833  * \brief Free contents of an auth vector.
834  *
835  * \param array Vector whose contents are to be freed
836  */
837 void ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector);
838
839 /*!
840  * \brief Possible returns from ast_sip_check_authentication
841  */
842 enum ast_sip_check_auth_result {
843     /*! Authentication needs to be challenged */
844     AST_SIP_AUTHENTICATION_CHALLENGE,
845     /*! Authentication succeeded */
846     AST_SIP_AUTHENTICATION_SUCCESS,
847     /*! Authentication failed */
848     AST_SIP_AUTHENTICATION_FAILED,
849     /*! Authentication encountered some internal error */
850     AST_SIP_AUTHENTICATION_ERROR,
851 };
852
853 /*!
854  * \brief An interchangeable way of handling digest authentication for SIP.
855  *
856  * An authenticator is responsible for filling in the callbacks provided below. Each is called from a publicly available
857  * function in res_sip. The authenticator can use configuration or other local policy to determine whether authentication
858  * should take place and what credentials should be used when challenging and authenticating a request.
859  */
860 struct ast_sip_authenticator {
861     /*!
862      * \brief Check if a request requires authentication
863      * See ast_sip_requires_authentication for more details
864      */
865     int (*requires_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
866         /*!
867          * \brief Check that an incoming request passes authentication.
868          *
869          * The tdata parameter is useful for adding information such as digest challenges.
870          *
871          * \param endpoint The endpoint sending the incoming request
872          * \param rdata The incoming request
873          * \param tdata Tentative outgoing request.
874          */
875         enum ast_sip_check_auth_result (*check_authentication)(struct ast_sip_endpoint *endpoint,
876                         pjsip_rx_data *rdata, pjsip_tx_data *tdata);
877 };
878
879 /*!
880  * \brief an interchangeable way of responding to authentication challenges
881  *
882  * An outbound authenticator takes incoming challenges and formulates a new SIP request with
883  * credentials.
884  */
885 struct ast_sip_outbound_authenticator {
886         /*!
887          * \brief Create a new request with authentication credentials
888          *
889          * \param auths A vector of IDs of auth sorcery objects
890          * \param challenge The SIP response with authentication challenge(s)
891          * \param old_request The request that received the auth challenge(s)
892          * \param new_request The new SIP request with challenge response(s)
893          * \retval 0 Successfully created new request
894          * \retval -1 Failed to create a new request
895          */
896         int (*create_request_with_auth)(const struct ast_sip_auth_vector *auths, struct pjsip_rx_data *challenge,
897                         struct pjsip_tx_data *old_request, struct pjsip_tx_data **new_request);
898 };
899
900 /*!
901  * \brief An entity responsible for identifying the source of a SIP message
902  */
903 struct ast_sip_endpoint_identifier {
904     /*!
905      * \brief Callback used to identify the source of a message.
906      * See ast_sip_identify_endpoint for more details
907      */
908     struct ast_sip_endpoint *(*identify_endpoint)(pjsip_rx_data *rdata);
909 };
910
911 /*!
912  * \brief Contact retrieval filtering flags
913  */
914 enum ast_sip_contact_filter {
915         /*! \brief Default filter flags */
916         AST_SIP_CONTACT_FILTER_DEFAULT = 0,
917
918         /*! \brief Return only reachable or unknown contacts */
919         AST_SIP_CONTACT_FILTER_REACHABLE = (1 << 0),
920 };
921
922 /*!
923  * \brief Register a SIP service in Asterisk.
924  *
925  * This is more-or-less a wrapper around pjsip_endpt_register_module().
926  * Registering a service makes it so that PJSIP will call into the
927  * service at appropriate times. For more information about PJSIP module
928  * callbacks, see the PJSIP documentation. Asterisk modules that call
929  * this function will likely do so at module load time.
930  *
931  * \param module The module that is to be registered with PJSIP
932  * \retval 0 Success
933  * \retval -1 Failure
934  */
935 int ast_sip_register_service(pjsip_module *module);
936
937 /*!
938  * This is the opposite of ast_sip_register_service().  Unregistering a
939  * service means that PJSIP will no longer call into the module any more.
940  * This will likely occur when an Asterisk module is unloaded.
941  *
942  * \param module The PJSIP module to unregister
943  */
944 void ast_sip_unregister_service(pjsip_module *module);
945
946 /*!
947  * \brief Register a SIP authenticator
948  *
949  * An authenticator has three main purposes:
950  * 1) Determining if authentication should be performed on an incoming request
951  * 2) Gathering credentials necessary for issuing an authentication challenge
952  * 3) Authenticating a request that has credentials
953  *
954  * Asterisk provides a default authenticator, but it may be replaced by a
955  * custom one if desired.
956  *
957  * \param auth The authenticator to register
958  * \retval 0 Success
959  * \retval -1 Failure
960  */
961 int ast_sip_register_authenticator(struct ast_sip_authenticator *auth);
962
963 /*!
964  * \brief Unregister a SIP authenticator
965  *
966  * When there is no authenticator registered, requests cannot be challenged
967  * or authenticated.
968  *
969  * \param auth The authenticator to unregister
970  */
971 void ast_sip_unregister_authenticator(struct ast_sip_authenticator *auth);
972
973  /*!
974  * \brief Register an outbound SIP authenticator
975  *
976  * An outbound authenticator is responsible for creating responses to
977  * authentication challenges by remote endpoints.
978  *
979  * \param auth The authenticator to register
980  * \retval 0 Success
981  * \retval -1 Failure
982  */
983 int ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth);
984
985 /*!
986  * \brief Unregister an outbound SIP authenticator
987  *
988  * When there is no outbound authenticator registered, authentication challenges
989  * will be handled as any other final response would be.
990  *
991  * \param auth The authenticator to unregister
992  */
993 void ast_sip_unregister_outbound_authenticator(struct ast_sip_outbound_authenticator *auth);
994
995 /*!
996  * \brief Register a SIP endpoint identifier with a name.
997  *
998  * An endpoint identifier's purpose is to determine which endpoint a given SIP
999  * message has come from.
1000  *
1001  * Multiple endpoint identifiers may be registered so that if an endpoint
1002  * cannot be identified by one identifier, it may be identified by another.
1003  *
1004  * \param identifier The SIP endpoint identifier to register
1005  * \param name The name of the endpoint identifier
1006  * \retval 0 Success
1007  * \retval -1 Failure
1008  */
1009 int ast_sip_register_endpoint_identifier_with_name(struct ast_sip_endpoint_identifier *identifier,
1010                                                    const char *name);
1011
1012 /*!
1013  * \brief Register a SIP endpoint identifier
1014  *
1015  * An endpoint identifier's purpose is to determine which endpoint a given SIP
1016  * message has come from.
1017  *
1018  * Multiple endpoint identifiers may be registered so that if an endpoint
1019  * cannot be identified by one identifier, it may be identified by another.
1020  *
1021  * Asterisk provides two endpoint identifiers. One identifies endpoints based
1022  * on the user part of the From header URI. The other identifies endpoints based
1023  * on the source IP address.
1024  *
1025  * If the order in which endpoint identifiers is run is important to you, then
1026  * be sure to load individual endpoint identifier modules in the order you wish
1027  * for them to be run in modules.conf
1028  *
1029  * \note endpoint identifiers registered using this method (no name specified)
1030  *       are placed at the front of the endpoint identifiers list ahead of any
1031  *       named identifiers.
1032  *
1033  * \param identifier The SIP endpoint identifier to register
1034  * \retval 0 Success
1035  * \retval -1 Failure
1036  */
1037 int ast_sip_register_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
1038
1039 /*!
1040  * \brief Unregister a SIP endpoint identifier
1041  *
1042  * This stops an endpoint identifier from being used.
1043  *
1044  * \param identifier The SIP endoint identifier to unregister
1045  */
1046 void ast_sip_unregister_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
1047
1048 /*!
1049  * \brief Allocate a new SIP endpoint
1050  *
1051  * This will return an endpoint with its refcount increased by one. This reference
1052  * can be released using ao2_ref().
1053  *
1054  * \param name The name of the endpoint.
1055  * \retval NULL Endpoint allocation failed
1056  * \retval non-NULL The newly allocated endpoint
1057  */
1058 void *ast_sip_endpoint_alloc(const char *name);
1059
1060 /*!
1061  * \brief Change state of a persistent endpoint.
1062  *
1063  * \param endpoint_name The SIP endpoint name to change state.
1064  * \param state The new state
1065  * \retval 0 Success
1066  * \retval -1 Endpoint not found
1067  */
1068 int ast_sip_persistent_endpoint_update_state(const char *endpoint_name, enum ast_endpoint_state state);
1069
1070 /*!
1071  * \brief Publish the change of state for a contact.
1072  *
1073  * \param endpoint_name The SIP endpoint name.
1074  * \param contact_status The contact status.
1075  */
1076 void ast_sip_persistent_endpoint_publish_contact_state(const char *endpoint_name, const struct ast_sip_contact_status *contact_status);
1077
1078 /*!
1079  * \brief Retrieve the current status for a contact.
1080  *
1081  * \param contact The contact.
1082  *
1083  * \retval non-NULL Success
1084  * \retval NULL Status information not found
1085  *
1086  * \note The returned contact status object is immutable.
1087  */
1088 struct ast_sip_contact_status *ast_sip_get_contact_status(const struct ast_sip_contact *contact);
1089
1090 /*!
1091  * \brief Get a pointer to the PJSIP endpoint.
1092  *
1093  * This is useful when modules have specific information they need
1094  * to register with the PJSIP core.
1095  * \retval NULL endpoint has not been created yet.
1096  * \retval non-NULL PJSIP endpoint.
1097  */
1098 pjsip_endpoint *ast_sip_get_pjsip_endpoint(void);
1099
1100 /*!
1101  * \brief Get a pointer to the SIP sorcery structure.
1102  *
1103  * \retval NULL sorcery has not been initialized
1104  * \retval non-NULL sorcery structure
1105  */
1106 struct ast_sorcery *ast_sip_get_sorcery(void);
1107
1108 /*!
1109  * \brief Retrieve a named AOR
1110  *
1111  * \param aor_name Name of the AOR
1112  *
1113  * \retval NULL if not found
1114  * \retval non-NULL if found
1115  */
1116 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name);
1117
1118 /*!
1119  * \brief Retrieve the first bound contact for an AOR
1120  *
1121  * \param aor Pointer to the AOR
1122  * \retval NULL if no contacts available
1123  * \retval non-NULL if contacts available
1124  */
1125 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor);
1126
1127 /*!
1128  * \brief Retrieve the first bound contact for an AOR and filter based on flags
1129  * \since 13.16.0
1130  *
1131  * \param aor Pointer to the AOR
1132  * \param flags Filtering flags
1133  * \retval NULL if no contacts available
1134  * \retval non-NULL if contacts available
1135  */
1136 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact_filtered(const struct ast_sip_aor *aor,
1137         unsigned int flags);
1138
1139 /*!
1140  * \brief Retrieve all contacts currently available for an AOR
1141  *
1142  * \param aor Pointer to the AOR
1143  *
1144  * \retval NULL if no contacts available
1145  * \retval non-NULL if contacts available
1146  *
1147  * \warning
1148  * Since this function prunes expired contacts before returning, it holds a named write
1149  * lock on the aor.  If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.
1150  */
1151 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor);
1152
1153 /*!
1154  * \brief Retrieve all contacts currently available for an AOR and filter based on flags
1155  * \since 13.16.0
1156  *
1157  * \param aor Pointer to the AOR
1158  * \param flags Filtering flags
1159  *
1160  * \retval NULL if no contacts available
1161  * \retval non-NULL if contacts available
1162  *
1163  * \warning
1164  * Since this function prunes expired contacts before returning, it holds a named write
1165  * lock on the aor.  If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.
1166  */
1167 struct ao2_container *ast_sip_location_retrieve_aor_contacts_filtered(const struct ast_sip_aor *aor,
1168         unsigned int flags);
1169
1170 /*!
1171  * \brief Retrieve all contacts currently available for an AOR without locking the AOR
1172  * \since 13.9.0
1173  *
1174  * \param aor Pointer to the AOR
1175  *
1176  * \retval NULL if no contacts available
1177  * \retval non-NULL if contacts available
1178  *
1179  * \warning
1180  * This function should only be called if you already hold a named write lock on the aor.
1181  */
1182 struct ao2_container *ast_sip_location_retrieve_aor_contacts_nolock(const struct ast_sip_aor *aor);
1183
1184 /*!
1185  * \brief Retrieve all contacts currently available for an AOR without locking the AOR and filter based on flags
1186  * \since 13.16.0
1187  *
1188  * \param aor Pointer to the AOR
1189  * \param flags Filtering flags
1190  *
1191  * \retval NULL if no contacts available
1192  * \retval non-NULL if contacts available
1193  *
1194  * \warning
1195  * This function should only be called if you already hold a named write lock on the aor.
1196  */
1197 struct ao2_container *ast_sip_location_retrieve_aor_contacts_nolock_filtered(const struct ast_sip_aor *aor,
1198         unsigned int flags);
1199
1200 /*!
1201  * \brief Retrieve the first bound contact from a list of AORs
1202  *
1203  * \param aor_list A comma-separated list of AOR names
1204  * \retval NULL if no contacts available
1205  * \retval non-NULL if contacts available
1206  */
1207 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list);
1208
1209 /*!
1210  * \brief Retrieve all contacts from a list of AORs
1211  *
1212  * \param aor_list A comma-separated list of AOR names
1213  * \retval NULL if no contacts available
1214  * \retval non-NULL container (which must be freed) if contacts available
1215  */
1216 struct ao2_container *ast_sip_location_retrieve_contacts_from_aor_list(const char *aor_list);
1217
1218 /*!
1219  * \brief Retrieve the first bound contact AND the AOR chosen from a list of AORs
1220  *
1221  * \param aor_list A comma-separated list of AOR names
1222  * \param aor The chosen AOR
1223  * \param contact The chosen contact
1224  */
1225  void ast_sip_location_retrieve_contact_and_aor_from_list(const char *aor_list, struct ast_sip_aor **aor,
1226         struct ast_sip_contact **contact);
1227
1228 /*!
1229  * \brief Retrieve the first bound contact AND the AOR chosen from a list of AORs and filter based on flags
1230  * \since 13.16.0
1231  *
1232  * \param aor_list A comma-separated list of AOR names
1233  * \param flags Filtering flags
1234  * \param aor The chosen AOR
1235  * \param contact The chosen contact
1236  */
1237 void ast_sip_location_retrieve_contact_and_aor_from_list_filtered(const char *aor_list, unsigned int flags,
1238         struct ast_sip_aor **aor, struct ast_sip_contact **contact);
1239
1240 /*!
1241  * \brief Retrieve a named contact
1242  *
1243  * \param contact_name Name of the contact
1244  *
1245  * \retval NULL if not found
1246  * \retval non-NULL if found
1247  */
1248 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name);
1249
1250 /*!
1251  * \brief Add a new contact to an AOR
1252  *
1253  * \param aor Pointer to the AOR
1254  * \param uri Full contact URI
1255  * \param expiration_time Optional expiration time of the contact
1256  * \param path_info Path information
1257  * \param user_agent User-Agent header from REGISTER request
1258  * \param via_addr
1259  * \param via_port
1260  * \param call_id
1261  * \param endpoint The endpoint that resulted in the contact being added
1262  *
1263  * \retval -1 failure
1264  * \retval 0 success
1265  *
1266  * \warning
1267  * This function holds a named write lock on the aor.  If you already hold the lock
1268  * you should call ast_sip_location_add_contact_nolock instead.
1269  */
1270 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri,
1271         struct timeval expiration_time, const char *path_info, const char *user_agent,
1272         const char *via_addr, int via_port, const char *call_id,
1273         struct ast_sip_endpoint *endpoint);
1274
1275 /*!
1276  * \brief Add a new contact to an AOR without locking the AOR
1277  * \since 13.9.0
1278  *
1279  * \param aor Pointer to the AOR
1280  * \param uri Full contact URI
1281  * \param expiration_time Optional expiration time of the contact
1282  * \param path_info Path information
1283  * \param user_agent User-Agent header from REGISTER request
1284  * \param via_addr
1285  * \param via_port
1286  * \param call_id
1287  * \param endpoint The endpoint that resulted in the contact being added
1288  *
1289  * \retval -1 failure
1290  * \retval 0 success
1291  *
1292  * \warning
1293  * This function should only be called if you already hold a named write lock on the aor.
1294  */
1295 int ast_sip_location_add_contact_nolock(struct ast_sip_aor *aor, const char *uri,
1296         struct timeval expiration_time, const char *path_info, const char *user_agent,
1297         const char *via_addr, int via_port, const char *call_id,
1298         struct ast_sip_endpoint *endpoint);
1299
1300 /*!
1301  * \brief Create a new contact for an AOR without locking the AOR
1302  * \since 13.18.0
1303  *
1304  * \param aor Pointer to the AOR
1305  * \param uri Full contact URI
1306  * \param expiration_time Optional expiration time of the contact
1307  * \param path_info Path information
1308  * \param user_agent User-Agent header from REGISTER request
1309  * \param via_addr
1310  * \param via_port
1311  * \param call_id
1312  * \param prune_on_boot Non-zero if the contact cannot survive a restart/boot.
1313  * \param endpoint The endpoint that resulted in the contact being added
1314  *
1315  * \return The created contact or NULL on failure.
1316  *
1317  * \warning
1318  * This function should only be called if you already hold a named write lock on the aor.
1319  */
1320 struct ast_sip_contact *ast_sip_location_create_contact(struct ast_sip_aor *aor,
1321         const char *uri, struct timeval expiration_time, const char *path_info,
1322         const char *user_agent, const char *via_addr, int via_port, const char *call_id,
1323         int prune_on_boot, struct ast_sip_endpoint *endpoint);
1324
1325 /*!
1326  * \brief Update a contact
1327  *
1328  * \param contact New contact object with details
1329  *
1330  * \retval -1 failure
1331  * \retval 0 success
1332  */
1333 int ast_sip_location_update_contact(struct ast_sip_contact *contact);
1334
1335 /*!
1336 * \brief Delete a contact
1337 *
1338 * \param contact Contact object to delete
1339 *
1340 * \retval -1 failure
1341 * \retval 0 success
1342 */
1343 int ast_sip_location_delete_contact(struct ast_sip_contact *contact);
1344
1345 /*!
1346  * \brief Prune the prune_on_boot contacts
1347  * \since 13.18.0
1348  */
1349 void ast_sip_location_prune_boot_contacts(void);
1350
1351 /*!
1352  * \brief Callback called when an outbound request with authentication credentials is to be sent in dialog
1353  *
1354  * This callback will have the created request on it. The callback's purpose is to do any extra
1355  * housekeeping that needs to be done as well as to send the request out.
1356  *
1357  * This callback is only necessary if working with a PJSIP API that sits between the application
1358  * and the dialog layer.
1359  *
1360  * \param dlg The dialog to which the request belongs
1361  * \param tdata The created request to be sent out
1362  * \param user_data Data supplied with the callback
1363  *
1364  * \retval 0 Success
1365  * \retval -1 Failure
1366  */
1367 typedef int (*ast_sip_dialog_outbound_auth_cb)(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data);
1368
1369 /*!
1370  * \brief Set up outbound authentication on a SIP dialog
1371  *
1372  * This sets up the infrastructure so that all requests associated with a created dialog
1373  * can be re-sent with authentication credentials if the original request is challenged.
1374  *
1375  * \param dlg The dialog on which requests will be authenticated
1376  * \param endpoint The endpoint whom this dialog pertains to
1377  * \param cb Callback to call to send requests with authentication
1378  * \param user_data Data to be provided to the callback when it is called
1379  *
1380  * \retval 0 Success
1381  * \retval -1 Failure
1382  */
1383 int ast_sip_dialog_setup_outbound_authentication(pjsip_dialog *dlg, const struct ast_sip_endpoint *endpoint,
1384                 ast_sip_dialog_outbound_auth_cb cb, void *user_data);
1385
1386 /*!
1387  * \brief Retrieves a reference to the artificial auth.
1388  *
1389  * \retval The artificial auth
1390  */
1391 struct ast_sip_auth *ast_sip_get_artificial_auth(void);
1392
1393 /*!
1394  * \brief Retrieves a reference to the artificial endpoint.
1395  *
1396  * \retval The artificial endpoint
1397  */
1398 struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void);
1399
1400 /*! \defgroup pjsip_threading PJSIP Threading Model
1401  * @{
1402  * \page PJSIP PJSIP Threading Model
1403  *
1404  * There are three major types of threads that SIP will have to deal with:
1405  * \li Asterisk threads
1406  * \li PJSIP threads
1407  * \li SIP threadpool threads (a.k.a. "servants")
1408  *
1409  * \par Asterisk Threads
1410  *
1411  * Asterisk threads are those that originate from outside of SIP but within
1412  * Asterisk. The most common of these threads are PBX (channel) threads and
1413  * the autoservice thread. Most interaction with these threads will be through
1414  * channel technology callbacks. Within these threads, it is fine to handle
1415  * Asterisk data from outside of SIP, but any handling of SIP data should be
1416  * left to servants, \b especially if you wish to call into PJSIP for anything.
1417  * Asterisk threads are not registered with PJLIB, so attempting to call into
1418  * PJSIP will cause an assertion to be triggered, thus causing the program to
1419  * crash.
1420  *
1421  * \par PJSIP Threads
1422  *
1423  * PJSIP threads are those that originate from handling of PJSIP events, such
1424  * as an incoming SIP request or response, or a transaction timeout. The role
1425  * of these threads is to process information as quickly as possible so that
1426  * the next item on the SIP socket(s) can be serviced. On incoming messages,
1427  * Asterisk automatically will push the request to a servant thread. When your
1428  * module callback is called, processing will already be in a servant. However,
1429  * for other PJSIP events, such as transaction state changes due to timer
1430  * expirations, your module will be called into from a PJSIP thread. If you
1431  * are called into from a PJSIP thread, then you should push whatever processing
1432  * is needed to a servant as soon as possible. You can discern if you are currently
1433  * in a SIP servant thread using the \ref ast_sip_thread_is_servant function.
1434  *
1435  * \par Servants
1436  *
1437  * Servants are where the bulk of SIP work should be performed. These threads
1438  * exist in order to do the work that Asterisk threads and PJSIP threads hand
1439  * off to them. Servant threads register themselves with PJLIB, meaning that
1440  * they are capable of calling PJSIP and PJLIB functions if they wish.
1441  *
1442  * \par Serializer
1443  *
1444  * Tasks are handed off to servant threads using the API call \ref ast_sip_push_task.
1445  * The first parameter of this call is a serializer. If this pointer
1446  * is NULL, then the work will be handed off to whatever servant can currently handle
1447  * the task. If this pointer is non-NULL, then the task will not be executed until
1448  * previous tasks pushed with the same serializer have completed. For more information
1449  * on serializers and the benefits they provide, see \ref ast_threadpool_serializer
1450  *
1451  * \par Scheduler
1452  *
1453  * Some situations require that a task run periodically or at a future time.  Normally
1454  * the ast_sched functionality would be used but ast_sched only uses 1 thread for all
1455  * tasks and that thread isn't registered with PJLIB and therefore can't do any PJSIP
1456  * related work.
1457  *
1458  * ast_sip_sched uses ast_sched only as a scheduled queue.  When a task is ready to run,
1459  * it's pushed to a Serializer to be invoked asynchronously by a Servant.  This ensures
1460  * that the task is executed in a PJLIB registered thread and allows the ast_sched thread
1461  * to immediately continue processing the queue.  The Serializer used by ast_sip_sched
1462  * is one of your choosing or a random one from the res_pjsip pool if you don't choose one.
1463  *
1464  * \note
1465  *
1466  * Do not make assumptions about individual threads based on a corresponding serializer.
1467  * In other words, just because several tasks use the same serializer when being pushed
1468  * to servants, it does not mean that the same thread is necessarily going to execute those
1469  * tasks, even though they are all guaranteed to be executed in sequence.
1470  */
1471
1472 typedef int (*ast_sip_task)(void *user_data);
1473
1474 /*!
1475  * \brief Create a new serializer for SIP tasks
1476  * \since 13.8.0
1477  *
1478  * See \ref ast_threadpool_serializer for more information on serializers.
1479  * SIP creates serializers so that tasks operating on similar data will run
1480  * in sequence.
1481  *
1482  * \param name Name of the serializer. (must be unique)
1483  *
1484  * \retval NULL Failure
1485  * \retval non-NULL Newly-created serializer
1486  */
1487 struct ast_taskprocessor *ast_sip_create_serializer(const char *name);
1488
1489 struct ast_serializer_shutdown_group;
1490
1491 /*!
1492  * \brief Create a new serializer for SIP tasks
1493  * \since 13.8.0
1494  *
1495  * See \ref ast_threadpool_serializer for more information on serializers.
1496  * SIP creates serializers so that tasks operating on similar data will run
1497  * in sequence.
1498  *
1499  * \param name Name of the serializer. (must be unique)
1500  * \param shutdown_group Group shutdown controller. (NULL if no group association)
1501  *
1502  * \retval NULL Failure
1503  * \retval non-NULL Newly-created serializer
1504  */
1505 struct ast_taskprocessor *ast_sip_create_serializer_group(const char *name, struct ast_serializer_shutdown_group *shutdown_group);
1506
1507 /*!
1508  * \brief Determine the distributor serializer for the SIP message.
1509  * \since 13.10.0
1510  *
1511  * \param rdata The incoming message.
1512  *
1513  * \retval Calculated distributor serializer on success.
1514  * \retval NULL on error.
1515  */
1516 struct ast_taskprocessor *ast_sip_get_distributor_serializer(pjsip_rx_data *rdata);
1517
1518 /*!
1519  * \brief Set a serializer on a SIP dialog so requests and responses are automatically serialized
1520  *
1521  * Passing a NULL serializer is a way to remove a serializer from a dialog.
1522  *
1523  * \param dlg The SIP dialog itself
1524  * \param serializer The serializer to use
1525  */
1526 void ast_sip_dialog_set_serializer(pjsip_dialog *dlg, struct ast_taskprocessor *serializer);
1527
1528 /*!
1529  * \brief Set an endpoint on a SIP dialog so in-dialog requests do not undergo endpoint lookup.
1530  *
1531  * \param dlg The SIP dialog itself
1532  * \param endpoint The endpoint that this dialog is communicating with
1533  */
1534 void ast_sip_dialog_set_endpoint(pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
1535
1536 /*!
1537  * \brief Get the endpoint associated with this dialog
1538  *
1539  * This function increases the refcount of the endpoint by one. Release
1540  * the reference once you are finished with the endpoint.
1541  *
1542  * \param dlg The SIP dialog from which to retrieve the endpoint
1543  * \retval NULL No endpoint associated with this dialog
1544  * \retval non-NULL The endpoint.
1545  */
1546 struct ast_sip_endpoint *ast_sip_dialog_get_endpoint(pjsip_dialog *dlg);
1547
1548 /*!
1549  * \brief Pushes a task to SIP servants
1550  *
1551  * This uses the serializer provided to determine how to push the task.
1552  * If the serializer is NULL, then the task will be pushed to the
1553  * servants directly. If the serializer is non-NULL, then the task will be
1554  * queued behind other tasks associated with the same serializer.
1555  *
1556  * \param serializer The serializer to which the task belongs. Can be NULL
1557  * \param sip_task The task to execute
1558  * \param task_data The parameter to pass to the task when it executes
1559  * \retval 0 Success
1560  * \retval -1 Failure
1561  */
1562 int ast_sip_push_task(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1563
1564 /*!
1565  * \brief Push a task to SIP servants and wait for it to complete.
1566  *
1567  * Like \ref ast_sip_push_task except that it blocks until the task
1568  * completes.  If the current thread is a SIP servant thread then the
1569  * task executes immediately.  Otherwise, the specified serializer
1570  * executes the task and the current thread waits for it to complete.
1571  *
1572  * \note PJPROJECT callbacks tend to have locks already held when
1573  * called.
1574  *
1575  * \warning \b Never hold locks that may be acquired by a SIP servant
1576  * thread when calling this function.  Doing so may cause a deadlock
1577  * if all SIP servant threads are blocked waiting to acquire the lock
1578  * while the thread holding the lock is waiting for a free SIP servant
1579  * thread.
1580  *
1581  * \warning \b Use of this function in an ao2 destructor callback is a
1582  * bad idea.  You don't have control over which thread executes the
1583  * destructor.  Attempting to shift execution to another thread with
1584  * this function is likely to cause deadlock.
1585  *
1586  * \param serializer The SIP serializer to execute the task if the
1587  * current thread is not a SIP servant.  NULL if any of the default
1588  * serializers can be used.
1589  * \param sip_task The task to execute
1590  * \param task_data The parameter to pass to the task when it executes
1591  *
1592  * \note The sip_task() return value may need to be distinguished from
1593  * the failure to push the task.
1594  *
1595  * \return sip_task() return value on success.
1596  * \retval -1 Failure to push the task.
1597  */
1598 int ast_sip_push_task_wait_servant(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1599
1600 /*!
1601  * \brief Push a task to SIP servants and wait for it to complete.
1602  * \deprecated Replaced with ast_sip_push_task_wait_servant().
1603  */
1604 int ast_sip_push_task_synchronous(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1605
1606 /*!
1607  * \brief Push a task to the serializer and wait for it to complete.
1608  *
1609  * Like \ref ast_sip_push_task except that it blocks until the task is
1610  * completed by the specified serializer.  If the specified serializer
1611  * is the current thread then the task executes immediately.
1612  *
1613  * \note PJPROJECT callbacks tend to have locks already held when
1614  * called.
1615  *
1616  * \warning \b Never hold locks that may be acquired by a SIP servant
1617  * thread when calling this function.  Doing so may cause a deadlock
1618  * if all SIP servant threads are blocked waiting to acquire the lock
1619  * while the thread holding the lock is waiting for a free SIP servant
1620  * thread for the serializer to execute in.
1621  *
1622  * \warning \b Never hold locks that may be acquired by the serializer
1623  * when calling this function.  Doing so will cause a deadlock.
1624  *
1625  * \warning \b Never use this function in the pjsip monitor thread (It
1626  * is a SIP servant thread).  This is likely to cause a deadlock.
1627  *
1628  * \warning \b Use of this function in an ao2 destructor callback is a
1629  * bad idea.  You don't have control over which thread executes the
1630  * destructor.  Attempting to shift execution to another thread with
1631  * this function is likely to cause deadlock.
1632  *
1633  * \param serializer The SIP serializer to execute the task.  NULL if
1634  * any of the default serializers can be used.
1635  * \param sip_task The task to execute
1636  * \param task_data The parameter to pass to the task when it executes
1637  *
1638  * \note It is generally better to call
1639  * ast_sip_push_task_wait_servant() if you pass NULL for the
1640  * serializer parameter.
1641  *
1642  * \note The sip_task() return value may need to be distinguished from
1643  * the failure to push the task.
1644  *
1645  * \return sip_task() return value on success.
1646  * \retval -1 Failure to push the task.
1647  */
1648 int ast_sip_push_task_wait_serializer(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1649
1650 /*!
1651  * \brief Determine if the current thread is a SIP servant thread
1652  *
1653  * \retval 0 This is not a SIP servant thread
1654  * \retval 1 This is a SIP servant thread
1655  */
1656 int ast_sip_thread_is_servant(void);
1657
1658 /*!
1659  * \brief Task flags for the res_pjsip scheduler
1660  *
1661  * The default is AST_SIP_SCHED_TASK_FIXED
1662  *                | AST_SIP_SCHED_TASK_DATA_NOT_AO2
1663  *                | AST_SIP_SCHED_TASK_DATA_NO_CLEANUP
1664  *                | AST_SIP_SCHED_TASK_PERIODIC
1665  */
1666 enum ast_sip_scheduler_task_flags {
1667         /*!
1668          * The defaults
1669          */
1670         AST_SIP_SCHED_TASK_DEFAULTS = (0 << 0),
1671
1672         /*!
1673          * Run at a fixed interval.
1674          * Stop scheduling if the callback returns <= 0.
1675          * Any other value is ignored.
1676          */
1677         AST_SIP_SCHED_TASK_FIXED = (0 << 0),
1678         /*!
1679          * Run at a variable interval.
1680          * Stop scheduling if the callback returns <= 0.
1681          * Any other return value is used as the new interval.
1682          */
1683         AST_SIP_SCHED_TASK_VARIABLE = (1 << 0),
1684
1685         /*!
1686          * The task data is not an AO2 object.
1687          */
1688         AST_SIP_SCHED_TASK_DATA_NOT_AO2 = (0 << 1),
1689         /*!
1690          * The task data is an AO2 object.
1691          * A reference count will be held by the scheduler until
1692          * after the task has run for the final time (if ever).
1693          */
1694         AST_SIP_SCHED_TASK_DATA_AO2 = (1 << 1),
1695
1696         /*!
1697          * Don't take any cleanup action on the data
1698          */
1699         AST_SIP_SCHED_TASK_DATA_NO_CLEANUP = (0 << 3),
1700         /*!
1701          * If AST_SIP_SCHED_TASK_DATA_AO2 is set, decrement the reference count
1702          * otherwise call ast_free on it.
1703          */
1704         AST_SIP_SCHED_TASK_DATA_FREE = ( 1 << 3 ),
1705
1706         /*!
1707          * \brief The task is scheduled at multiples of interval
1708          * \see Interval
1709          */
1710         AST_SIP_SCHED_TASK_PERIODIC = (0 << 4),
1711         /*!
1712          * \brief The next invocation of the task is at last finish + interval
1713          * \see Interval
1714          */
1715         AST_SIP_SCHED_TASK_DELAY = (1 << 4),
1716         /*!
1717          * \brief The scheduled task's events are tracked in the debug log.
1718          * \details
1719          * Schedule events such as scheduling, running, rescheduling, canceling,
1720          * and destroying are logged about the task.
1721          */
1722         AST_SIP_SCHED_TASK_TRACK = (1 << 5),
1723 };
1724
1725 /*!
1726  * \brief Scheduler task data structure
1727  */
1728 struct ast_sip_sched_task;
1729
1730 /*!
1731  * \brief Schedule a task to run in the res_pjsip thread pool
1732  * \since 13.9.0
1733  *
1734  * \param serializer The serializer to use.  If NULL, don't use a serializer (see note below)
1735  * \param interval The invocation interval in milliseconds (see note below)
1736  * \param sip_task The task to invoke
1737  * \param name An optional name to associate with the task
1738  * \param task_data Optional data to pass to the task
1739  * \param flags One of enum ast_sip_scheduler_task_type
1740  *
1741  * \returns Pointer to \ref ast_sip_sched_task ao2 object which must be dereferenced when done.
1742  *
1743  * \paragraph Serialization
1744  *
1745  * Specifying a serializer guarantees serialized execution but NOT specifying a serializer
1746  * may still result in tasks being effectively serialized if the thread pool is busy.
1747  * The point of the serializer BTW is not to prevent parallel executions of the SAME task.
1748  * That happens automatically (see below).  It's to prevent the task from running at the same
1749  * time as other work using the same serializer, whether or not it's being run by the scheduler.
1750  *
1751  * \paragraph Interval
1752  *
1753  * The interval is used to calculate the next time the task should run.  There are two models.
1754  *
1755  * \ref AST_SIP_SCHED_TASK_PERIODIC specifies that the invocations of the task occur at the
1756  * specific interval.  That is, every \ref "interval" milliseconds, regardless of how long the task
1757  * takes. If the task takes longer than \ref interval, it will be scheduled at the next available
1758  * multiple of \ref interval.  For exmaple: If the task has an interval of 60 seconds and the task
1759  * takes 70 seconds, the next invocation will happen at 120 seconds.
1760  *
1761  * \ref AST_SIP_SCHED_TASK_DELAY specifies that the next invocation of the task should start
1762  * at \ref interval milliseconds after the current invocation has finished.
1763  *
1764  */
1765 struct ast_sip_sched_task *ast_sip_schedule_task(struct ast_taskprocessor *serializer,
1766         int interval, ast_sip_task sip_task, const char *name, void *task_data,
1767         enum ast_sip_scheduler_task_flags flags);
1768
1769 /*!
1770  * \brief Cancels the next invocation of a task
1771  * \since 13.9.0
1772  *
1773  * \param schtd The task structure pointer
1774  * \retval 0 Success
1775  * \retval -1 Failure
1776  * \note Only cancels future invocations not the currently running invocation.
1777  */
1778 int ast_sip_sched_task_cancel(struct ast_sip_sched_task *schtd);
1779
1780 /*!
1781  * \brief Cancels the next invocation of a task by name
1782  * \since 13.9.0
1783  *
1784  * \param name The task name
1785  * \retval 0 Success
1786  * \retval -1 Failure
1787  * \note Only cancels future invocations not the currently running invocation.
1788  */
1789 int ast_sip_sched_task_cancel_by_name(const char *name);
1790
1791 /*!
1792  * \brief Gets the last start and end times of the task
1793  * \since 13.9.0
1794  *
1795  * \param schtd The task structure pointer
1796  * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
1797  * \param[out] last_start Pointer to a timeval structure to contain the time when last started
1798  * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
1799  * \retval 0 Success
1800  * \retval -1 Failure
1801  * \note Any of the pointers can be NULL if you don't need them.
1802  */
1803 int ast_sip_sched_task_get_times(struct ast_sip_sched_task *schtd,
1804         struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
1805
1806 /*!
1807  * \brief Gets the last start and end times of the task by name
1808  * \since 13.9.0
1809  *
1810  * \param name The task name
1811  * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
1812  * \param[out] last_start Pointer to a timeval structure to contain the time when last started
1813  * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
1814  * \retval 0 Success
1815  * \retval -1 Failure
1816  * \note Any of the pointers can be NULL if you don't need them.
1817  */
1818 int ast_sip_sched_task_get_times_by_name(const char *name,
1819         struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
1820
1821 /*!
1822  * \brief Gets the number of milliseconds until the next invocation
1823  * \since 13.9.0
1824  *
1825  * \param schtd The task structure pointer
1826  * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
1827  */
1828 int ast_sip_sched_task_get_next_run(struct ast_sip_sched_task *schtd);
1829
1830 /*!
1831  * \brief Gets the number of milliseconds until the next invocation
1832  * \since 13.9.0
1833  *
1834  * \param name The task name
1835  * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
1836  */
1837 int ast_sip_sched_task_get_next_run_by_name(const char *name);
1838
1839 /*!
1840  * \brief Checks if the task is currently running
1841  * \since 13.9.0
1842  *
1843  * \param schtd The task structure pointer
1844  * \retval 0 not running
1845  * \retval 1 running
1846  */
1847 int ast_sip_sched_is_task_running(struct ast_sip_sched_task *schtd);
1848
1849 /*!
1850  * \brief Checks if the task is currently running
1851  * \since 13.9.0
1852  *
1853  * \param name The task name
1854  * \retval 0 not running or not found
1855  * \retval 1 running
1856  */
1857 int ast_sip_sched_is_task_running_by_name(const char *name);
1858
1859 /*!
1860  * \brief Gets the task name
1861  * \since 13.9.0
1862  *
1863  * \param schtd The task structure pointer
1864  * \retval 0 success
1865  * \retval 1 failure
1866  */
1867 int ast_sip_sched_task_get_name(struct ast_sip_sched_task *schtd, char *name, size_t maxlen);
1868
1869 /*!
1870  *  @}
1871  */
1872
1873 /*!
1874  * \brief SIP body description
1875  *
1876  * This contains a type and subtype that will be added as
1877  * the "Content-Type" for the message as well as the body
1878  * text.
1879  */
1880 struct ast_sip_body {
1881         /*! Type of the body, such as "application" */
1882         const char *type;
1883         /*! Subtype of the body, such as "sdp" */
1884         const char *subtype;
1885         /*! The text to go in the body */
1886         const char *body_text;
1887 };
1888
1889 /*!
1890  * \brief General purpose method for creating a UAC dialog with an endpoint
1891  *
1892  * \param endpoint A pointer to the endpoint
1893  * \param aor_name Optional name of the AOR to target, may even be an explicit SIP URI
1894  * \param request_user Optional user to place into the target URI
1895  *
1896  * \retval non-NULL success
1897  * \retval NULL failure
1898  */
1899 pjsip_dialog *ast_sip_create_dialog_uac(const struct ast_sip_endpoint *endpoint, const char *aor_name, const char *request_user);
1900
1901 /*!
1902  * \brief General purpose method for creating a UAS dialog with an endpoint
1903  *
1904  * \param endpoint A pointer to the endpoint
1905  * \param rdata The request that is starting the dialog
1906  * \param[out] status On failure, the reason for failure in creating the dialog
1907  */
1908 pjsip_dialog *ast_sip_create_dialog_uas(const struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pj_status_t *status);
1909
1910 /*!
1911  * \brief General purpose method for creating an rdata structure using specific information
1912  * \since 13.15.0
1913  *
1914  * \param rdata[out] The rdata structure that will be populated
1915  * \param packet A SIP message
1916  * \param src_name The source IP address of the message
1917  * \param src_port The source port of the message
1918  * \param transport_type The type of transport the message was received on
1919  * \param local_name The local IP address the message was received on
1920  * \param local_port The local port the message was received on
1921  * \param contact_uri The contact URI of the message
1922  *
1923  * \retval 0 success
1924  * \retval -1 failure
1925  */
1926 int ast_sip_create_rdata_with_contact(pjsip_rx_data *rdata, char *packet,
1927         const char *src_name, int src_port, char *transport_type, const char *local_name,
1928         int local_port, const char *contact_uri);
1929
1930 /*!
1931  * \brief General purpose method for creating an rdata structure using specific information
1932  *
1933  * \param rdata[out] The rdata structure that will be populated
1934  * \param packet A SIP message
1935  * \param src_name The source IP address of the message
1936  * \param src_port The source port of the message
1937  * \param transport_type The type of transport the message was received on
1938  * \param local_name The local IP address the message was received on
1939  * \param local_port The local port the message was received on
1940  *
1941  * \retval 0 success
1942  * \retval -1 failure
1943  */
1944 int ast_sip_create_rdata(pjsip_rx_data *rdata, char *packet, const char *src_name,
1945         int src_port, char *transport_type, const char *local_name, int local_port);
1946
1947 /*!
1948  * \brief General purpose method for creating a SIP request
1949  *
1950  * Its typical use would be to create one-off requests such as an out of dialog
1951  * SIP MESSAGE.
1952  *
1953  * The request can either be in- or out-of-dialog. If in-dialog, the
1954  * dlg parameter MUST be present. If out-of-dialog the endpoint parameter
1955  * MUST be present. If both are present, then we will assume that the message
1956  * is to be sent in-dialog.
1957  *
1958  * The uri parameter can be specified if the request should be sent to an explicit
1959  * URI rather than one configured on the endpoint.
1960  *
1961  * \param method The method of the SIP request to send
1962  * \param dlg Optional. If specified, the dialog on which to request the message.
1963  * \param endpoint Optional. If specified, the request will be created out-of-dialog to the endpoint.
1964  * \param uri Optional. If specified, the request will be sent to this URI rather
1965  * than one configured for the endpoint.
1966  * \param contact The contact with which this request is associated for out-of-dialog requests.
1967  * \param[out] tdata The newly-created request
1968  *
1969  * The provided contact is attached to tdata with its reference bumped, but will
1970  * not survive for the entire lifetime of tdata since the contact is cleaned up
1971  * when all supplements have completed execution.
1972  *
1973  * \retval 0 Success
1974  * \retval -1 Failure
1975  */
1976 int ast_sip_create_request(const char *method, struct pjsip_dialog *dlg,
1977                 struct ast_sip_endpoint *endpoint, const char *uri,
1978                 struct ast_sip_contact *contact, pjsip_tx_data **tdata);
1979
1980 /*!
1981  * \brief General purpose method for sending a SIP request
1982  *
1983  * This is a companion function for \ref ast_sip_create_request. The request
1984  * created there can be passed to this function, though any request may be
1985  * passed in.
1986  *
1987  * This will automatically set up handling outbound authentication challenges if
1988  * they arrive.
1989  *
1990  * \param tdata The request to send
1991  * \param dlg Optional. The dialog in which the request is sent.  Otherwise it is out-of-dialog.
1992  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
1993  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
1994  * \param callback Callback to be called upon receipt of out-of-dialog response.
1995  *
1996  * \retval 0 Success
1997  * \retval -1 Failure (out-of-dialog callback will not be called.)
1998  */
1999 int ast_sip_send_request(pjsip_tx_data *tdata, struct pjsip_dialog *dlg,
2000         struct ast_sip_endpoint *endpoint, void *token,
2001         void (*callback)(void *token, pjsip_event *e));
2002
2003 /*!
2004  * \brief General purpose method for sending an Out-Of-Dialog SIP request
2005  *
2006  * This is a companion function for \ref ast_sip_create_request. The request
2007  * created there can be passed to this function, though any request may be
2008  * passed in.
2009  *
2010  * This will automatically set up handling outbound authentication challenges if
2011  * they arrive.
2012  *
2013  * \param tdata The request to send
2014  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
2015  * \param timeout.  If non-zero, after the timeout the transaction will be terminated
2016  * and the callback will be called with the PJSIP_EVENT_TIMER type.
2017  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
2018  * \param callback Callback to be called upon receipt of out-of-dialog response.
2019  *
2020  * \retval 0 Success
2021  * \retval -1 Failure (out-of-dialog callback will not be called.)
2022  *
2023  * \note Timeout processing:
2024  * There are 2 timers associated with this request, PJSIP timer_b which is
2025  * set globally in the "system" section of pjsip.conf, and the timeout specified
2026  * on this call.  The timer that expires first (before normal completion) will
2027  * cause the callback to be run with e->body.tsx_state.type = PJSIP_EVENT_TIMER.
2028  * The timer that expires second is simply ignored and the callback is not run again.
2029  */
2030 int ast_sip_send_out_of_dialog_request(pjsip_tx_data *tdata,
2031         struct ast_sip_endpoint *endpoint, int timeout, void *token,
2032         void (*callback)(void *token, pjsip_event *e));
2033
2034 /*!
2035  * \brief General purpose method for creating a SIP response
2036  *
2037  * Its typical use would be to create responses for out of dialog
2038  * requests.
2039  *
2040  * \param rdata The rdata from the incoming request.
2041  * \param st_code The response code to transmit.
2042  * \param contact The contact with which this request is associated.
2043  * \param[out] tdata The newly-created response
2044  *
2045  * The provided contact is attached to tdata with its reference bumped, but will
2046  * not survive for the entire lifetime of tdata since the contact is cleaned up
2047  * when all supplements have completed execution.
2048  *
2049  * \retval 0 Success
2050  * \retval -1 Failure
2051  */
2052 int ast_sip_create_response(const pjsip_rx_data *rdata, int st_code,
2053         struct ast_sip_contact *contact, pjsip_tx_data **p_tdata);
2054
2055 /*!
2056  * \brief Send a response to an out of dialog request
2057  *
2058  * Use this function sparingly, since this does not create a transaction
2059  * within PJSIP. This means that if the request is retransmitted, it is
2060  * your responsibility to detect this and not process the same request
2061  * twice, and to send the same response for each retransmission.
2062  *
2063  * \param res_addr The response address for this response
2064  * \param tdata The response to send
2065  * \param endpoint The ast_sip_endpoint associated with this response
2066  *
2067  * \retval 0 Success
2068  * \retval -1 Failure
2069  */
2070 int ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
2071
2072 /*!
2073  * \brief Send a stateful response to an out of dialog request
2074  *
2075  * This creates a transaction within PJSIP, meaning that if the request
2076  * that we are responding to is retransmitted, we will not attempt to
2077  * re-handle the request.
2078  *
2079  * \param rdata The request that is being responded to
2080  * \param tdata The response to send
2081  * \param endpoint The ast_sip_endpoint associated with this response
2082  *
2083  * \since 13.4.0
2084  *
2085  * \retval 0 Success
2086  * \retval -1 Failure
2087  */
2088 int ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
2089
2090 /*!
2091  * \brief Determine if an incoming request requires authentication
2092  *
2093  * This calls into the registered authenticator's requires_authentication callback
2094  * in order to determine if the request requires authentication.
2095  *
2096  * If there is no registered authenticator, then authentication will be assumed
2097  * not to be required.
2098  *
2099  * \param endpoint The endpoint from which the request originates
2100  * \param rdata The incoming SIP request
2101  * \retval non-zero The request requires authentication
2102  * \retval 0 The request does not require authentication
2103  */
2104 int ast_sip_requires_authentication(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2105
2106 /*!
2107  * \brief Method to determine authentication status of an incoming request
2108  *
2109  * This will call into a registered authenticator. The registered authenticator will
2110  * do what is necessary to determine whether the incoming request passes authentication.
2111  * A tentative response is passed into this function so that if, say, a digest authentication
2112  * challenge should be sent in the ensuing response, it can be added to the response.
2113  *
2114  * \param endpoint The endpoint from the request was sent
2115  * \param rdata The request to potentially authenticate
2116  * \param tdata Tentative response to the request
2117  * \return The result of checking authentication.
2118  */
2119 enum ast_sip_check_auth_result ast_sip_check_authentication(struct ast_sip_endpoint *endpoint,
2120                 pjsip_rx_data *rdata, pjsip_tx_data *tdata);
2121
2122 /*!
2123  * \brief Create a response to an authentication challenge
2124  *
2125  * This will call into an outbound authenticator's create_request_with_auth callback
2126  * to create a new request with authentication credentials. See the create_request_with_auth
2127  * callback in the \ref ast_sip_outbound_authenticator structure for details about
2128  * the parameters and return values.
2129  */
2130 int ast_sip_create_request_with_auth(const struct ast_sip_auth_vector *auths, pjsip_rx_data *challenge,
2131                 pjsip_tx_data *tdata, pjsip_tx_data **new_request);
2132
2133 /*!
2134  * \brief Determine the endpoint that has sent a SIP message
2135  *
2136  * This will call into each of the registered endpoint identifiers'
2137  * identify_endpoint() callbacks until one returns a non-NULL endpoint.
2138  * This will return an ao2 object. Its reference count will need to be
2139  * decremented when completed using the endpoint.
2140  *
2141  * \param rdata The inbound SIP message to use when identifying the endpoint.
2142  * \retval NULL No matching endpoint
2143  * \retval non-NULL The matching endpoint
2144  */
2145 struct ast_sip_endpoint *ast_sip_identify_endpoint(pjsip_rx_data *rdata);
2146
2147 /*!
2148  * \brief Set the outbound proxy for an outbound SIP message
2149  *
2150  * \param tdata The message to set the outbound proxy on
2151  * \param proxy SIP uri of the proxy
2152  * \retval 0 Success
2153  * \retval -1 Failure
2154  */
2155 int ast_sip_set_outbound_proxy(pjsip_tx_data *tdata, const char *proxy);
2156
2157 /*!
2158  * \brief Add a header to an outbound SIP message
2159  *
2160  * \param tdata The message to add the header to
2161  * \param name The header name
2162  * \param value The header value
2163  * \retval 0 Success
2164  * \retval -1 Failure
2165  */
2166 int ast_sip_add_header(pjsip_tx_data *tdata, const char *name, const char *value);
2167
2168 /*!
2169  * \brief Add a body to an outbound SIP message
2170  *
2171  * If this is called multiple times, the latest body will replace the current
2172  * body.
2173  *
2174  * \param tdata The message to add the body to
2175  * \param body The message body to add
2176  * \retval 0 Success
2177  * \retval -1 Failure
2178  */
2179 int ast_sip_add_body(pjsip_tx_data *tdata, const struct ast_sip_body *body);
2180
2181 /*!
2182  * \brief Add a multipart body to an outbound SIP message
2183  *
2184  * This will treat each part of the input vector as part of a multipart body and
2185  * add each part to the SIP message.
2186  *
2187  * \param tdata The message to add the body to
2188  * \param bodies The parts of the body to add
2189  * \retval 0 Success
2190  * \retval -1 Failure
2191  */
2192 int ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies);
2193
2194 /*!
2195  * \brief Append body data to a SIP message
2196  *
2197  * This acts mostly the same as ast_sip_add_body, except that rather than replacing
2198  * a body if it currently exists, it appends data to an existing body.
2199  *
2200  * \param tdata The message to append the body to
2201  * \param body The string to append to the end of the current body
2202  * \retval 0 Success
2203  * \retval -1 Failure
2204  */
2205 int ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text);
2206
2207 /*!
2208  * \brief Copy a pj_str_t into a standard character buffer.
2209  *
2210  * pj_str_t is not NULL-terminated. Any place that expects a NULL-
2211  * terminated string needs to have the pj_str_t copied into a separate
2212  * buffer.
2213  *
2214  * This method copies the pj_str_t contents into the destination buffer
2215  * and NULL-terminates the buffer.
2216  *
2217  * \param dest The destination buffer
2218  * \param src The pj_str_t to copy
2219  * \param size The size of the destination buffer.
2220  */
2221 void ast_copy_pj_str(char *dest, const pj_str_t *src, size_t size);
2222
2223 /*!
2224  * \brief Create and copy a pj_str_t into a standard character buffer.
2225  *
2226  * pj_str_t is not NULL-terminated. Any place that expects a NULL-
2227  * terminated string needs to have the pj_str_t copied into a separate
2228  * buffer.
2229  *
2230  * Copies the pj_str_t contents into a newly allocated buffer pointed to
2231  * by dest. NULL-terminates the buffer.
2232  *
2233  * \note Caller is responsible for freeing the allocated memory.
2234  *
2235  * \param dest [out] The destination buffer
2236  * \param src The pj_str_t to copy
2237  * \retval Number of characters copied or negative value on error
2238  */
2239 int ast_copy_pj_str2(char **dest, const pj_str_t *src);
2240
2241 /*!
2242  * \brief Get the looked-up endpoint on an out-of dialog request or response
2243  *
2244  * The function may ONLY be called on out-of-dialog requests or responses. For
2245  * in-dialog requests and responses, it is required that the user of the dialog
2246  * has the looked-up endpoint stored locally.
2247  *
2248  * This function should never return NULL if the message is out-of-dialog. It will
2249  * always return NULL if the message is in-dialog.
2250  *
2251  * This function will increase the reference count of the returned endpoint by one.
2252  * Release your reference using the ao2_ref function when finished.
2253  *
2254  * \param rdata Out-of-dialog request or response
2255  * \return The looked up endpoint
2256  */
2257 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata);
2258
2259 /*!
2260  * \brief Add 'user=phone' parameter to URI if enabled and user is a phone number.
2261  *
2262  * \param endpoint The endpoint to use for configuration
2263  * \param pool The memory pool to allocate the parameter from
2264  * \param uri The URI to check for user and to add parameter to
2265  */
2266 void ast_sip_add_usereqphone(const struct ast_sip_endpoint *endpoint, pj_pool_t *pool, pjsip_uri *uri);
2267
2268 /*!
2269  * \brief Retrieve any endpoints available to sorcery.
2270  *
2271  * \retval Endpoints available to sorcery, NULL if no endpoints found.
2272  */
2273 struct ao2_container *ast_sip_get_endpoints(void);
2274
2275 /*!
2276  * \brief Retrieve the default outbound endpoint.
2277  *
2278  * \retval The default outbound endpoint, NULL if not found.
2279  */
2280 struct ast_sip_endpoint *ast_sip_default_outbound_endpoint(void);
2281
2282 /*!
2283  * \brief Retrieve relevant SIP auth structures from sorcery
2284  *
2285  * \param auths Vector of sorcery IDs of auth credentials to retrieve
2286  * \param[out] out The retrieved auths are stored here
2287  */
2288 int ast_sip_retrieve_auths(const struct ast_sip_auth_vector *auths, struct ast_sip_auth **out);
2289
2290 /*!
2291  * \brief Clean up retrieved auth structures from memory
2292  *
2293  * Call this function once you have completed operating on auths
2294  * retrieved from \ref ast_sip_retrieve_auths
2295  *
2296  * \param auths An vector of auth structures to clean up
2297  * \param num_auths The number of auths in the vector
2298  */
2299 void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths);
2300
2301 /*!
2302  * \brief Checks if the given content type matches type/subtype.
2303  *
2304  * Compares the pjsip_media_type with the passed type and subtype and
2305  * returns the result of that comparison.  The media type parameters are
2306  * ignored.
2307  *
2308  * \param content_type The pjsip_media_type structure to compare
2309  * \param type The media type to compare
2310  * \param subtype The media subtype to compare
2311  * \retval 0 No match
2312  * \retval -1 Match
2313  */
2314 int ast_sip_is_content_type(pjsip_media_type *content_type, char *type, char *subtype);
2315
2316 /*!
2317  * \brief Send a security event notification for when an invalid endpoint is requested
2318  *
2319  * \param name Name of the endpoint requested
2320  * \param rdata Received message
2321  */
2322 void ast_sip_report_invalid_endpoint(const char *name, pjsip_rx_data *rdata);
2323
2324 /*!
2325  * \brief Send a security event notification for when an ACL check fails
2326  *
2327  * \param endpoint Pointer to the endpoint in use
2328  * \param rdata Received message
2329  * \param name Name of the ACL
2330  */
2331 void ast_sip_report_failed_acl(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *name);
2332
2333 /*!
2334  * \brief Send a security event notification for when a challenge response has failed
2335  *
2336  * \param endpoint Pointer to the endpoint in use
2337  * \param rdata Received message
2338  */
2339 void ast_sip_report_auth_failed_challenge_response(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2340
2341 /*!
2342  * \brief Send a security event notification for when authentication succeeds
2343  *
2344  * \param endpoint Pointer to the endpoint in use
2345  * \param rdata Received message
2346  */
2347 void ast_sip_report_auth_success(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2348
2349 /*!
2350  * \brief Send a security event notification for when an authentication challenge is sent
2351  *
2352  * \param endpoint Pointer to the endpoint in use
2353  * \param rdata Received message
2354  * \param tdata Sent message
2355  */
2356 void ast_sip_report_auth_challenge_sent(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata);
2357
2358 /*!
2359  * \brief Send a security event notification for when a request is not supported
2360  *
2361  * \param endpoint Pointer to the endpoint in use
2362  * \param rdata Received message
2363  * \param req_type the type of request
2364  */
2365 void ast_sip_report_req_no_support(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata,
2366                                    const char* req_type);
2367
2368 /*!
2369  * \brief Send a security event notification for when a memory limit is hit.
2370  *
2371  * \param endpoint Pointer to the endpoint in use
2372  * \param rdata Received message
2373  */
2374 void ast_sip_report_mem_limit(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2375
2376 int ast_sip_add_global_request_header(const char *name, const char *value, int replace);
2377 int ast_sip_add_global_response_header(const char *name, const char *value, int replace);
2378
2379 /*!
2380  * \brief Retrieves the value associated with the given key.
2381  *
2382  * \param ht the hash table/dictionary to search
2383  * \param key the key to find
2384  *
2385  * \retval the value associated with the key, NULL otherwise.
2386  */
2387 void *ast_sip_dict_get(void *ht, const char *key);
2388
2389 /*!
2390  * \brief Using the dictionary stored in mod_data array at a given id,
2391  *        retrieve the value associated with the given key.
2392  *
2393  * \param mod_data a module data array
2394  * \param id the mod_data array index
2395  * \param key the key to find
2396  *
2397  * \retval the value associated with the key, NULL otherwise.
2398  */
2399 #define ast_sip_mod_data_get(mod_data, id, key)         \
2400         ast_sip_dict_get(mod_data[id], key)
2401
2402 /*!
2403  * \brief Set the value for the given key.
2404  *
2405  * Note - if the hash table does not exist one is created first, the key/value
2406  * pair is set, and the hash table returned.
2407  *
2408  * \param pool the pool to allocate memory in
2409  * \param ht the hash table/dictionary in which to store the key/value pair
2410  * \param key the key to associate a value with
2411  * \param val the value to associate with a key
2412  *
2413  * \retval the given, or newly created, hash table.
2414  */
2415 void *ast_sip_dict_set(pj_pool_t* pool, void *ht,
2416                        const char *key, void *val);
2417
2418 /*!
2419  * \brief Utilizing a mod_data array for a given id, set the value
2420  *        associated with the given key.
2421  *
2422  * For a given structure's mod_data array set the element indexed by id to
2423  * be a dictionary containing the key/val pair.
2424  *
2425  * \param pool a memory allocation pool
2426  * \param mod_data a module data array
2427  * \param id the mod_data array index
2428  * \param key the key to find
2429  * \param val the value to associate with a key
2430  */
2431 #define ast_sip_mod_data_set(pool, mod_data, id, key, val)              \
2432         mod_data[id] = ast_sip_dict_set(pool, mod_data[id], key, val)
2433
2434 /*!
2435  * \brief For every contact on an AOR call the given 'on_contact' handler.
2436  *
2437  * \param aor the aor containing a list of contacts to iterate
2438  * \param on_contact callback on each contact on an AOR.  The object
2439  * received by the callback will be a ast_sip_contact_wrapper structure.
2440  * \param arg user data passed to handler
2441  * \retval 0 Success, non-zero on failure
2442  */
2443 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
2444                 ao2_callback_fn on_contact, void *arg);
2445
2446 /*!
2447  * \brief Handler used to convert a contact to a string.
2448  *
2449  * \param object the ast_sip_aor_contact_pair containing a list of contacts to iterate and the contact
2450  * \param arg user data passed to handler
2451  * \param flags
2452  * \retval 0 Success, non-zero on failure
2453  */
2454 int ast_sip_contact_to_str(void *object, void *arg, int flags);
2455
2456 /*!
2457  * \brief For every aor in the comma separated aors string call the
2458  *        given 'on_aor' handler.
2459  *
2460  * \param aors a comma separated list of aors
2461  * \param on_aor callback for each aor
2462  * \param arg user data passed to handler
2463  * \retval 0 Success, non-zero on failure
2464  */
2465 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg);
2466
2467 /*!
2468  * \brief For every auth in the array call the given 'on_auth' handler.
2469  *
2470  * \param array an array of auths
2471  * \param on_auth callback for each auth
2472  * \param arg user data passed to handler
2473  * \retval 0 Success, non-zero on failure
2474  */
2475 int ast_sip_for_each_auth(const struct ast_sip_auth_vector *array,
2476                           ao2_callback_fn on_auth, void *arg);
2477
2478 /*!
2479  * \brief Converts the given auth type to a string
2480  *
2481  * \param type the auth type to convert
2482  * \retval a string representative of the auth type
2483  */
2484 const char *ast_sip_auth_type_to_str(enum ast_sip_auth_type type);
2485
2486 /*!
2487  * \brief Converts an auths array to a string of comma separated values
2488  *
2489  * \param auths an auth array
2490  * \param buf the string buffer to write the object data
2491  * \retval 0 Success, non-zero on failure
2492  */
2493 int ast_sip_auths_to_str(const struct ast_sip_auth_vector *auths, char **buf);
2494
2495 /*!
2496  * \brief AMI variable container
2497  */
2498 struct ast_sip_ami {
2499         /*! Manager session */
2500         struct mansession *s;
2501         /*! Manager message */
2502         const struct message *m;
2503         /*! Manager Action ID */
2504         const char *action_id;
2505         /*! user specified argument data */
2506         void *arg;
2507         /*! count of objects */
2508         int count;
2509 };
2510
2511 /*!
2512  * \brief Creates a string to store AMI event data in.
2513  *
2514  * \param event the event to set
2515  * \param ami AMI session and message container
2516  * \retval an initialized ast_str or NULL on error.
2517  */
2518 struct ast_str *ast_sip_create_ami_event(const char *event,
2519                                          struct ast_sip_ami *ami);
2520
2521 /*!
2522  * \brief An entity responsible formatting endpoint information.
2523  */
2524 struct ast_sip_endpoint_formatter {
2525         /*!
2526          * \brief Callback used to format endpoint information over AMI.
2527          */
2528         int (*format_ami)(const struct ast_sip_endpoint *endpoint,
2529                           struct ast_sip_ami *ami);
2530         AST_RWLIST_ENTRY(ast_sip_endpoint_formatter) next;
2531 };
2532
2533 /*!
2534  * \brief Register an endpoint formatter.
2535  *
2536  * \param obj the formatter to register
2537  */
2538 void ast_sip_register_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
2539
2540 /*!
2541  * \brief Unregister an endpoint formatter.
2542  *
2543  * \param obj the formatter to unregister
2544  */
2545 void ast_sip_unregister_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
2546
2547 /*!
2548  * \brief Converts a sorcery object to a string of object properties.
2549  *
2550  * \param obj the sorcery object to convert
2551  * \param str the string buffer to write the object data
2552  * \retval 0 Success, non-zero on failure
2553  */
2554 int ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf);
2555
2556 /*!
2557  * \brief Formats the endpoint and sends over AMI.
2558  *
2559  * \param endpoint the endpoint to format and send
2560  * \param endpoint ami AMI variable container
2561  * \param count the number of formatters operated on
2562  * \retval 0 Success, otherwise non-zero on error
2563  */
2564 int ast_sip_format_endpoint_ami(struct ast_sip_endpoint *endpoint,
2565                                 struct ast_sip_ami *ami, int *count);
2566
2567 /*!
2568  * \brief Formats the contact and sends over AMI.
2569  *
2570  * \param obj a pointer an ast_sip_contact_wrapper structure
2571  * \param arg a pointer to an ast_sip_ami structure
2572  * \param flags ignored
2573  * \retval 0 Success, otherwise non-zero on error
2574  */
2575 int ast_sip_format_contact_ami(void *obj, void *arg, int flags);
2576
2577 /*!
2578  * \brief Format auth details for AMI.
2579  *
2580  * \param auths an auth array
2581  * \param ami ami variable container
2582  * \retval 0 Success, non-zero on failure
2583  */
2584 int ast_sip_format_auths_ami(const struct ast_sip_auth_vector *auths,
2585                              struct ast_sip_ami *ami);
2586
2587 /*!
2588  * \brief Retrieve the endpoint snapshot for an endpoint
2589  *
2590  * \param endpoint The endpoint whose snapshot is to be retreieved.
2591  * \retval The endpoint snapshot
2592  */
2593 struct ast_endpoint_snapshot *ast_sip_get_endpoint_snapshot(
2594         const struct ast_sip_endpoint *endpoint);
2595
2596 /*!
2597  * \brief Retrieve the device state for an endpoint.
2598  *
2599  * \param endpoint The endpoint whose state is to be retrieved.
2600  * \retval The device state.
2601  */
2602 const char *ast_sip_get_device_state(const struct ast_sip_endpoint *endpoint);
2603
2604 /*!
2605  * \brief For every channel snapshot on an endpoint snapshot call the given
2606  *        'on_channel_snapshot' handler.
2607  *
2608  * \param endpoint_snapshot snapshot of an endpoint
2609  * \param on_channel_snapshot callback for each channel snapshot
2610  * \param arg user data passed to handler
2611  * \retval 0 Success, non-zero on failure
2612  */
2613 int ast_sip_for_each_channel_snapshot(const struct ast_endpoint_snapshot *endpoint_snapshot,
2614                 ao2_callback_fn on_channel_snapshot,
2615                                       void *arg);
2616
2617 /*!
2618  * \brief For every channel snapshot on an endpoint all the given
2619  *        'on_channel_snapshot' handler.
2620  *
2621  * \param endpoint endpoint
2622  * \param on_channel_snapshot callback for each channel snapshot
2623  * \param arg user data passed to handler
2624  * \retval 0 Success, non-zero on failure
2625  */
2626 int ast_sip_for_each_channel(const struct ast_sip_endpoint *endpoint,
2627                 ao2_callback_fn on_channel_snapshot,
2628                                       void *arg);
2629
2630 enum ast_sip_supplement_priority {
2631         /*! Top priority. Supplements with this priority are those that need to run before any others */
2632         AST_SIP_SUPPLEMENT_PRIORITY_FIRST = 0,
2633         /*! Channel creation priority.
2634          * chan_pjsip creates a channel at this priority. If your supplement depends on being run before
2635          * or after channel creation, then set your priority to be lower or higher than this value.
2636          */
2637         AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL = 1000000,
2638         /*! Lowest priority. Supplements with this priority should be run after all other supplements */
2639         AST_SIP_SUPPLEMENT_PRIORITY_LAST = INT_MAX,
2640 };
2641
2642 /*!
2643  * \brief A supplement to SIP message processing
2644  *
2645  * These can be registered by any module in order to add
2646  * processing to incoming and outgoing SIP out of dialog
2647  * requests and responses
2648  */
2649 struct ast_sip_supplement {
2650         /*! Method on which to call the callbacks. If NULL, call on all methods */
2651         const char *method;
2652         /*! Priority for this supplement. Lower numbers are visited before higher numbers */
2653         enum ast_sip_supplement_priority priority;
2654         /*!
2655          * \brief Called on incoming SIP request
2656          * This method can indicate a failure in processing in its return. If there
2657          * is a failure, it is required that this method sends a response to the request.
2658          * This method is always called from a SIP servant thread.
2659          *
2660          * \note
2661          * The following PJSIP methods will not work properly:
2662          * pjsip_rdata_get_dlg()
2663          * pjsip_rdata_get_tsx()
2664          * The reason is that the rdata passed into this function is a cloned rdata structure,
2665          * and its module data is not copied during the cloning operation.
2666          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2667          *
2668          * \note
2669          * There is no guarantee that a channel will be present on the session when this is called.
2670          */
2671         int (*incoming_request)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2672         /*!
2673          * \brief Called on an incoming SIP response
2674          * This method is always called from a SIP servant thread.
2675          *
2676          * \note
2677          * The following PJSIP methods will not work properly:
2678          * pjsip_rdata_get_dlg()
2679          * pjsip_rdata_get_tsx()
2680          * The reason is that the rdata passed into this function is a cloned rdata structure,
2681          * and its module data is not copied during the cloning operation.
2682          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2683          *
2684          * \note
2685          * There is no guarantee that a channel will be present on the session when this is called.
2686          */
2687         void (*incoming_response)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2688         /*!
2689          * \brief Called on an outgoing SIP request
2690          * This method is always called from a SIP servant thread.
2691          */
2692         void (*outgoing_request)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2693         /*!
2694          * \brief Called on an outgoing SIP response
2695          * This method is always called from a SIP servant thread.
2696          */
2697         void (*outgoing_response)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2698         /*! Next item in the list */
2699         AST_LIST_ENTRY(ast_sip_supplement) next;
2700 };
2701
2702 /*!
2703  * \brief Register a supplement to SIP out of dialog processing
2704  *
2705  * This allows for someone to insert themselves in the processing of out
2706  * of dialog SIP requests and responses. This, for example could allow for
2707  * a module to set channel data based on headers in an incoming message.
2708  * Similarly, a module could reject an incoming request if desired.
2709  *
2710  * \param supplement The supplement to register
2711  * \retval 0 Success
2712  * \retval -1 Failure
2713  */
2714 void ast_sip_register_supplement(struct ast_sip_supplement *supplement);
2715
2716 /*!
2717  * \brief Unregister a an supplement to SIP out of dialog processing
2718  *
2719  * \param supplement The supplement to unregister
2720  */
2721 void ast_sip_unregister_supplement(struct ast_sip_supplement *supplement);
2722
2723 /*!
2724  * \brief Retrieve the global MWI taskprocessor high water alert trigger level.
2725  *
2726  * \since 13.12.0
2727  *
2728  * \retval the system MWI taskprocessor high water alert trigger level
2729  */
2730 unsigned int ast_sip_get_mwi_tps_queue_high(void);
2731
2732 /*!
2733  * \brief Retrieve the global MWI taskprocessor low water clear alert level.
2734  *
2735  * \since 13.12.0
2736  *
2737  * \retval the system MWI taskprocessor low water clear alert level
2738  */
2739 int ast_sip_get_mwi_tps_queue_low(void);
2740
2741 /*!
2742  * \brief Retrieve the global setting 'disable sending unsolicited mwi on startup'.
2743  * \since 13.12.0
2744  *
2745  * \retval non zero if disable.
2746  */
2747 unsigned int ast_sip_get_mwi_disable_initial_unsolicited(void);
2748
2749 /*!
2750  * \brief Retrieve the global setting 'ignore_uri_user_options'.
2751  * \since 13.12.0
2752  *
2753  * \retval non zero if ignore the user field options.
2754  */
2755 unsigned int ast_sip_get_ignore_uri_user_options(void);
2756
2757 /*!
2758  * \brief Truncate the URI user field options string if enabled.
2759  * \since 13.12.0
2760  *
2761  * \param str URI user field string to truncate if enabled
2762  *
2763  * \details
2764  * We need to be able to handle URI's looking like
2765  * "sip:1235557890;phone-context=national@x.x.x.x;user=phone"
2766  *
2767  * Where the URI user field is:
2768  * "1235557890;phone-context=national"
2769  *
2770  * When truncated the string will become:
2771  * "1235557890"
2772  */
2773 #define AST_SIP_USER_OPTIONS_TRUNCATE_CHECK(str)                                \
2774         do {                                                                                                            \
2775                 char *__semi = strchr((str), ';');                                              \
2776                 if (__semi && ast_sip_get_ignore_uri_user_options()) {  \
2777                         *__semi = '\0';                                                                         \
2778                 }                                                                                                               \
2779         } while (0)
2780
2781 /*!
2782  * \brief Retrieve the system debug setting (yes|no|host).
2783  *
2784  * \note returned string needs to be de-allocated by caller.
2785  *
2786  * \retval the system debug setting.
2787  */
2788 char *ast_sip_get_debug(void);
2789
2790 /*!
2791  * \brief Retrieve the global regcontext setting.
2792  *
2793  * \since 13.8.0
2794  *
2795  * \note returned string needs to be de-allocated by caller.
2796  *
2797  * \retval the global regcontext setting
2798  */
2799 char *ast_sip_get_regcontext(void);
2800
2801 /*!
2802  * \brief Retrieve the global endpoint_identifier_order setting.
2803  *
2804  * Specifies the order by which endpoint identifiers should be regarded.
2805  *
2806  * \retval the global endpoint_identifier_order value
2807  */
2808 char *ast_sip_get_endpoint_identifier_order(void);
2809
2810 /*!
2811  * \brief Retrieve the default voicemail extension.
2812  * \since 13.9.0
2813  *
2814  * \note returned string needs to be de-allocated by caller.
2815  *
2816  * \retval the default voicemail extension
2817  */
2818 char *ast_sip_get_default_voicemail_extension(void);
2819
2820 /*!
2821  * \brief Retrieve the global default realm.
2822  *
2823  * This is the value placed in outbound challenges' realm if there
2824  * is no better option (such as an auth-configured realm).
2825  *
2826  * \param[out] realm The default realm
2827  * \param size The buffer size of realm
2828  * \return nothing
2829  */
2830 void ast_sip_get_default_realm(char *realm, size_t size);
2831
2832 /*!
2833  * \brief Retrieve the global default from user.
2834  *
2835  * This is the value placed in outbound requests' From header if there
2836  * is no better option (such as an endpoint-configured from_user or
2837  * caller ID number).
2838  *
2839  * \param[out] from_user The default from user
2840  * \param size The buffer size of from_user
2841  * \return nothing
2842  */
2843 void ast_sip_get_default_from_user(char *from_user, size_t size);
2844
2845 /*!
2846  * \brief Retrieve the system keep alive interval setting.
2847  *
2848  * \retval the keep alive interval.
2849  */
2850 unsigned int ast_sip_get_keep_alive_interval(void);
2851
2852 /*!
2853  * \brief Retrieve the system contact expiration check interval setting.
2854  *
2855  * \retval the contact expiration check interval.
2856  */
2857 unsigned int ast_sip_get_contact_expiration_check_interval(void);
2858
2859 /*!
2860  * \brief Retrieve the system setting 'disable multi domain'.
2861  * \since 13.9.0
2862  *
2863  * \retval non zero if disable multi domain.
2864  */
2865 unsigned int ast_sip_get_disable_multi_domain(void);
2866
2867 /*!
2868  * \brief Retrieve the system max initial qualify time.
2869  *
2870  * \retval the maximum initial qualify time.
2871  */
2872 unsigned int ast_sip_get_max_initial_qualify_time(void);
2873
2874 /*!
2875  * \brief translate ast_sip_contact_status_type to character string.
2876  *
2877  * \retval the character string equivalent.
2878  */
2879
2880 const char *ast_sip_get_contact_status_label(const enum ast_sip_contact_status_type status);
2881 const char *ast_sip_get_contact_short_status_label(const enum ast_sip_contact_status_type status);
2882
2883 /*!
2884  * \brief Set a request to use the next value in the list of resolved addresses.
2885  *
2886  * \param tdata the tx data from the original request
2887  * \retval 0 No more addresses to try
2888  * \retval 1 The request was successfully re-intialized
2889  */
2890 int ast_sip_failover_request(pjsip_tx_data *tdata);
2891
2892 /*
2893  * \brief Retrieve the local host address in IP form
2894  *
2895  * \param af The address family to retrieve
2896  * \param addr A place to store the local host address
2897  *
2898  * \retval 0 success
2899  * \retval -1 failure
2900  *
2901  * \since 13.6.0
2902  */
2903 int ast_sip_get_host_ip(int af, pj_sockaddr *addr);
2904
2905 /*!
2906  * \brief Retrieve the local host address in string form
2907  *
2908  * \param af The address family to retrieve
2909  *
2910  * \retval non-NULL success
2911  * \retval NULL failure
2912  *
2913  * \since 13.6.0
2914  *
2915  * \note An empty string may be returned if the address family is valid but no local address exists
2916  */
2917 const char *ast_sip_get_host_ip_string(int af);
2918
2919 /*!
2920  * \brief Return the size of the SIP threadpool's task queue
2921  * \since 13.7.0
2922  */
2923 long ast_sip_threadpool_queue_size(void);
2924
2925 /*!
2926  * \brief Retrieve transport state
2927  * \since 13.7.1
2928  *
2929  * @param transport_id
2930  * @returns transport_state
2931  *
2932  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2933  */
2934 struct ast_sip_transport_state *ast_sip_get_transport_state(const char *transport_id);
2935
2936 /*!
2937  * \brief Retrieves all transport states
2938  * \since 13.7.1
2939  *
2940  * @returns ao2_container
2941  *
2942  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2943  */
2944 struct ao2_container *ast_sip_get_transport_states(void);
2945
2946 /*!
2947  * \brief Sets pjsip_tpselector from ast_sip_transport
2948  * \since 13.8.0
2949  *
2950  * \param transport The transport to be used
2951  * \param selector The selector to be populated
2952  * \retval 0 success
2953  * \retval -1 failure
2954  */
2955 int ast_sip_set_tpselector_from_transport(const struct ast_sip_transport *transport, pjsip_tpselector *selector);
2956
2957 /*!
2958  * \brief Sets pjsip_tpselector from ast_sip_transport
2959  * \since 13.8.0
2960  *
2961  * \param transport_name The name of the transport to be used
2962  * \param selector The selector to be populated
2963  * \retval 0 success
2964  * \retval -1 failure
2965  */
2966 int ast_sip_set_tpselector_from_transport_name(const char *transport_name, pjsip_tpselector *selector);
2967
2968 /*!
2969  * \brief Set name and number information on an identity header.
2970  *
2971  * \param pool Memory pool to use for string duplication
2972  * \param id_hdr A From, P-Asserted-Identity, or Remote-Party-ID header to modify
2973  * \param id The identity information to apply to the header
2974  */
2975 void ast_sip_modify_id_header(pj_pool_t *pool, pjsip_fromto_hdr *id_hdr,
2976         const struct ast_party_id *id);
2977
2978 /*!
2979  * \brief Retrieve the unidentified request security event thresholds
2980  * \since 13.8.0
2981  *
2982  * \param count The maximum number of unidentified requests per source ip to accumulate before emitting a security event
2983  * \param period The period in seconds over which to accumulate unidentified requests
2984  * \param prune_interval The interval in seconds at which expired entries will be pruned
2985  */
2986 void ast_sip_get_unidentified_request_thresholds(unsigned int *count, unsigned int *period,
2987         unsigned int *prune_interval);
2988
2989 /*!
2990  * \brief Get the transport name from an endpoint or request uri
2991  * \since 13.15.0
2992  *
2993  * \param endpoint
2994  * \param sip_uri
2995  * \param buf Buffer to receive transport name
2996  * \param buf_len Buffer length
2997  *
2998  * \retval 0 Success
2999  * \retval -1 Failure
3000  *
3001  * \note
3002  * If endpoint->transport is not NULL, it is returned in buf.
3003  * Otherwise if sip_uri has an 'x-ast-txp' parameter AND the sip_uri host is
3004  * an ip4 or ip6 address, its value is returned,
3005  */
3006 int ast_sip_get_transport_name(const struct ast_sip_endpoint *endpoint,
3007         pjsip_sip_uri *sip_uri, char *buf, size_t buf_len);
3008
3009 /*!
3010  * \brief Sets pjsip_tpselector from an endpoint or uri
3011  * \since 13.15.0
3012  *
3013  * \param endpoint If endpoint->transport is set, it's used
3014  * \param sip_uri If sip_uri contains a x-ast-txp parameter, it's used
3015  * \param selector The selector to be populated
3016  *
3017  * \retval 0 success
3018  * \retval -1 failure
3019  */
3020 int ast_sip_set_tpselector_from_ep_or_uri(const struct ast_sip_endpoint *endpoint,
3021         pjsip_sip_uri *sip_uri, pjsip_tpselector *selector);
3022
3023 /*!
3024  * \brief Set the transport on a dialog
3025  * \since 13.15.0
3026  *
3027  * \param endpoint
3028  * \param dlg
3029  * \param selector (optional)
3030  *
3031  * \note
3032  * This API calls ast_sip_get_transport_name(endpoint, dlg->target) and if the result is
3033  * non-NULL, calls pjsip_dlg_set_transport.  If 'selector' is non-NULL, it is updated with
3034  * the selector used.
3035  */
3036 int ast_sip_dlg_set_transport(const struct ast_sip_endpoint *endpoint, pjsip_dialog *dlg,
3037         pjsip_tpselector *selector);
3038
3039 /*!
3040  * \brief Convert the DTMF mode enum value into a string
3041  * \since 13.18.0
3042  *
3043  * \param dtmf the dtmf mode
3044  * \param buf Buffer to receive dtmf mode string
3045  * \param buf_len Buffer length
3046  *
3047  * \retval 0 Success
3048  * \retval -1 Failure
3049  *
3050  */
3051 int ast_sip_dtmf_to_str(const enum ast_sip_dtmf_mode dtmf,
3052         char *buf, size_t buf_len);
3053
3054 /*!
3055  * \brief Convert the DTMF mode name into an enum
3056  * \since 13.18.0
3057  *
3058  * \param dtmf_mode dtmf mode as a string
3059  *
3060  * \retval  >= 0 The enum value
3061  * \retval -1 Failure
3062  *
3063  */
3064 int ast_sip_str_to_dtmf(const char *dtmf_mode);
3065
3066 /*!
3067  * \brief Transport shutdown monitor callback.
3068  * \since 13.18.0
3069  *
3070  * \param data User data to know what to do when transport shuts down.
3071  *
3072  * \note The callback does not need to care that data is an ao2 object.
3073  *
3074  * \return Nothing
3075  */
3076 typedef void (*ast_transport_monitor_shutdown_cb)(void *data);
3077
3078 /*!
3079  * \brief Transport shutdown monitor data matcher
3080  * \since 13.20.0
3081  *
3082  * \param a User data to compare.
3083  * \param b User data to compare.
3084  *
3085  * \retval 1 The data objects match
3086  * \retval 0 The data objects don't match
3087  */
3088 typedef int (*ast_transport_monitor_data_matcher)(void *a, void *b);
3089
3090 enum ast_transport_monitor_reg {
3091         /*! \brief Successfully registered the transport monitor */
3092         AST_TRANSPORT_MONITOR_REG_SUCCESS,
3093         /*! \brief Replaced the already existing transport monitor with new one. */
3094         AST_TRANSPORT_MONITOR_REG_REPLACED,
3095         /*!
3096          * \brief Transport not found to monitor.
3097          * \note Transport is either already shutdown or is not reliable.
3098          */
3099         AST_TRANSPORT_MONITOR_REG_NOT_FOUND,
3100         /*! \brief Error while registering transport monitor. */
3101         AST_TRANSPORT_MONITOR_REG_FAILED,
3102 };
3103
3104 /*!
3105  * \brief Register a reliable transport shutdown monitor callback.
3106  * \since 13.20.0
3107  *
3108  * \param transport Transport to monitor for shutdown.
3109  * \param cb Who to call when transport is shutdown.
3110  * \param ao2_data Data to pass with the callback.
3111  *
3112  * \note The data object passed will have its reference count automatically
3113  * incremented by this call and automatically decremented after the callback
3114  * runs or when the callback is unregistered.
3115  *
3116  * There is no checking for duplicate registrations.
3117  *
3118  * \return enum ast_transport_monitor_reg
3119  */
3120 enum ast_transport_monitor_reg ast_sip_transport_monitor_register(pjsip_transport *transport,
3121         ast_transport_monitor_shutdown_cb cb, void *ao2_data);
3122
3123 /*!
3124  * \brief Unregister a reliable transport shutdown monitor
3125  * \since 13.20.0
3126  *
3127  * \param transport Transport to monitor for shutdown.
3128  * \param cb The callback that was used for the original register.
3129  * \param data Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object.
3130  *             If NULL, all monitors with the provided callbck are unregistered.
3131  * \param matches Matcher function that returns true if data matches the previously
3132  *                registered data object.  If NULL, a simple pointer comparison is done.
3133  *
3134  * \note The data object passed into the original register will have its reference count
3135  * automatically decremeneted.
3136  *
3137  * \return Nothing
3138  */
3139 void ast_sip_transport_monitor_unregister(pjsip_transport *transport,
3140         ast_transport_monitor_shutdown_cb cb, void *data, ast_transport_monitor_data_matcher matches);
3141
3142 /*!
3143  * \brief Unregister a transport shutdown monitor from all reliable transports
3144  * \since 13.20.0
3145  *
3146  * \param cb The callback that was used for the original register.
3147  * \param data Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object.
3148  *             If NULL, all monitors with the provided callbck are unregistered.
3149  * \param matches Matcher function that returns true if ao2_data matches the previously
3150  *                registered data object.  If NULL, a simple pointer comparison is done.
3151  *
3152  * \note The data object passed into the original register will have its reference count
3153  * automatically decremeneted.
3154  *
3155  * \return Nothing
3156  */
3157 void ast_sip_transport_monitor_unregister_all(ast_transport_monitor_shutdown_cb cb,
3158         void *data, ast_transport_monitor_data_matcher matches);
3159
3160 /*! Transport state notification registration element.  */
3161 struct ast_sip_tpmgr_state_callback {
3162         /*! PJPROJECT transport state notification callback */
3163         pjsip_tp_state_callback cb;
3164         AST_LIST_ENTRY(ast_sip_tpmgr_state_callback) node;
3165 };
3166
3167 /*!
3168  * \brief Register a transport state notification callback element.
3169  * \since 13.18.0
3170  *
3171  * \param element What we are registering.
3172  *
3173  * \return Nothing
3174  */
3175 void ast_sip_transport_state_register(struct ast_sip_tpmgr_state_callback *element);
3176
3177 /*!
3178  * \brief Unregister a transport state notification callback element.
3179  * \since 13.18.0
3180  *
3181  * \param element What we are unregistering.
3182  *
3183  * \return Nothing
3184  */
3185 void ast_sip_transport_state_unregister(struct ast_sip_tpmgr_state_callback *element);
3186
3187 #endif /* _RES_PJSIP_H */