summaryrefslogtreecommitdiff
path: root/docs/reference/tmpl/soup-server.sgml
blob: 61df5e94fd3985e5ebd13cb059440eadb1324916 (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
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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
<!-- ##### SECTION Title ##### -->
SoupServer

<!-- ##### SECTION Short_Description ##### -->
HTTP server

<!-- ##### SECTION Long_Description ##### -->
<para>
#SoupServer implements a simple HTTP server.
</para>

<para>
To begin, create a server using soup_server_new(). Add at least one
handler by calling soup_server_add_handler(); the handler will be
called to process any requests underneath the path passed to
soup_server_add_handler(). (If you want all requests to go to the same
handler, just pass "/" (or %NULL) for the path.) Any request that does
not match any handler will automatically be returned to the client
with a 404 (Not Found) status.
</para>

<para>
To add authentication to some or all paths, create an appropriate
#SoupAuthDomain (qv), and add it to the server via
soup_server_add_auth_domain.
</para>

<para>
Additional processing options are available via #SoupServer's signals;
Connect to #SoupServer::request-started to be notified every time a
new request is being processed. (This gives you a chance to connect to
the #SoupMessage "got-" signals in case you want to do processing
before the body has been fully read.)
</para>

<para>
Once the server is set up, start it processing connections by calling
soup_server_run_async() or soup_server_run().  #SoupServer runs via
the glib main loop; if you need to have a server that runs in another
thread (or merely isn't bound to the default main loop), create a
#GMainContext for it to use, and set that via the
#SOUP_SERVER_ASYNC_CONTEXT property. 
</para>

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

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT SoupServer ##### -->
<para>

</para>


<!-- ##### SIGNAL SoupServer::request-aborted ##### -->
<para>

</para>

@soupserver: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### SIGNAL SoupServer::request-finished ##### -->
<para>

</para>

@soupserver: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### SIGNAL SoupServer::request-read ##### -->
<para>

</para>

@soupserver: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### SIGNAL SoupServer::request-started ##### -->
<para>

</para>

@soupserver: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### ARG SoupServer:async-context ##### -->
<para>

</para>

<!-- ##### ARG SoupServer:interface ##### -->
<para>

</para>

<!-- ##### ARG SoupServer:port ##### -->
<para>

</para>

<!-- ##### ARG SoupServer:ssl-cert-file ##### -->
<para>

</para>

<!-- ##### ARG SoupServer:ssl-key-file ##### -->
<para>

</para>

<!-- ##### FUNCTION soup_server_new ##### -->
<para>

</para>

@optname1: 
@Varargs: 
@Returns: 


<!-- ##### FUNCTION soup_server_is_https ##### -->
<para>

</para>

@server: 
@Returns: 


<!-- ##### FUNCTION soup_server_get_port ##### -->
<para>

</para>

@server: 
@Returns: 


<!-- ##### FUNCTION soup_server_get_listener ##### -->
<para>

</para>

@server: 
@Returns: 


<!-- ##### FUNCTION soup_server_run ##### -->
<para>

</para>

@server: 


<!-- ##### FUNCTION soup_server_run_async ##### -->
<para>

</para>

@server: 


<!-- ##### FUNCTION soup_server_quit ##### -->
<para>

</para>

@server: 


<!-- ##### FUNCTION soup_server_get_async_context ##### -->
<para>

</para>

@server: 
@Returns: 


<!-- ##### USER_FUNCTION SoupServerCallback ##### -->
<para>

</para>

@server: 
@msg: 
@path: 
@query: 
@context: 
@user_data: 


<!-- ##### FUNCTION soup_server_add_handler ##### -->
<para>

</para>

@server: 
@path: 
@callback: 
@destroy: 
@data: 


<!-- ##### FUNCTION soup_server_remove_handler ##### -->
<para>

</para>

@server: 
@path: 


<!-- ##### STRUCT SoupClientContext ##### -->
<para>

</para>

@sock: 
@auth_user: 
@auth_realm: 

<!-- ##### FUNCTION soup_client_context_get_address ##### -->
<para>

</para>

@ctx: 
@Returns: 


<!-- ##### FUNCTION soup_client_context_get_host ##### -->
<para>

</para>

@ctx: 
@Returns: 


<!-- ##### FUNCTION soup_server_add_auth_domain ##### -->
<para>

</para>

@server: 
@auth_domain: 


<!-- ##### FUNCTION soup_server_remove_auth_domain ##### -->
<para>

</para>

@server: 
@auth_domain: 


<!-- ##### FUNCTION soup_server_pause_message ##### -->
<para>

</para>

@server: 
@msg: 


<!-- ##### FUNCTION soup_server_unpause_message ##### -->
<para>

</para>

@server: 
@msg: 


<!-- ##### MACRO SOUP_SERVER_PORT ##### -->
<para>
An alias for the "port" property.
</para>



<!-- ##### MACRO SOUP_SERVER_INTERFACE ##### -->
<para>
An alias for the "interface" property.
</para>



<!-- ##### MACRO SOUP_SERVER_SSL_CERT_FILE ##### -->
<para>
An alias for the "ssl-cert-file" property.
</para>



<!-- ##### MACRO SOUP_SERVER_SSL_KEY_FILE ##### -->
<para>
An alias for the "ssl-key-file" property.
</para>



<!-- ##### MACRO SOUP_SERVER_ASYNC_CONTEXT ##### -->
<para>
An alias for the "async-context" property.
</para>