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
|
<HTML>
<HEAD>
<TITLE>class SIPDialog</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 SIPDialog</h1>
</TD>
<TD valign="top" align="right" colspan="1">SIP Dialog object. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::SIPDialog</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__String.html">TelEngine::String</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__SIPDialog.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">SIPDialog</A></b> ()
</LI>
<LI> <b><A HREF="#ref2">SIPDialog</A></b> (const SIPDialog& original)
</LI>
<LI>explicit <b><A HREF="#ref3">SIPDialog</A></b> (const SIPMessage& message)
</LI>
<LI>inline explicit <b><A HREF="#ref4">SIPDialog</A></b> (const String& callid)
</LI>
<LI>SIPDialog& <b><A HREF="#ref5">operator=</A></b> (const SIPDialog& original)
</LI>
<LI>SIPDialog& <b><A HREF="#ref6">operator=</A></b> (const SIPMessage& message)
</LI>
<LI>SIPDialog& <b><A HREF="#ref7">operator=</A></b> (const String& callid)
</LI>
<LI>bool <b><A HREF="#ref8">matches</A></b> (const SIPDialog& other, bool ignoreURIs) const
</LI>
<LI>inline bool <b><A HREF="#ref9">operator==</A></b> (const SIPDialog& other) const
</LI>
<LI>inline bool <b><A HREF="#ref10">operator!=</A></b> (const SIPDialog& other) const
</LI>
<LI>inline bool <b><A HREF="#ref11">operator&=</A></b> (const SIPDialog& other) const
</LI>
<LI>inline bool <b><A HREF="#ref12">operator|=</A></b> (const SIPDialog& other) const
</LI>
<LI>inline const String& <b><A HREF="#ref13">fromURI</A></b> (bool outgoing) const
</LI>
<LI>inline const String& <b><A HREF="#ref14">fromTag</A></b> (bool outgoing) const
</LI>
<LI>inline const String& <b><A HREF="#ref15">toURI</A></b> (bool outgoing) const
</LI>
<LI>inline const String& <b><A HREF="#ref16">toTag</A></b> (bool outgoing) const
</LI>
</ul><h4>Public Members</h4><ul><LI>String <b><A HREF="#ref17">localURI</A></b></LI>
<LI>String <b><A HREF="#ref18">localTag</A></b></LI>
<LI>String <b><A HREF="#ref19">remoteURI</A></b></LI>
<LI>String <b><A HREF="#ref20">remoteTag</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
A class to store information required to identify a dialog
</p>
<A NAME="SIPDialog"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SIPDialog</strong> ()
<br></td><td align="right"><h3><strong>SIPDialog</strong></h3></td></tr></table><p></p><p>
Default constructor, build an empty SIP dialog
</p>
<A NAME="SIPDialog"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>SIPDialog</strong> (const SIPDialog& original)
<br></td><td align="right"><h3><strong>SIPDialog</strong></h3></td></tr></table><p></p><p>
Copy constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>original</i></TD><TD align="left" valign="top">Original SIP dialog to copy
</TD></TR>
</TABLE></P>
<A NAME="SIPDialog"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>explicit <strong>SIPDialog</strong> (const SIPMessage& message)
<br></td><td align="right"><h3><strong>SIPDialog</strong></h3></td></tr></table><p></p><p>
Constructor from a SIP 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">SIP message to copy the dialog information from
</TD></TR>
</TABLE></P>
<A NAME="SIPDialog"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline explicit <strong>SIPDialog</strong> (const String& callid)
<br></td><td align="right"><h3><strong>SIPDialog</strong></h3></td></tr></table><p></p><p>
Constructor from a Call ID, leaves URIs and tags empty
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>callid</i></TD><TD align="left" valign="top">Call ID to insert in the dialog
</TD></TR>
</TABLE></P>
<A NAME="operator="></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>SIPDialog& <strong>operator=</strong> (const SIPDialog& original)
<br></td><td align="right"><h3><strong>operator=</strong></h3></td></tr></table><p></p><p>
Assignment from another dialog
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>original</i></TD><TD align="left" valign="top">Original SIP dialog to copy
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Reference to this SIP dialog
</p>
<p>Reimplemented from <A HREF="TelEngine__String.html#operator=">String</A>.</p>
<A NAME="operator="></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>SIPDialog& <strong>operator=</strong> (const SIPMessage& message)
<br></td><td align="right"><h3><strong>operator=</strong></h3></td></tr></table><p></p><p>
Assignment from a SIP 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">SIP message to copy the dialog information from
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Reference to this SIP dialog
</p>
<p>Reimplemented from <A HREF="TelEngine__String.html#operator=">String</A>.</p>
<A NAME="operator="></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>SIPDialog& <strong>operator=</strong> (const String& callid)
<br></td><td align="right"><h3><strong>operator=</strong></h3></td></tr></table><p></p><p>
Assignment from a Call ID, URIs and tags are cleared
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>callid</i></TD><TD align="left" valign="top">Call ID to copy to the dialog
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Reference to this SIP dialog
</p>
<p>Reimplemented from <A HREF="TelEngine__String.html#operator=">String</A>.</p>
<A NAME="matches"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>matches</strong> (const SIPDialog& other, bool ignoreURIs)
<br></td><td align="right"><h3><strong>matches</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
SIP dialog matching check
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>other</i></TD><TD align="left" valign="top">Other dialog to compare to
</TD></TR>
<TR><TD align="left" valign="top"><i>ignoreURIs</i></TD><TD align="left" valign="top">True to ignore local and remote URIs when comparing
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the two dialogs match
</p>
<p>Reimplemented from <A HREF="TelEngine__String.html#matches">String</A>.</p>
<A NAME="operator=="></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>operator==</strong> (const SIPDialog& other)
<br></td><td align="right"><h3><strong>operator==</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Dialog equality comparation, suitable for RFC 2543
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>other</i></TD><TD align="left" valign="top">Other dialog to compare to
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the two dialogs are equal
</p>
<p>Reimplemented from <A HREF="TelEngine__String.html#operator==">String</A>.</p>
<A NAME="operator!="></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>operator!=</strong> (const SIPDialog& other)
<br></td><td align="right"><h3><strong>operator!=</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Dialog inequality comparation, suitable for RFC 2543
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>other</i></TD><TD align="left" valign="top">Other dialog to compare to
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the two dialogs are different
</p>
<p>Reimplemented from <A HREF="TelEngine__String.html#operator!=">String</A>.</p>
<A NAME="operator&="></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>operator&=</strong> (const SIPDialog& other)
<br></td><td align="right"><h3><strong>operator&=</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Dialog equality comparation, suitable for RFC 3261
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>other</i></TD><TD align="left" valign="top">Other dialog to compare to
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the two dialogs match (ignoring local and remote URIs)
</p>
<p>Reimplemented from <A HREF="TelEngine__String.html#operator&=">String</A>.</p>
<A NAME="operator|="></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>operator|=</strong> (const SIPDialog& other)
<br></td><td align="right"><h3><strong>operator|=</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Dialog inequality comparation, suitable for RFC 3261
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>other</i></TD><TD align="left" valign="top">Other dialog to compare to
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the two dialogs do not match (ignoring local and remote URIs)
</p>
<p>Reimplemented from <A HREF="TelEngine__String.html#operator|=">String</A>.</p>
<A NAME="fromURI"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>fromURI</strong> (bool outgoing)
<br></td><td align="right"><h3><strong>fromURI</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the From URI from the dialog
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>outgoing</i></TD><TD align="left" valign="top">True if getting the URI for an outgoing transaction
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Reference to the From URI in dialog
</p>
<A NAME="fromTag"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>fromTag</strong> (bool outgoing)
<br></td><td align="right"><h3><strong>fromTag</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the From tag from the dialog
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>outgoing</i></TD><TD align="left" valign="top">True if getting the tag for an outgoing transaction
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Reference to the From URI tag in dialog
</p>
<A NAME="toURI"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>toURI</strong> (bool outgoing)
<br></td><td align="right"><h3><strong>toURI</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the To URI from the dialog
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>outgoing</i></TD><TD align="left" valign="top">True if getting the URI for an outgoing transaction
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Reference to the To URI in dialog
</p>
<A NAME="toTag"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const String& <strong>toTag</strong> (bool outgoing)
<br></td><td align="right"><h3><strong>toTag</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the To tag from the dialog
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>outgoing</i></TD><TD align="left" valign="top">True if getting the tag for an outgoing transaction
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Reference to the To URI tag in dialog
</p>
<A NAME="localURI"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>localURI</strong>
</td><td align="right"><h3><strong>localURI</strong></h3></td></tr></table><p></p><A NAME="localTag"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>localTag</strong>
</td><td align="right"><h3><strong>localTag</strong></h3></td></tr></table><p></p><A NAME="remoteURI"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>remoteURI</strong>
</td><td align="right"><h3><strong>remoteURI</strong></h3></td></tr></table><p></p><A NAME="remoteTag"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td>String <strong>remoteTag</strong>
</td><td align="right"><h3><strong>remoteTag</strong></h3></td></tr></table><p></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>
|
