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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelTcpStream</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Streams.html" title="Streams">
<link rel="prev" href="camel-CamelHttpStream.html" title="CamelHttpStream">
<link rel="next" href="camel-CamelTcpStreamRaw.html" title="CamelTcpStreamRaw">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="camel-CamelHttpStream.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="camel-CamelTcpStreamRaw.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-CamelTcpStream.synopsis" class="shortcut">Top</a>
|
<a href="#camel-CamelTcpStream.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="CamelTcpStream">
<a name="camel-CamelTcpStream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelTcpStream.top_of_page"></a>CamelTcpStream</span></h2>
<p>CamelTcpStream</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="camel-CamelTcpStream.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream">CamelTcpStream</a>;
enum <a class="link" href="camel-CamelTcpStream.html#CamelSockOpt" title="enum CamelSockOpt">CamelSockOpt</a>;
typedef <a class="link" href="camel-CamelTcpStream.html#CamelLinger" title="CamelLinger">CamelLinger</a>;
<a class="link" href="camel-CamelTcpStream.html#CamelSockOptData" title="CamelSockOptData">CamelSockOptData</a>;
<span class="returnvalue">gint</span> <a class="link" href="camel-CamelTcpStream.html#camel-tcp-stream-connect" title="camel_tcp_stream_connect ()">camel_tcp_stream_connect</a> (<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">struct addrinfo</span> *host</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="camel-CamelTcpStream.html#camel-tcp-stream-getsockopt" title="camel_tcp_stream_getsockopt ()">camel_tcp_stream_getsockopt</a> (<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> *stream</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelSockOptData" title="CamelSockOptData"><span class="type">CamelSockOptData</span></a> *data</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="camel-CamelTcpStream.html#camel-tcp-stream-setsockopt" title="camel_tcp_stream_setsockopt ()">camel_tcp_stream_setsockopt</a> (<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> *stream</code></em>,
<em class="parameter"><code>const <a class="link" href="camel-CamelTcpStream.html#CamelSockOptData" title="CamelSockOptData"><span class="type">CamelSockOptData</span></a> *data</code></em>);
struct <span class="returnvalue">sockaddr</span> * <a class="link" href="camel-CamelTcpStream.html#camel-tcp-stream-get-local-address" title="camel_tcp_stream_get_local_address ()">camel_tcp_stream_get_local_address</a> (<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> *len</code></em>);
struct <span class="returnvalue">sockaddr</span> * <a class="link" href="camel-CamelTcpStream.html#camel-tcp-stream-get-remote-address" title="camel_tcp_stream_get_remote_address ()">camel_tcp_stream_get_remote_address</a> (<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> *len</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="camel-CamelTcpStream.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="camel-CamelTcpStream.details"></a><h2>Details</h2>
<div class="refsect2" title="struct CamelTcpStream">
<a name="CamelTcpStream"></a><h3>struct CamelTcpStream</h3>
<pre class="programlisting">struct CamelTcpStream {
CamelStream parent_object;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="enum CamelSockOpt">
<a name="CamelSockOpt"></a><h3>enum CamelSockOpt</h3>
<pre class="programlisting">typedef enum {
CAMEL_SOCKOPT_NONBLOCKING, /* nonblocking io */
CAMEL_SOCKOPT_LINGER, /* linger on close if data present */
CAMEL_SOCKOPT_REUSEADDR, /* allow local address reuse */
CAMEL_SOCKOPT_KEEPALIVE, /* keep connections alive */
CAMEL_SOCKOPT_RECVBUFFERSIZE, /* receive buffer size */
CAMEL_SOCKOPT_SENDBUFFERSIZE, /* send buffer size */
CAMEL_SOCKOPT_IPTIMETOLIVE, /* time to live */
CAMEL_SOCKOPT_IPTYPEOFSERVICE, /* type of service and precedence */
CAMEL_SOCKOPT_ADDMEMBER, /* add an IP group membership */
CAMEL_SOCKOPT_DROPMEMBER, /* drop an IP group membership */
CAMEL_SOCKOPT_MCASTINTERFACE, /* multicast interface address */
CAMEL_SOCKOPT_MCASTTIMETOLIVE, /* multicast timetolive */
CAMEL_SOCKOPT_MCASTLOOPBACK, /* multicast loopback */
CAMEL_SOCKOPT_NODELAY, /* don't delay send to coalesce packets */
CAMEL_SOCKOPT_MAXSEGMENT, /* maximum segment size */
CAMEL_SOCKOPT_BROADCAST, /* enable broadcast */
CAMEL_SOCKOPT_LAST
} CamelSockOpt;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CamelLinger">
<a name="CamelLinger"></a><h3>CamelLinger</h3>
<pre class="programlisting">typedef struct linger CamelLinger;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CamelSockOptData">
<a name="CamelSockOptData"></a><h3>CamelSockOptData</h3>
<pre class="programlisting">typedef struct {
CamelSockOpt option;
union {
guint ip_ttl; /* IP time to live */
guint mcast_ttl; /* IP multicast time to live */
guint tos; /* IP type of service and precedence */
gboolean non_blocking; /* Non-blocking (network) I/O */
gboolean reuse_addr; /* Allow local address reuse */
gboolean keep_alive; /* Keep connections alive */
gboolean mcast_loopback; /* IP multicast loopback */
gboolean no_delay; /* Don't delay send to coalesce packets */
gboolean broadcast; /* Enable broadcast */
gsize max_segment; /* Maximum segment size */
gsize recv_buffer_size; /* Receive buffer size */
gsize send_buffer_size; /* Send buffer size */
CamelLinger linger; /* Time to linger on close if data present */
} value;
} CamelSockOptData;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="camel_tcp_stream_connect ()">
<a name="camel-tcp-stream-connect"></a><h3>camel_tcp_stream_connect ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_tcp_stream_connect (<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">struct addrinfo</span> *host</code></em>);</pre>
<p>
Create a socket and connect based upon the data provided.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>host</code></em> :</span></p></td>
<td>a linked list of addrinfo structures to try to connect, in
the order of most likely to least likely to work.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">0</code> on success or <code class="literal">-1</code> on fail
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_tcp_stream_getsockopt ()">
<a name="camel-tcp-stream-getsockopt"></a><h3>camel_tcp_stream_getsockopt ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_tcp_stream_getsockopt (<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> *stream</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelSockOptData" title="CamelSockOptData"><span class="type">CamelSockOptData</span></a> *data</code></em>);</pre>
<p>
Get the socket options set on the stream and populate <em class="parameter"><code>data</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>socket option data
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">0</code> on success or <code class="literal">-1</code> on fail
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_tcp_stream_setsockopt ()">
<a name="camel-tcp-stream-setsockopt"></a><h3>camel_tcp_stream_setsockopt ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_tcp_stream_setsockopt (<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> *stream</code></em>,
<em class="parameter"><code>const <a class="link" href="camel-CamelTcpStream.html#CamelSockOptData" title="CamelSockOptData"><span class="type">CamelSockOptData</span></a> *data</code></em>);</pre>
<p>
Set the socket options contained in <em class="parameter"><code>data</code></em> on the stream.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>socket option data
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">0</code> on success or <code class="literal">-1</code> on fail
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_tcp_stream_get_local_address ()">
<a name="camel-tcp-stream-get-local-address"></a><h3>camel_tcp_stream_get_local_address ()</h3>
<pre class="programlisting">struct <span class="returnvalue">sockaddr</span> * camel_tcp_stream_get_local_address (<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> *len</code></em>);</pre>
<p>
Get the local address of <em class="parameter"><code>stream</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>pointer to address length which must be supplied
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the stream's local address (which must be freed with
<span class="type">g_free</span>) if the stream is connected, or <code class="literal">NULL</code> if not
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2" title="camel_tcp_stream_get_remote_address ()">
<a name="camel-tcp-stream-get-remote-address"></a><h3>camel_tcp_stream_get_remote_address ()</h3>
<pre class="programlisting">struct <span class="returnvalue">sockaddr</span> * camel_tcp_stream_get_remote_address (<em class="parameter"><code><a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> *len</code></em>);</pre>
<p>
Get the remote address of <em class="parameter"><code>stream</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelTcpStream.html#CamelTcpStream" title="struct CamelTcpStream"><span class="type">CamelTcpStream</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>pointer to address length, which must be supplied
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the stream's remote address (which must be freed with
<span class="type">g_free</span>) if the stream is connected, or <code class="literal">NULL</code> if not.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
