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