1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
/* $Id$ */
/*
* Copyright (C) 2003-2006 Benny Prijono <benny@prijono.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef __PJSIP_SIP_REG_H__
#define __PJSIP_SIP_REG_H__
/**
* @file sip_reg.h
* @brief SIP Registration Client
*/
#include <pjsip/sip_types.h>
#include <pjsip/sip_auth.h>
#include <pjsip/sip_transport.h>
/**
* @defgroup PJSUA_REGC Client Registration
* @ingroup PJSIP_HIGH_UA
* @brief High Layer API for performing client registration.
* @{
*
* This provides API for performing client registration. Application must
* link with <b>pjsip-ua</b> static library to use this API.
*/
PJ_BEGIN_DECL
/** Typedef for client registration data. */
typedef struct pjsip_regc pjsip_regc;
/** Maximum contacts in registration. */
#define PJSIP_REGC_MAX_CONTACT 10
/** Expiration not specified. */
#define PJSIP_REGC_EXPIRATION_NOT_SPECIFIED ((pj_uint32_t)0xFFFFFFFFUL)
/** Buffer to hold all contacts. */
#define PJSIP_REGC_CONTACT_BUF_SIZE 512
/** Structure to hold parameters when calling application's callback.
* The application's callback is called when the client registration process
* has finished.
*/
struct pjsip_regc_cbparam
{
pjsip_regc *regc; /**< Client registration structure. */
void *token; /**< Arbitrary token. */
pj_status_t status; /**< Error status. */
int code; /**< SIP status code received. */
pj_str_t reason; /**< SIP reason phrase received. */
pjsip_rx_data *rdata; /**< The complete received response. */
int expiration;/**< Next expiration interval. */
int contact_cnt;/**<Number of contacts in response. */
pjsip_contact_hdr *contact[PJSIP_REGC_MAX_CONTACT]; /**< Contacts. */
};
/** Type declaration for callback to receive registration result. */
typedef void pjsip_regc_cb(struct pjsip_regc_cbparam *param);
/**
* Client registration information.
*/
struct pjsip_regc_info
{
pj_str_t server_uri; /**< Server URI, */
pj_str_t client_uri; /**< Client URI (From header). */
pj_bool_t is_busy; /**< Have pending transaction? */
pj_bool_t auto_reg; /**< Will register automatically? */
int interval; /**< Registration interval (seconds). */
int next_reg; /**< Time until next registration (seconds). */
};
/**
* @see pjsip_regc_info
*/
typedef struct pjsip_regc_info pjsip_regc_info;
/**
* Get the module instance for client registration module.
*
* @return client registration module.
*/
PJ_DECL(pjsip_module*) pjsip_regc_get_module(void);
/**
* Create client registration structure.
*
* @param endpt Endpoint, used to allocate pool from.
* @param token A data to be associated with the client registration struct.
* @param cb Pointer to callback function to receive registration status.
* @param p_regc Pointer to receive client registration structure.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_regc_create( pjsip_endpoint *endpt, void *token,
pjsip_regc_cb *cb,
pjsip_regc **p_regc);
/**
* Destroy client registration structure. If a registration transaction is
* in progress, then the structure will be deleted only after a final response
* has been received, and in this case, the callback won't be called.
*
* @param regc The client registration structure.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_regc_destroy(pjsip_regc *regc);
/**
* Get registration info.
*
* @param regc The client registration structure.
* @param info Client registration info.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_regc_get_info( pjsip_regc *regc,
pjsip_regc_info *info );
/**
* Get the memory pool associated with a registration client handle.
*
* @param regc The client registration structure.
* @return pool handle.
*/
PJ_DECL(pj_pool_t*) pjsip_regc_get_pool(pjsip_regc *regc);
/**
* Initialize client registration structure with various information needed to
* perform the registration.
*
* @param regc The client registration structure.
* @param srv_url Server URL.
* @param from_url The person performing the registration, must be a SIP URL type.
* @param to_url The address of record for which the registration is targetd, must
* be a SIP/SIPS URL.
* @param ccnt Number of contacts in the array.
* @param contact Array of contacts.
* @param expires Default expiration interval (in seconds) to be applied for
* contact URL that doesn't have expiration settings. If the
* value PJSIP_REGC_EXPIRATION_NOT_SPECIFIED is given, then
* no default expiration will be applied.
* @return zero on success.
*/
PJ_DECL(pj_status_t) pjsip_regc_init(pjsip_regc *regc,
const pj_str_t *srv_url,
const pj_str_t *from_url,
const pj_str_t *to_url,
int ccnt,
const pj_str_t contact[],
pj_uint32_t expires);
/**
* Set authentication credentials to use by this registration.
*
* @param regc The registration structure.
* @param count Number of credentials in the array.
* @param cred Array of credentials.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_regc_set_credentials( pjsip_regc *regc,
int count,
const pjsip_cred_info cred[] );
/**
* Set route set to be used for outgoing requests.
*
* @param regc The client registration structure.
* @param route_set List containing Route headers.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_regc_set_route_set(pjsip_regc *regc,
const pjsip_route_hdr*route_set);
/**
* Lock/bind client registration to a specific transport/listener.
* This is optional, as normally transport will be selected automatically
* based on the destination of requests upon resolver completion.
* When the client registration is explicitly bound to the specific
* transport/listener, all UAC transactions originated by the client
* registration will use the specified transport/listener when sending
* outgoing requests.
*
* Note that this doesn't affect the Contact header set for this client
* registration. Application must manually update the Contact header if
* necessary, to adjust the address according to the transport being
* selected.
*
* @param regc The client registration instance.
* @param sel Transport selector containing the specification of
* transport or listener to be used by this session
* to send requests.
*
* @return PJ_SUCCESS on success, or the appropriate error code.
*/
PJ_DECL(pj_status_t) pjsip_regc_set_transport(pjsip_regc *regc,
const pjsip_tpselector *sel);
/**
* Add headers to be added to outgoing REGISTER requests.
*
* @param regc The client registration structure.
* @param hdr_list List containing SIP headers to be added for all outgoing
* REGISTER requests.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_regc_add_headers(pjsip_regc *regc,
const pjsip_hdr *hdr_list);
/**
* Create REGISTER request for the specified client registration structure.
*
* After successfull registration, application can inspect the contacts in
* the client registration structure to list what contacts are associaciated
* with the address of record being targeted in the registration.
*
* @param regc The client registration structure.
* @param autoreg If non zero, the library will automatically refresh the
* next registration until application unregister.
* @param p_tdata Pointer to receive the REGISTER request.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_regc_register(pjsip_regc *regc, pj_bool_t autoreg,
pjsip_tx_data **p_tdata);
/**
* Create REGISTER request to unregister the contacts that were previously
* registered by this client registration.
*
* @param regc The client registration structure.
* @param p_tdata Pointer to receive the REGISTER request.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_regc_unregister(pjsip_regc *regc,
pjsip_tx_data **p_tdata);
/**
* Create REGISTER request to unregister all contacts from server records.
* Note that this will unregister all registered contact for the AOR
* including contacts registered by other user agents. To only unregister
* contact registered by this client registration instance, use
* #pjsip_regc_unregister() instead.
*
* @param regc The client registration structure.
* @param p_tdata Pointer to receive the REGISTER request.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_regc_unregister_all(pjsip_regc *regc,
pjsip_tx_data **p_tdata);
/**
* Update Contact details in the client registration structure.
*
* @param regc The client registration structure.
* @param ccnt Number of contacts.
* @param contact Array of contacts.
* @return zero if sucessfull.
*/
PJ_DECL(pj_status_t) pjsip_regc_update_contact( pjsip_regc *regc,
int ccnt,
const pj_str_t contact[] );
/**
* Update the expires value.
*
* @param regc The client registration structure.
* @param expires The new expires value.
* @return zero on successfull.
*/
PJ_DECL(pj_status_t) pjsip_regc_update_expires( pjsip_regc *regc,
pj_uint32_t expires );
/**
* Sends outgoing REGISTER request.
* The process will complete asynchronously, and application
* will be notified via the callback when the process completes.
*
* @param regc The client registration structure.
* @param tdata Transmit data.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjsip_regc_send(pjsip_regc *regc, pjsip_tx_data *tdata);
PJ_END_DECL
/**
* @}
*/
#endif /* __PJSIP_REG_H__ */
|
