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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
|
<HTML>
<HEAD>
<TITLE>class SIPEngine</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class SIPEngine</h1>
</TD>
<TD valign="top" align="right" colspan="1">The SIP engine and transaction list. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH colspan="2">Contains pure virtuals</TH></TR><TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::SIPEngine</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___ysip___yatesip_h.html">libs/ysip/yatesip.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__DebugEnabler.html">TelEngine::DebugEnabler</A> <small>[public ]</small>, <A HREF="TelEngine__Mutex.html">TelEngine::Mutex</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__SIPEngine.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI> <b><A HREF="#ref1">SIPEngine</A></b> (const char* userAgent = 0)
</LI>
<LI>virtual <b><A HREF="#ref2">~SIPEngine</A></b> ()
</LI>
<LI>virtual bool <b><i><A HREF="#ref3">buildParty</A></i></b> (SIPMessage* message)
</LI>
<LI>virtual bool <b><A HREF="#ref4">checkUser</A></b> (const String& username, const String& realm, const String& nonce,
const String& method, const String& uri, const String& response,
const SIPMessage* message, GenObject* userData)
</LI>
<LI>virtual bool <b><A HREF="#ref5">checkAuth</A></b> (bool noUser, const SIPMessage* message, GenObject* userData)
</LI>
<LI>int <b><A HREF="#ref6">authUser</A></b> (const SIPMessage* message, String& user, bool proxy = false, GenObject* userData = 0)
</LI>
<LI>SIPTransaction* <b><A HREF="#ref7">addMessage</A></b> (SIPParty* ep, const char* buf, int len = -1)
</LI>
<LI>SIPTransaction* <b><A HREF="#ref8">addMessage</A></b> (SIPMessage* message)
</LI>
<LI>SIPEvent * <b><A HREF="#ref9">getEvent</A></b> ()
</LI>
<LI>bool <b><A HREF="#ref10">process</A></b> ()
</LI>
<LI>virtual void <b><A HREF="#ref11">processEvent</A></b> (SIPEvent *event)
</LI>
<LI>virtual SIPTransaction* <b><A HREF="#ref12">forkInvite</A></b> (SIPMessage* answer, SIPTransaction* trans)
</LI>
<LI>virtual <A HREF="#u_int64_t">u_int64_t</A> <b><A HREF="#ref13">getUserTimeout</A></b> () const
</LI>
<LI><A HREF="#u_int64_t">u_int64_t</A> <b><A HREF="#ref14">getTimer</A></b> (char which, bool reliable = false) const
</LI>
<LI>inline unsigned int <b><A HREF="#ref15">getMaxForwards</A></b> () const
</LI>
<LI>inline const String& <b><A HREF="#ref16">getUserAgent</A></b> () const
</LI>
<LI>inline int <b><A HREF="#ref17">getNextCSeq</A></b> ()
</LI>
<LI>inline bool <b><A HREF="#ref18">lazyTrying</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref19">lazyTrying</A></b> (bool lazy100)
</LI>
<LI>void <b><A HREF="#ref20">nonceGet</A></b> (String& nonce)
</LI>
<LI>long <b><A HREF="#ref21">nonceAge</A></b> (const String& nonce)
</LI>
<LI>bool <b><A HREF="#ref24">isAllowed</A></b> (const char* method) const
</LI>
<LI>void <b><A HREF="#ref25">addAllowed</A></b> (const char* method)
</LI>
<LI>inline const String& <b><A HREF="#ref26">getAllowed</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref27">remove</A></b> (SIPTransaction* transaction)
</LI>
<LI>inline void <b><A HREF="#ref28">append</A></b> (SIPTransaction* transaction)
</LI>
<LI>inline void <b><A HREF="#ref29">insert</A></b> (SIPTransaction* transaction)
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static void <b><A HREF="#ref22">buildAuth</A></b> (const String& username, const String& realm, const String& passwd,
const String& nonce, const String& method, const String& uri, String& response)
</LI>
<LI>static void <b><A HREF="#ref23">buildAuth</A></b> (const String& hash_a1, const String& nonce, const String& hash_a2,
String& response)
</LI>
</ul><h4>Protected Members</h4><ul><LI>ObjList <b><A HREF="#ref30">m_transList</A></b></LI>
<LI>u_int64_t <b><A HREF="#ref31">m_t1</A></b></LI>
<LI>u_int64_t <b><A HREF="#ref32">m_t4</A></b></LI>
<LI>unsigned int <b><A HREF="#ref33">m_maxForwards</A></b></LI>
<LI>int <b><A HREF="#ref34">m_cseq</A></b></LI>
<LI>bool <b><A HREF="#ref35">m_lazyTrying</A></b></LI>
<LI>String <b><A HREF="#ref36">m_userAgent</A></b></LI>
<LI>String <b><A HREF="#ref37">m_allowed</A></b></LI>
<LI>String <b><A HREF="#ref38">m_nonce</A></b></LI>
<LI>String <b><A HREF="#ref39">m_nonce_secret</A></b></LI>
<LI>u_int32_t <b><A HREF="#ref40">m_nonce_time</A></b></LI>
<LI>Mutex <b><A HREF="#ref41">m_nonce_mutex</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
The SIP engine holds common methods and the list of current transactions
</p>
<A NAME="SIPEngine"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SIPEngine</strong> (const char* userAgent = 0)
<br></td><td align="right"><h3><strong>SIPEngine</strong></h3></td></tr></table><p></p><p>
Create the SIP Engine
</p>
<A NAME="~SIPEngine"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~SIPEngine</strong> ()
<br></td><td align="right"><h3><strong>~SIPEngine</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destroy the SIP Engine
</p>
<A NAME="buildParty"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <i><strong>buildParty</strong></i> (SIPMessage* message)
<br></td><td align="right"><h3><i><strong>buildParty</strong></i></h3></td></tr></table><p> <small>[pure virtual]</small></p><p>
Build a new SIPParty for a message
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>message</i></TD><TD align="left" valign="top">Pointer to the message to build the party
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success, false if party could not be built
</p>
<A NAME="checkUser"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>checkUser</strong> (const String& username, const String& realm, const String& nonce,
const String& method, const String& uri, const String& response,
const SIPMessage* message, GenObject* userData)
<br></td><td align="right"><h3><strong>checkUser</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Check user credentials for validity
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>username</i></TD><TD align="left" valign="top">User account name
</TD></TR>
<TR><TD align="left" valign="top"><i>realm</i></TD><TD align="left" valign="top">Authentication realm
</TD></TR>
<TR><TD align="left" valign="top"><i>nonce</i></TD><TD align="left" valign="top">Authentication opaque nonce generated by the server
</TD></TR>
<TR><TD align="left" valign="top"><i>method</i></TD><TD align="left" valign="top">Method of the SIP message that is being authenticated
</TD></TR>
<TR><TD align="left" valign="top"><i>uri</i></TD><TD align="left" valign="top">URI of the SIP message that is being authenticated
</TD></TR>
<TR><TD align="left" valign="top"><i>response</i></TD><TD align="left" valign="top">Response computed by the authenticated entity
</TD></TR>
<TR><TD align="left" valign="top"><i>message</i></TD><TD align="left" valign="top">Message that is to be authenticated
</TD></TR>
<TR><TD align="left" valign="top"><i>userData</i></TD><TD align="left" valign="top">Pointer to an optional object passed from <A HREF="TelEngine__SIPEngine.html#authUser">authUser</A>
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if valid user/password, false if verification failed
</p>
<A NAME="checkAuth"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td> bool <strong>checkAuth</strong> (bool noUser, const SIPMessage* message, GenObject* userData)
<br></td><td align="right"><h3><strong>checkAuth</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Authenticate a message by other means than user credentials. By default
it calls <A HREF="TelEngine__SIPEngine.html#checkUser">checkUser</A> with empty user credential fields
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>noUser</i></TD><TD align="left" valign="top">No plausible user credentials were detected so far
</TD></TR>
<TR><TD align="left" valign="top"><i>message</i></TD><TD align="left" valign="top">Message that is to be authenticated
</TD></TR>
<TR><TD align="left" valign="top"><i>userData</i></TD><TD align="left" valign="top">Pointer to an optional object passed from <A HREF="TelEngine__SIPEngine.html#authUser">authUser</A>
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if message is authenticated, false if verification failed
</p>
<A NAME="authUser"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>authUser</strong> (const SIPMessage* message, String& user, bool proxy = false, GenObject* userData = 0)
<br></td><td align="right"><h3><strong>authUser</strong></h3></td></tr></table><p></p><p>
Detect the proper credentials for any user in the engine
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>message</i></TD><TD align="left" valign="top">Pointer to the message to check
</TD></TR>
<TR><TD align="left" valign="top"><i>user</i></TD><TD align="left" valign="top">String to store the authenticated user name or user to
look for (if not null on entry)
</TD></TR>
<TR><TD align="left" valign="top"><i>proxy</i></TD><TD align="left" valign="top">True to authenticate as proxy, false as user agent
</TD></TR>
<TR><TD align="left" valign="top"><i>userData</i></TD><TD align="left" valign="top">Pointer to an optional object that is passed back to <A HREF="TelEngine__SIPEngine.html#checkUser">checkUser</A>
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Age of the nonce if user matches, negative for a failure
</p>
<A NAME="addMessage"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>SIPTransaction* <strong>addMessage</strong> (SIPParty* ep, const char* buf, int len = -1)
<br></td><td align="right"><h3><strong>addMessage</strong></h3></td></tr></table><p></p><p>
Add a message into the transaction list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>ep</i></TD><TD align="left" valign="top">Party of the received message
</TD></TR>
<TR><TD align="left" valign="top"><i>buf</i></TD><TD align="left" valign="top">A buffer containing the SIP message text
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">The length of the message or -1 to interpret as C string
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to the transaction or NULL if message was invalid
</p>
<A NAME="addMessage"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>SIPTransaction* <strong>addMessage</strong> (SIPMessage* message)
<br></td><td align="right"><h3><strong>addMessage</strong></h3></td></tr></table><p></p><p>
Add a message into the transaction list
This method is thread safe
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>message</i></TD><TD align="left" valign="top">A parsed SIP message to add to the transactions
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to the transaction or NULL if message was invalid
</p>
<A NAME="getEvent"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>SIPEvent * <strong>getEvent</strong> ()
<br></td><td align="right"><h3><strong>getEvent</strong></h3></td></tr></table><p></p><p>
Get a SIPEvent from the queue.
This method mainly looks into the transaction list and get all kind of
events, like an incoming request (INVITE, REGISTRATION), a timer, an
outgoing message.
This method is thread safe
</p>
<A NAME="process"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>process</strong> ()
<br></td><td align="right"><h3><strong>process</strong></h3></td></tr></table><p></p><p>
This method should be called very often to get the events from the list and
to send them to processEvent method.
</p>
<p><b>Returns</b>: True if some events were processed this turn
</p>
<A NAME="processEvent"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>processEvent</strong> (SIPEvent *event)
<br></td><td align="right"><h3><strong>processEvent</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Default handling for events.
This method should be overriden for what you need and at the end you
should call this default one
This method is thread safe
</p>
<A NAME="forkInvite"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td> SIPTransaction* <strong>forkInvite</strong> (SIPMessage* answer, SIPTransaction* trans)
<br></td><td align="right"><h3><strong>forkInvite</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Handle answers that create new dialogs for an outgoing INVITE
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>answer</i></TD><TD align="left" valign="top">The message that creates the INVITE fork
</TD></TR>
<TR><TD align="left" valign="top"><i>trans</i></TD><TD align="left" valign="top">One of the transactions part of the same INVITE
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to new transaction or NULL if message is ignored
</p>
<A NAME="getUserTimeout"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="#u_int64_t">u_int64_t</A> <strong>getUserTimeout</strong> ()
<br></td><td align="right"><h3><strong>getUserTimeout</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Get the timeout to be used for transactions involving human interaction.
The default implementation returns the proxy INVITE timeout (timer C = 3 minutes)
minus the INVITE response retransmit interval (timer T2 = 4 seconds)
</p>
<p><b>Returns</b>: Duration of the timeout in microseconds
</p>
<A NAME="getTimer"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int64_t">u_int64_t</A> <strong>getTimer</strong> (char which, bool reliable = false)
<br></td><td align="right"><h3><strong>getTimer</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the length of a timer
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>which</i></TD><TD align="left" valign="top">A one-character constant that selects which timer to return
</TD></TR>
<TR><TD align="left" valign="top"><i>reliable</i></TD><TD align="left" valign="top">Whether we request the timer value for a reliable protocol
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Duration of the selected timer or 0 if invalid
</p>
<A NAME="getMaxForwards"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned int <strong>getMaxForwards</strong> ()
<br></td><td align="right"><h3><strong>getMaxForwards</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the default value of the Max-Forwards header for this engine
</p>
<p><b>Returns</b>: The maximum number of hops the request is allowed to pass
</p>
<A NAME="getUserAgent"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>getUserAgent</strong> ()
<br></td><td align="right"><h3><strong>getUserAgent</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the User agent for this SIP engine
</p>
<A NAME="getNextCSeq"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>getNextCSeq</strong> ()
<br></td><td align="right"><h3><strong>getNextCSeq</strong></h3></td></tr></table><p></p><p>
Get a CSeq value suitable for use in a new request
</p>
<A NAME="lazyTrying"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>lazyTrying</strong> ()
<br></td><td align="right"><h3><strong>lazyTrying</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if the engine is set up for lazy "100 Trying" messages
</p>
<p><b>Returns</b>: True if the first 100 message is to be skipped for non-INVITE
</p>
<A NAME="lazyTrying"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>lazyTrying</strong> (bool lazy100)
<br></td><td align="right"><h3><strong>lazyTrying</strong></h3></td></tr></table><p></p><p>
Set the lazy "100 Trying" messages flag
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>lazy100</i></TD><TD align="left" valign="top">True to not send the 1st 100 message for non-INVITE
</TD></TR>
</TABLE></P>
<A NAME="nonceGet"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>nonceGet</strong> (String& nonce)
<br></td><td align="right"><h3><strong>nonceGet</strong></h3></td></tr></table><p></p><p>
Get an authentication nonce
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>nonce</i></TD><TD align="left" valign="top">String reference to fill with the current nonce
</TD></TR>
</TABLE></P>
<A NAME="nonceAge"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>long <strong>nonceAge</strong> (const String& nonce)
<br></td><td align="right"><h3><strong>nonceAge</strong></h3></td></tr></table><p></p><p>
Get the age of an authentication nonce
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>nonce</i></TD><TD align="left" valign="top">String nonce to check for validity and age
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Age of the nonce in seconds, negative for invalid
</p>
<A NAME="buildAuth"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>buildAuth</strong> (const String& username, const String& realm, const String& passwd,
const String& nonce, const String& method, const String& uri, String& response)
<br></td><td align="right"><h3><strong>buildAuth</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Build an authentication response
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>username</i></TD><TD align="left" valign="top">User account name
</TD></TR>
<TR><TD align="left" valign="top"><i>realm</i></TD><TD align="left" valign="top">Authentication realm
</TD></TR>
<TR><TD align="left" valign="top"><i>passwd</i></TD><TD align="left" valign="top">Account password
</TD></TR>
<TR><TD align="left" valign="top"><i>nonce</i></TD><TD align="left" valign="top">Authentication opaque nonce generated by the server
</TD></TR>
<TR><TD align="left" valign="top"><i>method</i></TD><TD align="left" valign="top">Method of the SIP message that is being authenticated
</TD></TR>
<TR><TD align="left" valign="top"><i>uri</i></TD><TD align="left" valign="top">URI of the SIP message that is being authenticated
</TD></TR>
<TR><TD align="left" valign="top"><i>response</i></TD><TD align="left" valign="top">String to store the computed response
</TD></TR>
</TABLE></P>
<A NAME="buildAuth"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>buildAuth</strong> (const String& hash_a1, const String& nonce, const String& hash_a2,
String& response)
<br></td><td align="right"><h3><strong>buildAuth</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Build an authentication response from already hashed components
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>hash_a1</i></TD><TD align="left" valign="top">MD5 digest of username:realm:password
</TD></TR>
<TR><TD align="left" valign="top"><i>nonce</i></TD><TD align="left" valign="top">Authentication opaque nonce generated by the server
</TD></TR>
<TR><TD align="left" valign="top"><i>hash_a2</i></TD><TD align="left" valign="top">MD5 digest of method:uri
</TD></TR>
<TR><TD align="left" valign="top"><i>response</i></TD><TD align="left" valign="top">String to store the computed response
</TD></TR>
</TABLE></P>
<A NAME="isAllowed"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>isAllowed</strong> (const char* method)
<br></td><td align="right"><h3><strong>isAllowed</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if a method is in the allowed methods list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>method</i></TD><TD align="left" valign="top">Uppercase name of the method to check
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the method should be allowed processing
</p>
<A NAME="addAllowed"></A><A NAME="ref25"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>addAllowed</strong> (const char* method)
<br></td><td align="right"><h3><strong>addAllowed</strong></h3></td></tr></table><p></p><p>
Add a method to the allowed methods list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>method</i></TD><TD align="left" valign="top">Uppercase name of the method to add
</TD></TR>
</TABLE></P>
<A NAME="getAllowed"></A><A NAME="ref26"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>getAllowed</strong> ()
<br></td><td align="right"><h3><strong>getAllowed</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get all the allowed methods
</p>
<p><b>Returns</b>: Comma separated list of allowed methods
</p>
<A NAME="remove"></A><A NAME="ref27"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>remove</strong> (SIPTransaction* transaction)
<br></td><td align="right"><h3><strong>remove</strong></h3></td></tr></table><p></p><p>
Remove a transaction from the list without dereferencing it
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>transaction</i></TD><TD align="left" valign="top">Pointer to transaction to remove
</TD></TR>
</TABLE></P>
<A NAME="append"></A><A NAME="ref28"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>append</strong> (SIPTransaction* transaction)
<br></td><td align="right"><h3><strong>append</strong></h3></td></tr></table><p></p><p>
Append a transaction to the end of the list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>transaction</i></TD><TD align="left" valign="top">Pointer to transaction to append
</TD></TR>
</TABLE></P>
<A NAME="insert"></A><A NAME="ref29"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>insert</strong> (SIPTransaction* transaction)
<br></td><td align="right"><h3><strong>insert</strong></h3></td></tr></table><p></p><p>
Insert a transaction at the start of the list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>transaction</i></TD><TD align="left" valign="top">Pointer to transaction to insert
</TD></TR>
</TABLE></P>
<A NAME="m_transList"></A><A NAME="ref30"></A><table width="100%"><tr bgcolor="#eeeeee"><td>ObjList <strong>m_transList</strong>
</td><td align="right"><h3><strong>m_transList</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_t1"></A><A NAME="ref31"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int64_t">u_int64_t</A> <strong>m_t1</strong>
</td><td align="right"><h3><strong>m_t1</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_t4"></A><A NAME="ref32"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int64_t">u_int64_t</A> <strong>m_t4</strong>
</td><td align="right"><h3><strong>m_t4</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_maxForwards"></A><A NAME="ref33"></A><table width="100%"><tr bgcolor="#eeeeee"><td>unsigned int <strong>m_maxForwards</strong>
</td><td align="right"><h3><strong>m_maxForwards</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_cseq"></A><A NAME="ref34"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>m_cseq</strong>
</td><td align="right"><h3><strong>m_cseq</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_lazyTrying"></A><A NAME="ref35"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>m_lazyTrying</strong>
</td><td align="right"><h3><strong>m_lazyTrying</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_userAgent"></A><A NAME="ref36"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_userAgent</strong>
</td><td align="right"><h3><strong>m_userAgent</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_allowed"></A><A NAME="ref37"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_allowed</strong>
</td><td align="right"><h3><strong>m_allowed</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_nonce"></A><A NAME="ref38"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_nonce</strong>
</td><td align="right"><h3><strong>m_nonce</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_nonce_secret"></A><A NAME="ref39"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>m_nonce_secret</strong>
</td><td align="right"><h3><strong>m_nonce_secret</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_nonce_time"></A><A NAME="ref40"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#u_int32_t">u_int32_t</A> <strong>m_nonce_time</strong>
</td><td align="right"><h3><strong>m_nonce_time</strong></h3></td></tr></table><p> <small>[protected]</small></p><A NAME="m_nonce_mutex"></A><A NAME="ref41"></A><table width="100%"><tr bgcolor="#eeeeee"><td>Mutex <strong>m_nonce_mutex</strong>
</td><td align="right"><h3><strong>m_nonce_mutex</strong></h3></td></tr></table><p> <small>[protected]</small></p><HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
