1eXosip2 event API(3) libeXosip2 eXosip2 event API(3)
2
6 eXosip2 event API -
7 Data Structures
9 struct eXosip_event
10 struct eXosip_event
11 Enumerations
13 enum eXosip_event_type { EXOSIP_REGISTRATION_NEW,
14 EXOSIP_REGISTRATION_SUCCESS, EXOSIP_REGISTRATION_FAILURE,
15 EXOSIP_REGISTRATION_REFRESHED, EXOSIP_REGISTRATION_TERMINATED,
16 EXOSIP_CALL_INVITE, EXOSIP_CALL_REINVITE, EXOSIP_CALL_NOANSWER,
17 EXOSIP_CALL_PROCEEDING, EXOSIP_CALL_RINGING, EXOSIP_CALL_ANSWERED,
18 EXOSIP_CALL_REDIRECTED, EXOSIP_CALL_REQUESTFAILURE,
19 EXOSIP_CALL_SERVERFAILURE, EXOSIP_CALL_GLOBALFAILURE,
20 EXOSIP_CALL_ACK, EXOSIP_CALL_CANCELLED, EXOSIP_CALL_TIMEOUT,
21 EXOSIP_CALL_MESSAGE_NEW, EXOSIP_CALL_MESSAGE_PROCEEDING,
22 EXOSIP_CALL_MESSAGE_ANSWERED, EXOSIP_CALL_MESSAGE_REDIRECTED,
23 EXOSIP_CALL_MESSAGE_REQUESTFAILURE,
24 EXOSIP_CALL_MESSAGE_SERVERFAILURE,
25 EXOSIP_CALL_MESSAGE_GLOBALFAILURE, EXOSIP_CALL_CLOSED,
26 EXOSIP_CALL_RELEASED, EXOSIP_MESSAGE_NEW,
27 EXOSIP_MESSAGE_PROCEEDING, EXOSIP_MESSAGE_ANSWERED,
28 EXOSIP_MESSAGE_REDIRECTED, EXOSIP_MESSAGE_REQUESTFAILURE,
29 EXOSIP_MESSAGE_SERVERFAILURE, EXOSIP_MESSAGE_GLOBALFAILURE,
30 EXOSIP_SUBSCRIPTION_UPDATE, EXOSIP_SUBSCRIPTION_CLOSED,
31 EXOSIP_SUBSCRIPTION_NOANSWER, EXOSIP_SUBSCRIPTION_PROCEEDING,
32 EXOSIP_SUBSCRIPTION_ANSWERED, EXOSIP_SUBSCRIPTION_REDIRECTED,
33 EXOSIP_SUBSCRIPTION_REQUESTFAILURE,
34 EXOSIP_SUBSCRIPTION_SERVERFAILURE,
35 EXOSIP_SUBSCRIPTION_GLOBALFAILURE, EXOSIP_SUBSCRIPTION_NOTIFY,
36 EXOSIP_SUBSCRIPTION_RELEASED, EXOSIP_IN_SUBSCRIPTION_NEW,
37 EXOSIP_IN_SUBSCRIPTION_RELEASED, EXOSIP_NOTIFICATION_NOANSWER,
38 EXOSIP_NOTIFICATION_PROCEEDING, EXOSIP_NOTIFICATION_ANSWERED,
39 EXOSIP_NOTIFICATION_REDIRECTED, EXOSIP_NOTIFICATION_REQUESTFAILURE,
40 EXOSIP_NOTIFICATION_SERVERFAILURE,
41 EXOSIP_NOTIFICATION_GLOBALFAILURE, EXOSIP_EVENT_COUNT }
42 Functions
44 void eXosip_event_free (eXosip_event_t *je)
45 eXosip_event_t * eXosip_event_wait (int tv_s, int tv_ms)
46 eXosip_event_t * eXosip_event_get (void)
47
49 enum eXosip_event_type
50 Structure for event type description
51 Enumerator:
53 EXOSIP_REGISTRATION_NEW
55 announce new registration.
56 EXOSIP_REGISTRATION_SUCCESS
58 user is successfully registred.
59 EXOSIP_REGISTRATION_FAILURE
61 user is not registred.
62 EXOSIP_REGISTRATION_REFRESHED
64 registration has been refreshed.
65 EXOSIP_REGISTRATION_TERMINATED
67 UA is not registred any more.
68 EXOSIP_CALL_INVITE
70 announce a new call
71 EXOSIP_CALL_REINVITE
73 announce a new INVITE within call
74 EXOSIP_CALL_NOANSWER
76 announce no answer within the timeout
77 EXOSIP_CALL_PROCEEDING
79 announce processing by a remote app
80 EXOSIP_CALL_RINGING
82 announce ringback
83 EXOSIP_CALL_ANSWERED
85 announce start of call
86 EXOSIP_CALL_REDIRECTED
88 announce a redirection
89 EXOSIP_CALL_REQUESTFAILURE
91 announce a request failure
92 EXOSIP_CALL_SERVERFAILURE
94 announce a server failure
95 EXOSIP_CALL_GLOBALFAILURE
97 announce a global failure
98 EXOSIP_CALL_ACK
100 ACK received for 200ok to INVITE
101 EXOSIP_CALL_CANCELLED
103 announce that call has been cancelled
104 EXOSIP_CALL_TIMEOUT
106 announce that call has failed
107 EXOSIP_CALL_MESSAGE_NEW
109 announce new incoming request.
110 EXOSIP_CALL_MESSAGE_PROCEEDING
112 announce a 1xx for request.
113 EXOSIP_CALL_MESSAGE_ANSWERED
115 announce a 200ok
116 EXOSIP_CALL_MESSAGE_REDIRECTED
118 announce a failure.
119 EXOSIP_CALL_MESSAGE_REQUESTFAILURE
121 announce a failure.
122 EXOSIP_CALL_MESSAGE_SERVERFAILURE
124 announce a failure.
125 EXOSIP_CALL_MESSAGE_GLOBALFAILURE
127 announce a failure.
128 EXOSIP_CALL_CLOSED
130 a BYE was received for this call
131 EXOSIP_CALL_RELEASED
133 call context is cleared.
134 EXOSIP_MESSAGE_NEW
136 announce new incoming request.
137 EXOSIP_MESSAGE_PROCEEDING
139 announce a 1xx for request.
140 EXOSIP_MESSAGE_ANSWERED
142 announce a 200ok
143 EXOSIP_MESSAGE_REDIRECTED
145 announce a failure.
146 EXOSIP_MESSAGE_REQUESTFAILURE
148 announce a failure.
149 EXOSIP_MESSAGE_SERVERFAILURE
151 announce a failure.
152 EXOSIP_MESSAGE_GLOBALFAILURE
154 announce a failure.
155 EXOSIP_SUBSCRIPTION_UPDATE
157 announce incoming SUBSCRIBE.
158 EXOSIP_SUBSCRIPTION_CLOSED
160 announce end of subscription.
161 EXOSIP_SUBSCRIPTION_NOANSWER
163 announce no answer
164 EXOSIP_SUBSCRIPTION_PROCEEDING
166 announce a 1xx
167 EXOSIP_SUBSCRIPTION_ANSWERED
169 announce a 200ok
170 EXOSIP_SUBSCRIPTION_REDIRECTED
172 announce a redirection
173 EXOSIP_SUBSCRIPTION_REQUESTFAILURE
175 announce a request failure
176 EXOSIP_SUBSCRIPTION_SERVERFAILURE
178 announce a server failure
179 EXOSIP_SUBSCRIPTION_GLOBALFAILURE
181 announce a global failure
182 EXOSIP_SUBSCRIPTION_NOTIFY
184 announce new NOTIFY request
185 EXOSIP_SUBSCRIPTION_RELEASED
187 call context is cleared.
188 EXOSIP_IN_SUBSCRIPTION_NEW
190 announce new incoming SUBSCRIBE.
191 EXOSIP_IN_SUBSCRIPTION_RELEASED
193 announce end of subscription.
194 EXOSIP_NOTIFICATION_NOANSWER
196 announce no answer
197 EXOSIP_NOTIFICATION_PROCEEDING
199 announce a 1xx
200 EXOSIP_NOTIFICATION_ANSWERED
202 announce a 200ok
203 EXOSIP_NOTIFICATION_REDIRECTED
205 announce a redirection
206 EXOSIP_NOTIFICATION_REQUESTFAILURE
208 announce a request failure
209 EXOSIP_NOTIFICATION_SERVERFAILURE
211 announce a server failure
212 EXOSIP_NOTIFICATION_GLOBALFAILURE
214 announce a global failure
215 EXOSIP_EVENT_COUNT
217 MAX number of events
218
220 void eXosip_event_free (eXosip_event_t * je)
221 Free ressource in an eXosip event.
222 Parameters:
224 je event to work on.
225 eXosip_event_t* eXosip_event_wait (int tv_s, int tv_ms)
227 Wait for an eXosip event.
228 Parameters:
230 tv_s timeout value (seconds).
231 tv_ms timeout value (mseconds).
232 eXosip_event_t* eXosip_event_get (void)
234 Wait for next eXosip event.
235Version 3.0.1 30 Aug 2007 eXosip2 event API(3)