summaryrefslogtreecommitdiff
path: root/docs/reference/tmpl/soup-socket.sgml
blob: 8a6389a93bcfd6c8979b15dbf5ae978daa7fb197 (plain)
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
<!-- ##### SECTION Title ##### -->
SoupSocket

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### MACRO SOUP_SOCKET_FLAG_NONBLOCKING ##### -->
<para>

</para>



<!-- ##### MACRO SOUP_SOCKET_FLAG_NODELAY ##### -->
<para>

</para>



<!-- ##### MACRO SOUP_SOCKET_FLAG_REUSEADDR ##### -->
<para>

</para>



<!-- ##### MACRO SOUP_SOCKET_IS_SERVER ##### -->
<para>

</para>



<!-- ##### MACRO SOUP_SOCKET_SSL_CREDENTIALS ##### -->
<para>

</para>



<!-- ##### FUNCTION soup_socket_new ##### -->
<para>

</para>

@optname1: 
@Varargs: 
@Returns: 


<!-- ##### FUNCTION soup_socket_connect ##### -->
<para>

</para>

@sock: 
@remote_addr: 
@Returns: 
<!-- # Unused Parameters # -->
@rem_addr: 


<!-- ##### FUNCTION soup_socket_listen ##### -->
<para>

</para>

@sock: 
@local_addr: 
@Returns: 


<!-- ##### FUNCTION soup_socket_start_ssl ##### -->
<para>

</para>

@sock: 
@Returns: 


<!-- ##### FUNCTION soup_socket_disconnect ##### -->
<para>

</para>

@sock: 


<!-- ##### FUNCTION soup_socket_is_connected ##### -->
<para>

</para>

@sock: 
@Returns: 


<!-- ##### USER_FUNCTION SoupSocketCallback ##### -->
<para>
The callback function passed to soup_socket_client_new_async().
</para>

@sock: the #SoupSocket
@status: an HTTP status code indicating success or failure
@user_data: 
<!-- # Unused Parameters # -->
@data: the data passed to soup_socket_client_new_async()


<!-- ##### USER_FUNCTION SoupSocketListenerCallback ##### -->
<para>
The callback function passed to soup_socket_server_new(), which
receives new connections.
</para>

@listener: the listening #SoupSocket
@sock: the newly-received #SoupSocket
@user_data: the data passed to soup_socket_server_new().


<!-- ##### FUNCTION soup_socket_client_new_async ##### -->
<para>

</para>

@hostname: 
@port: 
@ssl_creds: 
@callback: 
@user_data: 
@Returns: 


<!-- ##### FUNCTION soup_socket_client_new_sync ##### -->
<para>

</para>

@hostname: 
@port: 
@ssl_creds: 
@status_ret: 
@Returns: 
<!-- # Unused Parameters # -->
@status: 


<!-- ##### FUNCTION soup_socket_server_new ##### -->
<para>

</para>

@local_addr: 
@ssl_creds: 
@callback: 
@user_data: 
@Returns: 
<!-- # Unused Parameters # -->
@Param3: 


<!-- ##### FUNCTION soup_socket_get_local_address ##### -->
<para>

</para>

@sock: 
@Returns: 


<!-- ##### FUNCTION soup_socket_get_remote_address ##### -->
<para>

</para>

@sock: 
@Returns: 


<!-- ##### ENUM SoupSocketIOStatus ##### -->
<para>
Return value from the #SoupSocket IO methods.
</para>

@SOUP_SOCKET_OK: Success
@SOUP_SOCKET_WOULD_BLOCK: Cannot read/write any more at this time
@SOUP_SOCKET_EOF: End of file
@SOUP_SOCKET_ERROR: Other error

<!-- ##### FUNCTION soup_socket_read ##### -->
<para>

</para>

@sock: 
@buffer: 
@len: 
@nread: 
@Returns: 


<!-- ##### FUNCTION soup_socket_read_until ##### -->
<para>

</para>

@sock: 
@buffer: 
@len: 
@boundary: 
@boundary_len: 
@nread: 
@got_boundary: 
@Returns: 


<!-- ##### FUNCTION soup_socket_write ##### -->
<para>

</para>

@sock: 
@buffer: 
@len: 
@nwrote: 
@Returns: