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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* Copyright (C) 2000-2003, Ximian, Inc.
*/
#ifndef SOUP_MESSAGE_H
#define SOUP_MESSAGE_H 1
#include <libsoup/soup-types.h>
#include <libsoup/soup-method.h>
#define SOUP_TYPE_MESSAGE (soup_message_get_type ())
#define SOUP_MESSAGE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), SOUP_TYPE_MESSAGE, SoupMessage))
#define SOUP_MESSAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), SOUP_TYPE_MESSAGE, SoupMessageClass))
#define SOUP_IS_MESSAGE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SOUP_TYPE_MESSAGE))
#define SOUP_IS_MESSAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), SOUP_TYPE_MESSAGE))
#define SOUP_MESSAGE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), SOUP_TYPE_MESSAGE, SoupMessageClass))
typedef struct SoupMessagePrivate SoupMessagePrivate;
typedef enum {
SOUP_MESSAGE_STATUS_IDLE,
SOUP_MESSAGE_STATUS_QUEUED,
SOUP_MESSAGE_STATUS_CONNECTING,
SOUP_MESSAGE_STATUS_RUNNING,
SOUP_MESSAGE_STATUS_FINISHED
} SoupMessageStatus;
#define SOUP_MESSAGE_IS_STARTING(msg) (msg->status == SOUP_MESSAGE_STATUS_QUEUED || msg->status == SOUP_MESSAGE_STATUS_CONNECTING)
typedef enum {
SOUP_TRANSFER_UNKNOWN = 0,
SOUP_TRANSFER_CHUNKED,
SOUP_TRANSFER_CONTENT_LENGTH
} SoupTransferEncoding;
typedef enum {
SOUP_BUFFER_SYSTEM_OWNED = 0,
SOUP_BUFFER_USER_OWNED,
SOUP_BUFFER_STATIC
} SoupOwnership;
typedef struct {
SoupOwnership owner;
char *body;
guint length;
} SoupDataBuffer;
struct SoupMessage {
GObject parent;
SoupMessagePrivate *priv;
const char *method;
guint status_code;
const char *reason_phrase;
SoupDataBuffer request;
GHashTable *request_headers;
SoupDataBuffer response;
GHashTable *response_headers;
SoupMessageStatus status;
};
typedef struct {
GObjectClass parent_class;
/* signals */
void (*wrote_informational) (SoupMessage *msg);
void (*wrote_headers) (SoupMessage *msg);
void (*wrote_chunk) (SoupMessage *msg);
void (*wrote_body) (SoupMessage *msg);
void (*got_informational) (SoupMessage *msg);
void (*got_headers) (SoupMessage *msg);
void (*got_chunk) (SoupMessage *msg);
void (*got_body) (SoupMessage *msg);
void (*restarted) (SoupMessage *msg);
void (*finished) (SoupMessage *msg);
} SoupMessageClass;
GType soup_message_get_type (void);
typedef void (*SoupMessageCallbackFn) (SoupMessage *req, gpointer user_data);
SoupMessage *soup_message_new (const char *method,
const char *uri_string);
SoupMessage *soup_message_new_from_uri (const char *method,
const SoupUri *uri);
void soup_message_set_request (SoupMessage *msg,
const char *content_type,
SoupOwnership req_owner,
char *req_body,
gulong req_length);
void soup_message_set_response (SoupMessage *msg,
const char *content_type,
SoupOwnership resp_owner,
char *resp_body,
gulong resp_length);
void soup_message_add_header (GHashTable *hash,
const char *name,
const char *value);
const char *soup_message_get_header (GHashTable *hash,
const char *name);
const GSList *soup_message_get_header_list (GHashTable *hash,
const char *name);
void soup_message_foreach_header (GHashTable *hash,
GHFunc func,
gpointer user_data);
void soup_message_remove_header (GHashTable *hash,
const char *name);
void soup_message_clear_headers (GHashTable *hash);
typedef enum {
SOUP_HTTP_1_0 = 0,
SOUP_HTTP_1_1 = 1
} SoupHttpVersion;
void soup_message_set_http_version (SoupMessage *msg,
SoupHttpVersion version);
SoupHttpVersion soup_message_get_http_version (SoupMessage *msg);
gboolean soup_message_is_keepalive (SoupMessage *msg);
const SoupUri *soup_message_get_uri (SoupMessage *msg);
void soup_message_set_uri (SoupMessage *msg,
const SoupUri *uri);
typedef enum {
/*
* SOUP_MESSAGE_NO_REDIRECT:
* Do not follow redirection responses.
*/
SOUP_MESSAGE_NO_REDIRECT = (1 << 1),
/*
* SOUP_MESSAGE_OVERWRITE_CHUNKS:
* Downloaded data chunks should not be stored in the response
* data buffer. Instead only send data to SOUP_HANDLER_BODY_CHUNK
* handlers, then truncate the data buffer.
*
* Useful when the response is expected to be very large, and
* storage in memory is not desired.
*/
SOUP_MESSAGE_OVERWRITE_CHUNKS = (1 << 3),
/*
* SOUP_MESSAGE_EXPECT_CONTINUE: The message includes an
* "Expect: 100-continue" header, and we should not send the
* body until the Continue response has been received. (This
* is automatically set if there is an "Expect: 100-continue"
* header.)
*/
SOUP_MESSAGE_EXPECT_CONTINUE = (1 << 4)
} SoupMessageFlags;
void soup_message_set_flags (SoupMessage *msg,
guint flags);
guint soup_message_get_flags (SoupMessage *msg);
/*
* Handler Registration
*/
typedef enum {
SOUP_HANDLER_POST_REQUEST = 1,
SOUP_HANDLER_PRE_BODY,
SOUP_HANDLER_BODY_CHUNK,
SOUP_HANDLER_POST_BODY
} SoupHandlerPhase;
void soup_message_add_handler (SoupMessage *msg,
SoupHandlerPhase type,
SoupMessageCallbackFn handler_cb,
gpointer user_data);
void soup_message_add_header_handler (SoupMessage *msg,
const char *header,
SoupHandlerPhase type,
SoupMessageCallbackFn,
gpointer user_data);
void soup_message_add_status_code_handler (
SoupMessage *msg,
guint status_code,
SoupHandlerPhase type,
SoupMessageCallbackFn,
gpointer user_data);
void soup_message_add_status_class_handler (
SoupMessage *msg,
SoupStatusClass status_class,
SoupHandlerPhase type,
SoupMessageCallbackFn,
gpointer user_data);
void soup_message_remove_handler (SoupMessage *msg,
SoupHandlerPhase type,
SoupMessageCallbackFn,
gpointer user_data);
/*
* Status Setting
*/
void soup_message_set_status (SoupMessage *msg,
guint status_code);
void soup_message_set_status_full (SoupMessage *msg,
guint status_code,
const char *reason_phrase);
/* Chunked encoding */
void soup_message_add_chunk (SoupMessage *msg,
SoupOwnership owner,
const char *body,
guint length);
void soup_message_add_final_chunk (SoupMessage *msg);
SoupDataBuffer*soup_message_pop_chunk (SoupMessage *msg);
/* I/O */
void soup_message_send_request (SoupMessage *req,
SoupSocket *sock,
gboolean via_proxy);
void soup_message_read_request (SoupMessage *req,
SoupSocket *sock);
void soup_message_io_stop (SoupMessage *msg);
void soup_message_io_pause (SoupMessage *msg);
void soup_message_io_unpause (SoupMessage *msg);
void soup_message_wrote_informational (SoupMessage *msg);
void soup_message_wrote_headers (SoupMessage *msg);
void soup_message_wrote_chunk (SoupMessage *msg);
void soup_message_wrote_body (SoupMessage *msg);
void soup_message_got_informational (SoupMessage *msg);
void soup_message_got_headers (SoupMessage *msg);
void soup_message_got_chunk (SoupMessage *msg);
void soup_message_got_body (SoupMessage *msg);
void soup_message_restarted (SoupMessage *msg);
void soup_message_finished (SoupMessage *msg);
#endif /*SOUP_MESSAGE_H*/
|
