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