summaryrefslogtreecommitdiffstats
path: root/include/axis2_http_simple_request.h
blob: cb2b8b51a2ce4c26cc46d163a92609457fb3c61b (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
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements.  See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License.  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#ifndef AXIS2_HTTP_SIMPLE_REQUEST_H
#define AXIS2_HTTP_SIMPLE_REQUEST_H

/**
 * @defgroup axis2_http_simple_request http simple request
 * @ingroup axis2_core_trans_http
 * @{
 */

/**
 * @file axis2_http_simple_request.h
 * @brief axis2 HTTP Simple Request
 */

#include <axis2_const.h>
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axis2_http_request_line.h>
#include <axis2_http_header.h>
#include <axutil_stream.h>
#include <axutil_array_list.h>

#ifdef __cplusplus
extern "C"
{
#endif

    /** Type name for struct axis2_http_simple_request */
    typedef struct axis2_http_simple_request axis2_http_simple_request_t;

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axis2_http_request_line_t *AXIS2_CALL

    axis2_http_simple_request_get_request_line(
        const axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     * @param request_line pointer to request line
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_http_simple_request_set_request_line(
        axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env,
        axis2_http_request_line_t * request_line);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     * @param name pointer to name
     */
    AXIS2_EXTERN axis2_bool_t AXIS2_CALL

    axis2_http_simple_request_contains_header(
        axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env,
        const axis2_char_t * name);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL

    axis2_http_simple_request_get_headers(
        const axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     * @param str pointer to str
     */
    AXIS2_EXTERN axis2_http_header_t *AXIS2_CALL

    axis2_http_simple_request_get_first_header(
        const axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env,
        const axis2_char_t * str);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     * @param str pointer to str
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_http_simple_request_remove_headers(
        axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env,
        const axis2_char_t * str);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     * @param header pointer to header
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_http_simple_request_add_header(
        axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env,
        axis2_http_header_t * header);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN const axis2_char_t *AXIS2_CALL

    axis2_http_simple_request_get_content_type(
        const axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN const axis2_char_t *AXIS2_CALL

    axis2_http_simple_request_get_charset(
        const axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axis2_ssize_t AXIS2_CALL

    axis2_http_simple_request_get_content_length(
        const axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axutil_stream_t *AXIS2_CALL

    axis2_http_simple_request_get_body(
        const axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     * @param buf double pointer to buf
     */
    AXIS2_EXTERN axis2_ssize_t AXIS2_CALL

    axis2_http_simple_request_get_body_bytes(
        const axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env,
        char **buf);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     * @param str pointer to str
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_http_simple_request_set_body_string(
        axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env,
        void *str,
        unsigned int str_len);

    /**
     * @param simple_request pointer to simple request
     * @param env pointer to environment struct
     * @return void
     */
    AXIS2_EXTERN void AXIS2_CALL
    axis2_http_simple_request_free(
        axis2_http_simple_request_t * simple_request,
        const axutil_env_t * env);

    /**
     * @param env pointer to environment struct
     * @param request_line pointer to request line
     * @param http_headers double pointer to http headers
     * @param http_hdr_count
     * @param content pointer to content
     */
    AXIS2_EXTERN axis2_http_simple_request_t *AXIS2_CALL

    axis2_http_simple_request_create(
        const axutil_env_t * env,
        axis2_http_request_line_t * request_line,
        axis2_http_header_t ** http_headers,
        axis2_ssize_t http_hdr_count,
        axutil_stream_t * content);

    /** @} */
#ifdef __cplusplus
}
#endif

#endif                          /* AXIS2_HTTP_SIMPLE_REQUEST_H */