File: TelEngine__JIDFeatureList.html

package info (click to toggle)
yate 2.2.0-1~dfsg-1.1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 17,496 kB
  • ctags: 21,687
  • sloc: cpp: 126,248; ansic: 11,462; sh: 3,573; php: 3,229; python: 2,014; makefile: 1,504; perl: 465; awk: 8
file content (118 lines) | stat: -rw-r--r-- 5,881 bytes parent folder | download
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
<HTML>
<HEAD>
<TITLE>class JIDFeatureList</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 JIDFeatureList</h1>
		</TD>
		<TD valign="top" align="right" colspan="1">JID feature list. <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>::JIDFeatureList</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include &lt;<A HREF="libs___yjingle___xmpputils_h.html">libs/yjingle/xmpputils.h</A>&gt;</code></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__JIDFeatureList.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>inline bool &nbsp;<b><A HREF="#ref1">add</A></b> (XMPPNamespace::Type feature, bool required = false) 
</LI>
<LI>inline bool &nbsp;<b><A HREF="#ref2">add</A></b> (JIDFeature* feature) 
</LI>
<LI>inline void &nbsp;<b><A HREF="#ref3">remove</A></b> (XMPPNamespace::Type feature) 
</LI>
<LI>JIDFeature* &nbsp;<b><A HREF="#ref4">get</A></b> (XMPPNamespace::Type feature) 
</LI>
<LI>XMLElement* &nbsp;<b><A HREF="#ref5">addTo</A></b> (XMLElement* element) 
</LI>
<LI>void &nbsp;<b><A HREF="#ref6">fromXml</A></b> (XMLElement* element, bool reset = true) 
</LI>
<LI>inline void &nbsp;<b><A HREF="#ref7">clear</A></b> () 
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
 This class holds a list of JID features
</p>
<A NAME="add"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool &nbsp;<strong>add</strong> (XMPPNamespace::Type feature, bool required = false)
<br></td><td align="right"><h3><strong>add</strong></h3></td></tr></table><p></p><p>
 Add a feature to the list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>feature</i></TD><TD align="left" valign="top">The feature to add
</TD></TR>
<TR><TD align="left" valign="top"><i>required</i></TD><TD align="left" valign="top">True if this feature is required
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: False if the given feature already exists
     </p>
<A NAME="add"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool &nbsp;<strong>add</strong> (JIDFeature* feature)
<br></td><td align="right"><h3><strong>add</strong></h3></td></tr></table><p></p><p>
 Add a feature to the list. Destroy the received parameter if already in the list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>feature</i></TD><TD align="left" valign="top">The feature to add
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: False if the given feature already exists
     </p>
<A NAME="remove"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void &nbsp;<strong>remove</strong> (XMPPNamespace::Type feature)
<br></td><td align="right"><h3><strong>remove</strong></h3></td></tr></table><p></p><p>
 Remove a feature from the list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>feature</i></TD><TD align="left" valign="top">The feature to remove
     </TD></TR>
</TABLE></P>
<A NAME="get"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>JIDFeature* &nbsp;<strong>get</strong> (XMPPNamespace::Type feature)
<br></td><td align="right"><h3><strong>get</strong></h3></td></tr></table><p></p><p>
 Get a feature from the list
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>feature</i></TD><TD align="left" valign="top">The feature to get
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to the feature or 0 if it doesn't exists
     </p>
<A NAME="addTo"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>XMLElement* &nbsp;<strong>addTo</strong> (XMLElement* element)
<br></td><td align="right"><h3><strong>addTo</strong></h3></td></tr></table><p></p><p>
 Add 'feature' children to the given element
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>element</i></TD><TD align="left" valign="top">The target XMLElement
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The given element
     </p>
<A NAME="fromXml"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void &nbsp;<strong>fromXml</strong> (XMLElement* element, bool reset = true)
<br></td><td align="right"><h3><strong>fromXml</strong></h3></td></tr></table><p></p><p>
 Update the list from 'feature' children of the given element
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>element</i></TD><TD align="left" valign="top">The source XMLElement
</TD></TR>
<TR><TD align="left" valign="top"><i>reset</i></TD><TD align="left" valign="top">True to clear the list before updating
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The given element
     </p>
<A NAME="clear"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void &nbsp;<strong>clear</strong> ()
<br></td><td align="right"><h3><strong>clear</strong></h3></td></tr></table><p></p><p>
 Clear the feature list
     </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>