8efecb62bea6f6a69aa25bb7d1676957b6484a84
[asterisk/asterisk.git] / include / asterisk / res_pjsip_session.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_SESSION_H
20 #define _RES_PJSIP_SESSION_H
21
22 /* Needed for pj_timer_entry definition */
23 #include "pjlib.h"
24 #include "asterisk/linkedlists.h"
25 /* Needed for AST_MAX_EXTENSION constant */
26 #include "asterisk/channel.h"
27 /* Needed for ast_sockaddr struct */
28 #include "asterisk/netsock2.h"
29 /* Needed for ast_sdp_srtp struct */
30 #include "asterisk/sdp_srtp.h"
31
32 /* Forward declarations */
33 struct ast_sip_endpoint;
34 struct ast_sip_transport;
35 struct pjsip_inv_session;
36 struct ast_channel;
37 struct ast_datastore;
38 struct ast_datastore_info;
39 struct ao2_container;
40 struct pjsip_tx_data;
41 struct pjsip_rx_data;
42 struct ast_party_id;
43 struct pjmedia_sdp_media;
44 struct pjmedia_sdp_session;
45 struct ast_dsp;
46 struct ast_udptl;
47
48 /*! \brief T.38 states for a session */
49 enum ast_sip_session_t38state {
50         T38_DISABLED = 0,   /*!< Not enabled */
51         T38_LOCAL_REINVITE, /*!< Offered from local - REINVITE */
52         T38_PEER_REINVITE,  /*!< Offered from peer - REINVITE */
53         T38_ENABLED,        /*!< Negotiated (enabled) */
54         T38_REJECTED,       /*!< Refused */
55         T38_MAX_ENUM,       /*!< Not an actual state; used as max value in the enum */
56 };
57
58 struct ast_sip_session_sdp_handler;
59
60 /*!
61  * \brief A structure containing SIP session media information
62  */
63 struct ast_sip_session_media {
64         union {
65                 /*! \brief RTP instance itself */
66                 struct ast_rtp_instance *rtp;
67                 /*! \brief UDPTL instance itself */
68                 struct ast_udptl *udptl;
69         };
70         /*! \brief Direct media address */
71         struct ast_sockaddr direct_media_addr;
72         /*! \brief SDP handler that setup the RTP */
73         struct ast_sip_session_sdp_handler *handler;
74         /*! \brief Holds SRTP information */
75         struct ast_sdp_srtp *srtp;
76         /*! \brief What type of encryption is in use on this stream */
77         enum ast_sip_session_media_encryption encryption;
78         /*! \brief The media transport in use for this stream */
79         pj_str_t transport;
80         /*! \brief Stream is on hold by remote side */
81         unsigned int remotely_held:1;
82         /*! \brief Stream is on hold by local side */
83         unsigned int locally_held:1;
84         /*! \brief Stream type this session media handles */
85         char stream_type[1];
86 };
87
88 /*!
89  * \brief Opaque structure representing a request that could not be sent
90  * due to an outstanding INVITE transaction
91  */
92 struct ast_sip_session_delayed_request;
93
94 /*! \brief Opaque struct controlling the suspension of the session's serializer. */
95 struct ast_sip_session_suspender;
96
97 /*!
98  * \brief A structure describing a SIP session
99  *
100  * For the sake of brevity, a "SIP session" in Asterisk is referring to
101  * a dialog initiated by an INVITE. While "session" is typically interpreted
102  * to refer to the negotiated media within a SIP dialog, we have opted
103  * to use the term "SIP session" to refer to the INVITE dialog itself.
104  */
105 struct ast_sip_session {
106         /*! Dialplan extension where incoming call is destined */
107         char exten[AST_MAX_EXTENSION];
108         /*! The endpoint with which Asterisk is communicating */
109         struct ast_sip_endpoint *endpoint;
110         /*! The AOR associated with this session */
111         struct ast_sip_aor *aor;
112         /*! The contact associated with this session */
113         struct ast_sip_contact *contact;
114         /*! The PJSIP details of the session, which includes the dialog */
115         struct pjsip_inv_session *inv_session;
116         /*! The Asterisk channel associated with the session */
117         struct ast_channel *channel;
118         /*! Registered session supplements */
119         AST_LIST_HEAD(, ast_sip_session_supplement) supplements;
120         /*! Datastores added to the session by supplements to the session */
121         struct ao2_container *datastores;
122         /*! Media streams */
123         struct ao2_container *media;
124         /*! Serializer for tasks relating to this SIP session */
125         struct ast_taskprocessor *serializer;
126         /*! Non-null if the session serializer is suspended or being suspended. */
127         struct ast_sip_session_suspender *suspended;
128         /*! Requests that could not be sent due to current inv_session state */
129         AST_LIST_HEAD_NOLOCK(, ast_sip_session_delayed_request) delayed_requests;
130         /*! When we need to reschedule a reinvite, we use this structure to do it */
131         pj_timer_entry rescheduled_reinvite;
132         /*! Format capabilities pertaining to direct media */
133         struct ast_format_cap *direct_media_cap;
134         /*! When we need to forcefully end the session */
135         pj_timer_entry scheduled_termination;
136         /*! Identity of endpoint this session deals with */
137         struct ast_party_id id;
138         /*! Requested capabilities */
139         struct ast_format_cap *req_caps;
140         /*! Optional DSP, used only for inband DTMF detection if configured */
141         struct ast_dsp *dsp;
142         /*! Whether the termination of the session should be deferred */
143         unsigned int defer_terminate:1;
144         /*! Deferred incoming re-invite */
145         pjsip_rx_data *deferred_reinvite;
146         /*! Current T.38 state */
147         enum ast_sip_session_t38state t38state;
148 };
149
150 typedef int (*ast_sip_session_request_creation_cb)(struct ast_sip_session *session, pjsip_tx_data *tdata);
151 typedef int (*ast_sip_session_response_cb)(struct ast_sip_session *session, pjsip_rx_data *rdata);
152 typedef int (*ast_sip_session_sdp_creation_cb)(struct ast_sip_session *session, pjmedia_sdp_session *sdp);
153
154 /*!
155  * \brief Describes when a supplement should be called into on incoming responses.
156  *
157  * In most cases, session supplements will not need to worry about this because in most cases,
158  * the correct value will be automatically applied. However, there are rare circumstances
159  * when a supplement will want to specify when it should be called.
160  *
161  * The values below are listed in chronological order.
162  */
163 enum ast_sip_session_response_priority {
164         /*!
165          * When processing 3XX responses, the supplement is called into before
166          * the redirecting information is processed.
167          */
168         AST_SIP_SESSION_BEFORE_REDIRECTING = (1 << 0),
169         /*!
170          * For responses to INVITE transactions, the supplement is called into
171          * before media is negotiated.
172          *
173          * This priority is applied by default to any session supplement that
174          * does not specify a response priority.
175          */
176         AST_SIP_SESSION_BEFORE_MEDIA = (1 << 1),
177         /*!
178          * For INVITE transactions, the supplement is called into after media
179          * is negotiated.
180          */
181         AST_SIP_SESSION_AFTER_MEDIA = (1 << 2),
182 };
183
184 /*!
185  * \brief A supplement to SIP message processing
186  *
187  * These can be registered by any module in order to add
188  * processing to incoming and outgoing SIP requests and responses
189  */
190 struct ast_sip_session_supplement {
191         /*! Method on which to call the callbacks. If NULL, call on all methods */
192         const char *method;
193         /*! Priority for this supplement. Lower numbers are visited before higher numbers */
194         enum ast_sip_supplement_priority priority;
195         /*!
196          * \brief Notification that the session has begun
197          * This method will always be called from a SIP servant thread.
198          */
199         void (*session_begin)(struct ast_sip_session *session);
200         /*! 
201          * \brief Notification that the session has ended
202          *
203          * This method may or may not be called from a SIP servant thread. Do
204          * not make assumptions about being able to call PJSIP methods from within
205          * this method.
206          */
207         void (*session_end)(struct ast_sip_session *session);
208         /*!
209          * \brief Notification that the session is being destroyed
210          */
211         void (*session_destroy)(struct ast_sip_session *session);
212         /*!
213          * \brief Called on incoming SIP request
214          * This method can indicate a failure in processing in its return. If there
215          * is a failure, it is required that this method sends a response to the request.
216          * This method is always called from a SIP servant thread.
217          *
218          * \note
219          * The following PJSIP methods will not work properly:
220          * pjsip_rdata_get_dlg()
221          * pjsip_rdata_get_tsx()
222          * The reason is that the rdata passed into this function is a cloned rdata structure,
223          * and its module data is not copied during the cloning operation.
224          * If you need to get the dialog, you can get it via session->inv_session->dlg.
225          *
226          * \note
227          * There is no guarantee that a channel will be present on the session when this is called.
228          */
229         int (*incoming_request)(struct ast_sip_session *session, struct pjsip_rx_data *rdata);
230         /*! 
231          * \brief Called on an incoming SIP response
232          * This method is always called from a SIP servant thread.
233          *
234          * \note
235          * The following PJSIP methods will not work properly:
236          * pjsip_rdata_get_dlg()
237          * pjsip_rdata_get_tsx()
238          * The reason is that the rdata passed into this function is a cloned rdata structure,
239          * and its module data is not copied during the cloning operation.
240          * If you need to get the dialog, you can get it via session->inv_session->dlg.
241          *
242          * \note
243          * There is no guarantee that a channel will be present on the session when this is called.
244          */
245         void (*incoming_response)(struct ast_sip_session *session, struct pjsip_rx_data *rdata);
246         /*!
247          * \brief Called on an outgoing SIP request
248          * This method is always called from a SIP servant thread.
249          */
250         void (*outgoing_request)(struct ast_sip_session *session, struct pjsip_tx_data *tdata);
251         /*! 
252          * \brief Called on an outgoing SIP response
253          * This method is always called from a SIP servant thread.
254          */
255         void (*outgoing_response)(struct ast_sip_session *session, struct pjsip_tx_data *tdata);
256         /*! Next item in the list */
257         AST_LIST_ENTRY(ast_sip_session_supplement) next;
258         /*!
259          * Determines when the supplement is processed when handling a response.
260          * Defaults to AST_SIP_SESSION_BEFORE_MEDIA
261          */
262         enum ast_sip_session_response_priority response_priority;
263 };
264
265 enum ast_sip_session_sdp_stream_defer {
266         /*! The stream was not handled by this handler. If there are other registered handlers for this stream type, they will be called. */
267         AST_SIP_SESSION_SDP_DEFER_NOT_HANDLED,
268         /*! There was an error encountered. No further operations will take place and the current negotiation will be abandoned. */
269         AST_SIP_SESSION_SDP_DEFER_ERROR,
270         /*! Re-invite is not needed */
271         AST_SIP_SESSION_SDP_DEFER_NOT_NEEDED,
272         /*! Re-invite should be deferred and will be resumed later. No further operations will take place. */
273         AST_SIP_SESSION_SDP_DEFER_NEEDED,
274 };
275
276 /*!
277  * \brief A handler for SDPs in SIP sessions
278  *
279  * An SDP handler is registered by a module that is interested in being the
280  * responsible party for specific types of SDP streams.
281  */
282 struct ast_sip_session_sdp_handler {
283         /*! An identifier for this handler */
284         const char *id;
285         /*!
286          * \brief Determine whether a stream requires that the re-invite be deferred.
287          * If a stream can not be immediately negotiated the re-invite can be deferred and
288          * resumed at a later time. It is up to the handler which caused deferral to occur
289          * to resume it.
290          *
291          * \param session The session for which the media is being re-invited
292          * \param session_media The media being reinvited
293          * \param sdp The entire SDP. Useful for getting "global" information, such as connections or attributes
294          * \param stream PJSIP incoming SDP media lines to parse by handler.
295          *
296          * \return enum ast_sip_session_defer_stream
297          *
298          * \note This is optional, if not implemented the stream is assumed to not be deferred.
299          */
300         enum ast_sip_session_sdp_stream_defer (*defer_incoming_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *sdp, const struct pjmedia_sdp_media *stream);
301         /*!
302          * \brief Set session details based on a stream in an incoming SDP offer or answer
303          * \param session The session for which the media is being negotiated
304          * \param session_media The media to be setup for this session
305          * \param sdp The entire SDP. Useful for getting "global" information, such as connections or attributes
306          * \param stream The stream on which to operate
307          * \retval 0 The stream was not handled by this handler. If there are other registered handlers for this stream type, they will be called.
308          * \retval <0 There was an error encountered. No further operation will take place and the current negotiation will be abandoned.
309          * \retval >0 The stream was handled by this handler. No further handler of this stream type will be called.
310          */
311         int (*negotiate_incoming_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *sdp, const struct pjmedia_sdp_media *stream);
312         /*!
313          * \brief Create an SDP media stream and add it to the outgoing SDP offer or answer
314          * \param session The session for which media is being added
315          * \param session_media The media to be setup for this session
316          * \param stream The stream on which to operate
317          * \retval 0 The stream was not handled by this handler. If there are other registered handlers for this stream type, they will be called.
318          * \retval <0 There was an error encountered. No further operation will take place and the current negotiation will be abandoned.
319          * \retval >0 The stream was handled by this handler. No further handler of this stream type will be called.
320          */
321         int (*handle_incoming_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *sdp, struct pjmedia_sdp_media *stream);
322         /*!
323          * \brief Create an SDP media stream and add it to the outgoing SDP offer or answer
324          * \param session The session for which media is being added
325          * \param session_media The media to be setup for this session
326          * \param sdp The entire SDP as currently built
327          * \retval 0 This handler has no stream to add. If there are other registered handlers for this stream type, they will be called.
328          * \retval <0 There was an error encountered. No further operation will take place and the current SDP negotiation will be abandoned.
329          * \retval >0 The handler has a stream to be added to the SDP. No further handler of this stream type will be called.
330          */
331         int (*create_outgoing_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, struct pjmedia_sdp_session *sdp);
332         /*!
333          * \brief Update media stream with external address if applicable
334          * \param tdata The outgoing message itself
335          * \param stream The stream on which to operate
336          * \param transport The transport the SDP is going out on
337          */
338         void (*change_outgoing_sdp_stream_media_address)(struct pjsip_tx_data *tdata, struct pjmedia_sdp_media *stream, struct ast_sip_transport *transport);
339         /*!
340          * \brief Apply a negotiated SDP media stream
341          * \param session The session for which media is being applied
342          * \param session_media The media to be setup for this session
343          * \param local The entire local negotiated SDP
344          * \param local_stream The local stream which to apply
345          * \param remote The entire remote negotiated SDP
346          * \param remote_stream The remote stream which to apply
347          * \retval 0 The stream was not applied by this handler. If there are other registered handlers for this stream type, they will be called.
348          * \retval <0 There was an error encountered. No further operation will take place and the current application will be abandoned.
349          * \retval >0 The stream was handled by this handler. No further handler of this stream type will be called.
350          */
351         int (*apply_negotiated_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *local, const struct pjmedia_sdp_media *local_stream,
352                 const struct pjmedia_sdp_session *remote, const struct pjmedia_sdp_media *remote_stream);
353         /*!
354          * \brief Destroy a session_media created by this handler
355          * \param session The session for which media is being destroyed
356          * \param session_media The media to destroy
357          */
358         void (*stream_destroy)(struct ast_sip_session_media *session_media);
359         /*! Next item in the list. */
360         AST_LIST_ENTRY(ast_sip_session_sdp_handler) next;
361 };
362
363 /*!
364  * \brief A structure which contains a channel implementation and session
365  */
366 struct ast_sip_channel_pvt {
367         /*! \brief Pointer to channel specific implementation information, must be ao2 object */
368         void *pvt;
369         /*! \brief Pointer to session */
370         struct ast_sip_session *session;
371 };
372
373 /*!
374  * \brief Allocate a new SIP channel pvt structure
375  *
376  * \param pvt Pointer to channel specific implementation
377  * \param session Pointer to SIP session
378  *
379  * \retval non-NULL success
380  * \retval NULL failure
381  */
382 struct ast_sip_channel_pvt *ast_sip_channel_pvt_alloc(void *pvt, struct ast_sip_session *session);
383
384 /*!
385  * \brief Allocate a new SIP session
386  *
387  * This will take care of allocating the datastores container on the session as well
388  * as placing all registered supplements onto the session.
389  *
390  * The endpoint that is passed in will have its reference count increased by one since
391  * the session will be keeping a reference to the endpoint. The session will relinquish
392  * this reference when the session is destroyed.
393  *
394  * \param endpoint The endpoint that this session communicates with
395  * \param contact The contact associated with this session
396  * \param inv_session The PJSIP INVITE session data
397  */
398 struct ast_sip_session *ast_sip_session_alloc(struct ast_sip_endpoint *endpoint,
399         struct ast_sip_contact *contact, pjsip_inv_session *inv);
400
401 /*!
402  * \brief Request and wait for the session serializer to be suspended.
403  * \since 12.7.0
404  *
405  * \param session Which session to suspend the serializer.
406  *
407  * \note No channel locks can be held while calling without risk of deadlock.
408  *
409  * \return Nothing
410  */
411 void ast_sip_session_suspend(struct ast_sip_session *session);
412
413 /*!
414  * \brief Request the session serializer be unsuspended.
415  * \since 12.7.0
416  *
417  * \param session Which session to unsuspend the serializer.
418  *
419  * \return Nothing
420  */
421 void ast_sip_session_unsuspend(struct ast_sip_session *session);
422
423 /*!
424  * \brief Create a new outgoing SIP session
425  *
426  * The endpoint that is passed in will have its reference count increased by one since
427  * the session will be keeping a reference to the endpoint. The session will relinquish
428  * this reference when the session is destroyed.
429  *
430  * \param endpoint The endpoint that this session uses for settings
431  * \param contact The contact that this session will communicate with
432  * \param location Name of the location to call, be it named location or explicit URI. Overrides contact if present.
433  * \param request_user Optional request user to place in the request URI if permitted
434  * \param req_caps The requested capabilities
435  */
436 struct ast_sip_session *ast_sip_session_create_outgoing(struct ast_sip_endpoint *endpoint,
437         struct ast_sip_contact *contact, const char *location, const char *request_user,
438         struct ast_format_cap *req_caps);
439
440 /*!
441  * \brief Terminate a session and, if possible, send the provided response code
442  *
443  * \param session The session to terminate
444  * \param response The response code to use for termination if possible
445  */
446 void ast_sip_session_terminate(struct ast_sip_session *session, int response);
447
448 /*!
449  * \brief Defer local termination of a session until remote side terminates, or an amount of time passes
450  *
451  * \param session The session to defer termination on
452  */
453 void ast_sip_session_defer_termination(struct ast_sip_session *session);
454
455 /*!
456  * \brief Register an SDP handler
457  *
458  * An SDP handler is responsible for parsing incoming SDP streams and ensuring that
459  * Asterisk can cope with the contents. Similarly, the SDP handler will be
460  * responsible for constructing outgoing SDP streams.
461  *
462  * Multiple handlers for the same stream type may be registered. They will be
463  * visited in the order they were registered. Handlers will be visited for each
464  * stream type until one claims to have handled the stream.
465  *
466  * \param handler The SDP handler to register
467  * \param stream_type The type of media stream for which to call the handler
468  * \retval 0 Success
469  * \retval -1 Failure
470  */
471 int ast_sip_session_register_sdp_handler(struct ast_sip_session_sdp_handler *handler, const char *stream_type);
472
473 /*!
474  * \brief Unregister an SDP handler
475  *
476  * \param handler The SDP handler to unregister
477  * \param stream_type Stream type for which the SDP handler was registered
478  */
479 void ast_sip_session_unregister_sdp_handler(struct ast_sip_session_sdp_handler *handler, const char *stream_type);
480
481 /*!
482  * \brief Register a supplement to SIP session processing
483  *
484  * This allows for someone to insert themselves in the processing of SIP
485  * requests and responses. This, for example could allow for a module to
486  * set channel data based on headers in an incoming message. Similarly,
487  * a module could reject an incoming request if desired.
488  *
489  * \param supplement The supplement to register
490  * \retval 0 Success
491  * \retval -1 Failure
492  */
493 int ast_sip_session_register_supplement(struct ast_sip_session_supplement *supplement);
494
495 /*!
496  * \brief Unregister a an supplement to SIP session processing
497  *
498  * \param supplement The supplement to unregister
499  */
500 void ast_sip_session_unregister_supplement(struct ast_sip_session_supplement *supplement);
501
502 /*!
503  * \brief Alternative for ast_datastore_alloc()
504  *
505  * There are two major differences between this and ast_datastore_alloc()
506  * 1) This allocates a refcounted object
507  * 2) This will fill in a uid if one is not provided
508  *
509  * DO NOT call ast_datastore_free() on a datastore allocated in this
510  * way since that function will attempt to free the datastore rather
511  * than play nicely with its refcount.
512  *
513  * \param info Callbacks for datastore
514  * \param uid Identifier for datastore
515  * \retval NULL Failed to allocate datastore
516  * \retval non-NULL Newly allocated datastore
517  */
518 struct ast_datastore *ast_sip_session_alloc_datastore(const struct ast_datastore_info *info, const char *uid);
519
520 /*!
521  * \brief Add a datastore to a SIP session
522  *
523  * Note that SIP uses reference counted datastores. The datastore passed into this function
524  * must have been allocated using ao2_alloc() or there will be serious problems.
525  *
526  * \param session The session to add the datastore to
527  * \param datastore The datastore to be added to the session
528  * \retval 0 Success
529  * \retval -1 Failure
530  */
531 int ast_sip_session_add_datastore(struct ast_sip_session *session, struct ast_datastore *datastore);
532
533 /*!
534  * \brief Retrieve a session datastore
535  *
536  * The datastore retrieved will have its reference count incremented. When the caller is done
537  * with the datastore, the reference counted needs to be decremented using ao2_ref().
538  *
539  * \param session The session from which to retrieve the datastore
540  * \param name The name of the datastore to retrieve
541  * \retval NULL Failed to find the specified datastore
542  * \retval non-NULL The specified datastore
543  */
544 struct ast_datastore *ast_sip_session_get_datastore(struct ast_sip_session *session, const char *name);
545
546 /*!
547  * \brief Remove a session datastore from the session
548  *
549  * This operation may cause the datastore's free() callback to be called if the reference
550  * count reaches zero.
551  *
552  * \param session The session to remove the datastore from
553  * \param name The name of the datastore to remove
554  */
555 void ast_sip_session_remove_datastore(struct ast_sip_session *session, const char *name);
556
557 /*!
558  * \brief Send a reinvite or UPDATE on a session
559  *
560  * This method will inspect the session in order to construct an appropriate
561  * session refresh request. As with any outgoing request in res_pjsip_session,
562  * this will call into registered supplements in case they wish to add anything.
563  *
564  * Note: The on_request_creation callback may or may not be called in the same
565  * thread where this function is called. Request creation may need to be delayed
566  * due to the current INVITE transaction state.
567  * 
568  * \param session The session on which the reinvite will be sent
569  * \param on_request_creation Callback called when request is created
570  * \param on_sdp_creation Callback called when SDP is created
571  * \param on_response Callback called when response for request is received
572  * \param method The method that should be used when constructing the session refresh
573  * \param generate_new_sdp Boolean to indicate if a new SDP should be created
574  * \retval 0 Successfully sent refresh
575  * \retval -1 Failure to send refresh
576  */
577 int ast_sip_session_refresh(struct ast_sip_session *session,
578                 ast_sip_session_request_creation_cb on_request_creation,
579                 ast_sip_session_sdp_creation_cb on_sdp_creation,
580                 ast_sip_session_response_cb on_response,
581                 enum ast_sip_session_refresh_method method,
582                 int generate_new_sdp);
583
584 /*!
585  * \brief Send a SIP response
586  *
587  * This will send the SIP response specified in tdata and
588  * call into any registered supplements' outgoing_response callback.
589  *
590  * \param session The session on which to send the response.
591  * \param tdata The response to send
592  */
593 void ast_sip_session_send_response(struct ast_sip_session *session, pjsip_tx_data *tdata);
594
595 /*!
596  * \brief Send a SIP request
597  *
598  * This will send the SIP request specified in tdata and
599  * call into any registered supplements' outgoing_request callback.
600  *
601  * \param session The session to which to send the request
602  * \param tdata The request to send
603  */
604 void ast_sip_session_send_request(struct ast_sip_session *session, pjsip_tx_data *tdata);
605
606 /*!
607  * \brief Creates an INVITE request.
608  *
609  * \param session Starting session for the INVITE
610  * \param tdata The created request.
611  */
612 int ast_sip_session_create_invite(struct ast_sip_session *session, pjsip_tx_data **tdata);
613
614 /*!
615  * \brief Send a SIP request and get called back when a response is received
616  *
617  * This will send the request out exactly the same as ast_sip_send_request() does.
618  * The difference is that when a response arrives, the specified callback will be
619  * called into
620  *
621  * \param session The session on which to send the request
622  * \param tdata The request to send
623  * \param on_response Callback to be called when a response is received
624  */
625 void ast_sip_session_send_request_with_cb(struct ast_sip_session *session, pjsip_tx_data *tdata,
626                 ast_sip_session_response_cb on_response);
627
628 /*!
629  * \brief Retrieves a session from a dialog
630  *
631  * \param dlg The dialog to retrieve the session from
632  *
633  * \retval non-NULL if session exists
634  * \retval NULL if no session
635  *
636  * \note The reference count of the session is increased when returned
637  *
638  * \note This function *must* be called with the dialog locked
639  */
640 struct ast_sip_session *ast_sip_dialog_get_session(pjsip_dialog *dlg);
641
642 /*!
643  * \brief Resumes processing of a deferred incoming re-invite
644  *
645  * \param session The session which has a pending incoming re-invite
646  *
647  * \note When resuming a re-invite it is given to the pjsip stack as if it
648  *       had just been received from a transport, this means that the deferral
649  *       callback will be called again.
650  */
651 void ast_sip_session_resume_reinvite(struct ast_sip_session *session);
652
653 /*! \brief Determines whether the res_pjsip_session module is loaded */
654 #define CHECK_PJSIP_SESSION_MODULE_LOADED()                             \
655         do {                                                            \
656                 CHECK_PJSIP_MODULE_LOADED();                            \
657                 if (!ast_module_check("res_pjsip_session.so")) {        \
658                         return AST_MODULE_LOAD_DECLINE;                 \
659                 }                                                       \
660         } while(0)
661
662 #endif /* _RES_PJSIP_SESSION_H */