soa 1.12.11devel
Loading...
Searching...
No Matches
soa.h
Go to the documentation of this file.
1/*
2 * This file is part of the Sofia-SIP package
3 *
4 * Copyright (C) 2005 Nokia Corporation.
5 *
6 * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; either version 2.1 of
11 * the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21 * 02110-1301 USA
22 *
23 */
24
25#ifndef SOA_H
27#define SOA_H
36#ifndef SU_WAIT_H
37#include <sofia-sip/su_wait.h>
38#endif
39#ifndef SU_TAG_H
40#include <sofia-sip/su_tag.h>
41#endif
42
43SOFIA_BEGIN_DECLS
44
45typedef struct soa_session soa_session_t;
46
47struct sdp_session_s;
48
49#ifndef SOA_MAGIC_T
50#define SOA_MAGIC_T void
51#endif
52
53typedef SOA_MAGIC_T soa_magic_t;
54
55typedef int soa_callback_f(soa_magic_t *arg, soa_session_t *session);
56
57SOFIAPUBFUN soa_session_t *soa_create(char const *name, su_root_t *, soa_magic_t *);
58
60
62
64 tag_type_t tag, tag_value_t value, ...);
66 tag_type_t tag, tag_value_t value, ...);
67
69 tag_type_t tag, tag_value_t value, ...);
70
72 char const **return_phrase);
73
75
76SOFIAPUBFUN int soa_get_warning(soa_session_t *ss, char const **return_phrase);
77
79 struct sdp_session_s const *sdp,
80 char const *str, issize_t len);
81
83 struct sdp_session_s const **return_sdp,
84 char const **return_sdp_str,
85 isize_t *return_len);
86
88 struct sdp_session_s const *sdp,
89 char const *str, issize_t len);
90
92 struct sdp_session_s const **return_sdp,
93 char const **return_sdp_str,
94 isize_t *return_len);
95
97
99
101 struct sdp_session_s const *sdp,
102 char const *str, issize_t len);
103
105 struct sdp_session_s const **return_sdp,
106 char const **return_sdp_str,
107 isize_t *return_len);
108
110
112 struct sdp_session_s const **return_sdp,
113 char const **return_sdp_str,
114 isize_t *return_len);
115
116SOFIAPUBFUN char const * const * soa_sip_require(soa_session_t const *ss);
117SOFIAPUBFUN char const * const * soa_sip_supported(soa_session_t const *ss);
118
119SOFIAPUBFUN int soa_remote_sip_features(soa_session_t *ss,
120 char const * const * support,
121 char const * const * required);
122
123SOFIAPUBFUN char **soa_media_features(soa_session_t *ss, int live, su_home_t *home);
124
125SOFIAPUBFUN int soa_generate_offer(soa_session_t *, int always, soa_callback_f *);
126SOFIAPUBFUN int soa_generate_answer(soa_session_t *, soa_callback_f *);
127SOFIAPUBFUN int soa_process_answer(soa_session_t *, soa_callback_f *);
128SOFIAPUBFUN int soa_process_reject(soa_session_t *, soa_callback_f *);
129
130SOFIAPUBFUN int soa_activate(soa_session_t *, char const *option);
131SOFIAPUBFUN int soa_deactivate(soa_session_t *, char const *option);
132
133SOFIAPUBFUN void soa_terminate(soa_session_t *, char const *option);
134
136
138
143
148
150
151SOFIAPUBFUN int soa_tag_filter(tagi_t const *f, tagi_t const *t);
152
153SOFIA_END_DECLS
154
155#endif
tagi_t * soa_get_paramlist(soa_session_t const *ss, tag_type_t tag, tag_value_t value,...)
Return a list of parameters.
Definition soa.c:713
char ** soa_media_features(soa_session_t *ss, int live, su_home_t *home)
Return list of media fetures.
Definition soa.c:1345
int soa_generate_offer(soa_session_t *, int always, soa_callback_f *)
Generate offer.
Definition soa.c:1445
int soa_get_params(soa_session_t const *ss, tag_type_t tag, tag_value_t value,...)
Get tagged parameters.
Definition soa.c:625
int soa_is_remote_image_active(soa_session_t const *ss)
Return true if image sharing is active (not on hold).
Definition soa.c:1890
int soa_get_local_sdp(soa_session_t const *ss, struct sdp_session_s const **return_sdp, char const **return_sdp_str, isize_t *return_len)
Get local SDP.
Definition soa.c:1284
int soa_set_remote_sdp(soa_session_t *ss, struct sdp_session_s const *sdp, char const *str, issize_t len)
Set remote SDP (offer or answer).
Definition soa.c:1190
int soa_get_user_version(soa_session_t const *ss)
Returns the version number of user session description.
Definition soa.c:1036
void soa_terminate(soa_session_t *, char const *option)
Terminate session.
Definition soa.c:1805
int soa_is_complete(soa_session_t const *ss)
Return true if the SDP Offer/Answer negotation is complete.
Definition soa.c:1836
int soa_get_warning(soa_session_t *ss, char const **return_phrase)
Return SIP Warning code and text.
Definition soa.c:830
int soa_is_remote_video_active(soa_session_t const *ss)
Return true if remote video is active (not on hold).
Definition soa.c:1882
int soa_set_user_sdp(soa_session_t *ss, struct sdp_session_s const *sdp, char const *str, issize_t len)
Store user SDP to soa session.
Definition soa.c:1071
int soa_activate(soa_session_t *, char const *option)
Activate session.
Definition soa.c:1751
int soa_is_remote_chat_active(soa_session_t const *ss)
Return true if chat session is active (not on hold).
Definition soa.c:1898
int soa_tag_filter(tagi_t const *f, tagi_t const *t)
Filter soa tags.
Definition soa_tag.c:54
int soa_is_delayed_offer(soa_session_t const *ss)
Return true if delayed offer has been activated.
Definition soa.c:1906
int soa_process_answer(soa_session_t *, soa_callback_f *)
Complete offer-answer after receiving answer.
Definition soa.c:1615
int soa_get_user_sdp(soa_session_t const *ss, struct sdp_session_s const **return_sdp, char const **return_sdp_str, isize_t *return_len)
Return user SDP description.
Definition soa.c:995
int soa_set_params(soa_session_t *ss, tag_type_t tag, tag_value_t value,...)
Set parameters.
Definition soa.c:397
int soa_set_capability_sdp(soa_session_t *ss, struct sdp_session_s const *sdp, char const *str, issize_t len)
Set capability SDP.
Definition soa.c:909
int soa_error_as_sip_response(soa_session_t *soa, char const **return_phrase)
Convert soa error to a SIP response code and phrase.
Definition soa.c:788
struct soa_session soa_session_t
"soa" session object.
Definition soa.h:45
int soa_process_reject(soa_session_t *, soa_callback_f *)
Process rejection of offer.
Definition soa.c:1696
int soa_is_chat_active(soa_session_t const *ss)
Return true if messaging session has been activated.
Definition soa.c:1866
int soa_deactivate(soa_session_t *, char const *option)
Deactivate session.
Definition soa.c:1782
int soa_is_remote_audio_active(soa_session_t const *ss)
Return true if remote audio is active (not on hold).
Definition soa.c:1874
int soa_clear_remote_sdp(soa_session_t *ss)
Clear remote SDP.
Definition soa.c:1235
int soa_is_video_active(soa_session_t const *ss)
Return true if video has been activated.
Definition soa.c:1850
int soa_generate_answer(soa_session_t *, soa_callback_f *)
Process offer, generate answer.
Definition soa.c:1535
int soa_get_capability_sdp(soa_session_t const *ss, struct sdp_session_s const **return_sdp, char const **return_sdp_str, isize_t *return_len)
Return SDP description of capabilities.
Definition soa.c:859
soa_session_t * soa_create(char const *name, su_root_t *, soa_magic_t *)
Create a soa session.
Definition soa.c:218
char const * soa_error_as_sip_reason(soa_session_t *soa)
Convert soa error to a SIP Reason header.
Definition soa.c:806
int soa_init_offer_answer(soa_session_t *ss)
Initialize the offer/answer state machine.
Definition soa.c:1321
int soa_get_remote_version(soa_session_t const *ss)
Returns the version number of remote session description.
Definition soa.c:1153
int soa_is_audio_active(soa_session_t const *ss)
Return true if audio has been activated.
Definition soa.c:1842
soa_session_t * soa_clone(soa_session_t *, su_root_t *, soa_magic_t *)
Create a copy of a soa session object.
Definition soa.c:270
void soa_destroy(soa_session_t *)
Destroy a session.
Definition soa.c:352
int soa_get_remote_sdp(soa_session_t const *ss, struct sdp_session_s const **return_sdp, char const **return_sdp_str, isize_t *return_len)
Return remote SDP description of the session.
Definition soa.c:1112
int soa_is_image_active(soa_session_t const *ss)
Return true if image sharing has been activated.
Definition soa.c:1858
SU_HOME_T su_home_t
#define SOFIAPUBFUN
intptr_t tag_value_t
struct tag_type_s const * tag_type_t
struct su_root_t su_root_t

Sofia-SIP 1.12.11devel - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.