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