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