libucommon-doc 3.2.0-0ubuntu1 / usr / share / doc / libucommon-dev / a00154.html

This file is indexed.

/usr/share/doc/libucommon-dev/a00154.html is in libucommon-doc 3.2.0-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>UCommon: ucc::SSocket Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00154.html">SSocket</a>
  </div>
</div>
<div class="contents">
<h1>ucc::SSocket Class Reference</h1><!-- doxytag: class="ucc::SSocket" --><!-- doxytag: inherits="ucc::TCPSocket" -->
<p>Secure socket class.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00203_source.html">secure.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucc::SSocket:</div>
<div class="dynsection">
<div class="center"><img src="a00551.png" border="0" usemap="#ucc_1_1_s_socket_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_s_socket_inherit__map" id="ucc_1_1_s_socket_inherit__map">
<area shape="rect" id="node2" href="a00162.html" title="A generic tcp socket class that offers i/o buffering." alt="" coords="59,83,176,112"/><area shape="rect" id="node4" href="a00057.html" title="Common buffered I/O class." alt="" coords="5,5,107,35"/><area shape="rect" id="node6" href="a00151.html" title="A generic socket base class." alt="" coords="131,5,227,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::SSocket:</div>
<div class="dynsection">
<div class="center"><img src="a00552.png" border="0" usemap="#ucc_1_1_s_socket_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_s_socket_coll__map" id="ucc_1_1_s_socket_coll__map">
<area shape="rect" id="node2" href="a00162.html" title="A generic tcp socket class that offers i/o buffering." alt="" coords="59,83,176,112"/><area shape="rect" id="node4" href="a00057.html" title="Common buffered I/O class." alt="" coords="5,5,107,35"/><area shape="rect" id="node6" href="a00151.html" title="A generic socket base class." alt="" coords="131,5,227,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00154.html#ad9a5b8e666290f81728ca0efbf13a019">_pull</a> (char *<a class="el" href="a00152.html">address</a>, size_t size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method to pull buffer from physical i/o (read).  <a href="#ad9a5b8e666290f81728ca0efbf13a019"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00154.html#ae4b4ff82b33cd469c94c04de190918a6">_push</a> (const char *<a class="el" href="a00152.html">address</a>, size_t size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method to push buffer into physical i/o (write).  <a href="#ae4b4ff82b33cd469c94c04de190918a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa15c9176fac7b675e44871ac2432ddac"></a><!-- doxytag: member="ucc::SSocket::close" ref="aa15c9176fac7b675e44871ac2432ddac" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00154.html#aa15c9176fac7b675e44871ac2432ddac">close</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close active connection. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00154.html#af2b103fbb4266781c6451f7b5ff8915d">flush</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flush buffered memory to physical I/O.  <a href="#af2b103fbb4266781c6451f7b5ff8915d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa286486d7bcb2f5f2d203e06d808d914"></a><!-- doxytag: member="ucc::SSocket::issecure" ref="aa286486d7bcb2f5f2d203e06d808d914" args="(void)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>issecure</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00154.html#a34479172604ba2f8f998e6aa9c9d7414">open</a> (<a class="el" href="a00161.html">TCPServer</a> *server, size_t size=536)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Connect a tcp socket to a client from a listener.  <a href="#a34479172604ba2f8f998e6aa9c9d7414"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00154.html#aa1065ec7c655f0b263797d02e83a81c8">open</a> (const char *host, size_t size=536)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Connect a ssl client session to a specific host uri.  <a href="#aa1065ec7c655f0b263797d02e83a81c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00154.html#ab891511f1e2b841c7c60fcd995736d26">pending</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check for pending tcp or ssl data.  <a href="#ab891511f1e2b841c7c60fcd995736d26"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4f2f8e2235752c479a21fca883f863d"></a><!-- doxytag: member="ucc::SSocket::release" ref="ae4f2f8e2235752c479a21fca883f863d" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00154.html#ae4f2f8e2235752c479a21fca883f863d">release</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release (free) buffer memory. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0a68ec93fd8630ed74c9452c76ec59f"></a><!-- doxytag: member="ucc::SSocket::SSocket" ref="ab0a68ec93fd8630ed74c9452c76ec59f" args="(TCPServer *server, secure::context_t context, size_t size=536)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>SSocket</b> (<a class="el" href="a00161.html">TCPServer</a> *server, <a class="el" href="a00131.html">secure::context_t</a> context, size_t size=536)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2bf3f52d018680b7cca7507f044c3be7"></a><!-- doxytag: member="ucc::SSocket::SSocket" ref="a2bf3f52d018680b7cca7507f044c3be7" args="(const char *service, secure::context_t context)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>SSocket</b> (const char *service, <a class="el" href="a00131.html">secure::context_t</a> context)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad046ed7071271c279c133f99a1605625"></a><!-- doxytag: member="ucc::SSocket::bio" ref="ad046ed7071271c279c133f99a1605625" args="" -->
<a class="el" href="a00131.html#a29b65f0d4fc0e34f1da452729f3da47c">secure::bufio_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>bio</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace9f42dabe11e8e640a93107f0cc28bb"></a><!-- doxytag: member="ucc::SSocket::ssl" ref="ace9f42dabe11e8e640a93107f0cc28bb" args="" -->
<a class="el" href="a00131.html#ab6a9c66d872da1aa8abb5b954c18b67e">secure::session_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ssl</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9d81a0b923ee03f4178864eed15a4ff"></a><!-- doxytag: member="ucc::SSocket::verify" ref="ab9d81a0b923ee03f4178864eed15a4ff" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>verify</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Secure socket class. </p>
<p>This is used to create ssl socket connections for both clients and servers. The use depends in part on the type of context created and passed at construction time. If no context is passed (NULL), then this reverts to <a class="el" href="a00162.html" title="A generic tcp socket class that offers i/o buffering.">TCPSocket</a> behavior. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00203_source.html#l00176">176</a> of file <a class="el" href="a00203_source.html">secure.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad9a5b8e666290f81728ca0efbf13a019"></a><!-- doxytag: member="ucc::SSocket::_pull" ref="ad9a5b8e666290f81728ca0efbf13a019" args="(char *address, size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ucc::SSocket::_pull </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>address</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Method to pull buffer from physical i/o (read). </p>
<p>The address is passed to this virtual since it is hidden as private. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>of buffer to pull data into. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of buffer area being pulled.. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of read written, 0 on error or end of data. </dd></dl>

<p>Reimplemented from <a class="el" href="a00162.html#a1ce3ecc90dae3c278143ecf3f54e9b9a">ucc::TCPSocket</a>.</p>

</div>
</div>
<a class="anchor" id="ae4b4ff82b33cd469c94c04de190918a6"></a><!-- doxytag: member="ucc::SSocket::_push" ref="ae4b4ff82b33cd469c94c04de190918a6" args="(const char *address, size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ucc::SSocket::_push </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>address</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Method to push buffer into physical i/o (write). </p>
<p>The address is passed to this virtual since it is hidden as private. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>of data to push. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of data to push. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes written, 0 on error. </dd></dl>

<p>Reimplemented from <a class="el" href="a00162.html#aa4d11855ebc0e3539812b6d3eb16eb81">ucc::TCPSocket</a>.</p>

</div>
</div>
<a class="anchor" id="af2b103fbb4266781c6451f7b5ff8915d"></a><!-- doxytag: member="ucc::SSocket::flush" ref="af2b103fbb4266781c6451f7b5ff8915d" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ucc::SSocket::flush </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Flush buffered memory to physical I/O. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, false if not active or fails. </dd></dl>

<p>Reimplemented from <a class="el" href="a00057.html#a6c0d513e2c85ee1aa52f7db1c5355685">ucc::IOBuffer</a>.</p>

</div>
</div>
<a class="anchor" id="a34479172604ba2f8f998e6aa9c9d7414"></a><!-- doxytag: member="ucc::SSocket::open" ref="a34479172604ba2f8f998e6aa9c9d7414" args="(TCPServer *server, size_t size=536)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::SSocket::open </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00161.html">TCPServer</a> *&nbsp;</td>
          <td class="paramname"> <em>server</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em> = <code>536</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Connect a tcp socket to a client from a listener. </p>
<p>If the socket was already connected, it is automatically closed first. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>server</em>&nbsp;</td><td>we are connected from. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of buffer and tcp fragments. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="a00162.html#ac5fc5b64728ac1668701d6d693f1129d">ucc::TCPSocket</a>.</p>

</div>
</div>
<a class="anchor" id="aa1065ec7c655f0b263797d02e83a81c8"></a><!-- doxytag: member="ucc::SSocket::open" ref="aa1065ec7c655f0b263797d02e83a81c8" args="(const char *host, size_t size=536)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::SSocket::open </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>host</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em> = <code>536</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Connect a ssl client session to a specific host uri. </p>
<p>If the socket was already connected, it is automatically closed first. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>host</em>&nbsp;</td><td>and optional :port we are connecting to. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of buffer and tcp fragments. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="a00162.html#a6f98d54a3d21cebd344e4f561412fbc5">ucc::TCPSocket</a>.</p>

</div>
</div>
<a class="anchor" id="ab891511f1e2b841c7c60fcd995736d26"></a><!-- doxytag: member="ucc::SSocket::pending" ref="ab891511f1e2b841c7c60fcd995736d26" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ucc::SSocket::pending </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Check for pending tcp or ssl data. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if data pending. </dd></dl>

<p>Reimplemented from <a class="el" href="a00162.html#a4e153320094ecc110a763209187da70f">ucc::TCPSocket</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00203_source.html">secure.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:49 2010 for UCommon by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.