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