summaryrefslogtreecommitdiffstats
path: root/include/axis2_http_out_transport_info.h
blob: 7ba4b94ecc84172fce6e5339c2c4295aaae3b48b (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
/*
* 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_OUT_TRANSPORT_INFO_H
#define AXIS2_HTTP_OUT_TRANSPORT_INFO_H

/**
 * @defgroup axis2_http_out_transport_info http out transport info
 * @ingroup axis2_core_trans_http
 * Description
 * @{
 */

/**
 * @file axis2_http_out_transport_info.h
 * @brief axis2 HTTP Out Transport Info
 */

#include <axis2_const.h>
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axis2_http_simple_response.h>
#include <axis2_out_transport_info.h>
#include <axis2_transport_receiver.h>

#ifdef __cplusplus
extern "C"
{
#endif

    /** Type name for struct axis2_http_out_transport_info */
    typedef struct axis2_http_out_transport_info
                axis2_http_out_transport_info_t;

    struct axis2_http_out_transport_info
    {
        axis2_out_transport_info_t out_transport;
        axis2_http_simple_response_t *response;
        axis2_transport_receiver_t *server;
        axis2_char_t *encoding;

        axis2_status_t(
            AXIS2_CALL
            * set_content_type)(
                axis2_http_out_transport_info_t * info,
                const axutil_env_t * env,
                const axis2_char_t * content_type);

        axis2_status_t(
            AXIS2_CALL
            * set_char_encoding)(
                axis2_http_out_transport_info_t * info,
                const axutil_env_t * env,
                const axis2_char_t * encoding);
        
        axis2_status_t(
            AXIS2_CALL
            * set_cookie_header)(
                axis2_http_out_transport_info_t * info,
                const axutil_env_t * env,
                const axis2_char_t * cookie_header);
        
        axis2_status_t(
            AXIS2_CALL
            * set_session)(
                axis2_http_out_transport_info_t * info,
                const axutil_env_t * env,
                const axis2_char_t * session_id,
                const axis2_char_t * session_value);

        void(
            AXIS2_CALL
            * free_function)(
                axis2_http_out_transport_info_t * info,
                const axutil_env_t * env);
    };

    /**
     * @param info pointer to info
     * @param env pointer to environment struct
     * @param content_type pointer to content type
     */
    AXIS2_EXTERN int AXIS2_CALL

    axis2_http_out_transport_info_set_content_type(
        axis2_http_out_transport_info_t * info,
        const axutil_env_t * env,
        const axis2_char_t * content_type);

    /**
     * @param info pointer to info
     * @param env pointer to environment struct
     * @param encoding pointer to encoding
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_http_out_transport_info_set_char_encoding(
        axis2_http_out_transport_info_t * info,
        const axutil_env_t * env,
        const axis2_char_t * encoding);

    /**
     * @param info pointer to info
     * @param env pointer to environment struct
     * @param cookie_header pointer to cookie_header
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_http_out_transport_info_set_cookie_header(
        axis2_http_out_transport_info_t * info,
        const axutil_env_t * env,
        const axis2_char_t * cookie_header);
     
    /** @param info pointer to info
     * @param env pointer to environment struct
     * @param session_str pointer to session string
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_http_out_transport_info_set_session(
        axis2_http_out_transport_info_t * info,
        const axutil_env_t * env,
        const axis2_char_t * session_id,
        const axis2_char_t * session_value);


    /**
     * @param out_transport_info pointer to out transport info
     * @param env pointer to environment struct
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN void AXIS2_CALL
    axis2_http_out_transport_info_free(
        axis2_http_out_transport_info_t * out_transport_info,
        const axutil_env_t * env);

    /**
     * @param env pointer to environment struct
     * @param response pointer to response
     */
    AXIS2_EXTERN axis2_http_out_transport_info_t *AXIS2_CALL

    axis2_http_out_transport_info_create(
        const axutil_env_t * env,
        axis2_http_simple_response_t * response);

    /**
     * Free http_out_transport_info passed as void pointer. This will be
     * cast into appropriate type and then pass the cast object
     * into the http_out_transport_info structure's free method
     * @param transport_info pointer to transport info
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN void AXIS2_CALL
    axis2_http_out_transport_info_free_void_arg(
        void *transport_info,
        const axutil_env_t * env);

    AXIS2_EXTERN void AXIS2_CALL

    axis2_http_out_transport_info_set_char_encoding_func(
        axis2_http_out_transport_info_t * out_transport_info,
        const axutil_env_t * env,
        axis2_status_t(AXIS2_CALL
                * set_encoding)
        (axis2_http_out_transport_info_t *,
                const axutil_env_t *,
                const axis2_char_t *));

    AXIS2_EXTERN void AXIS2_CALL

    axis2_http_out_transport_info_set_content_type_func(
        axis2_http_out_transport_info_t * out_transport_info,
        const axutil_env_t * env,
        axis2_status_t(AXIS2_CALL
                *
                set_content_type)(axis2_http_out_transport_info_t *,
                        const axutil_env_t *,
                        const axis2_char_t *));
    
    AXIS2_EXTERN void AXIS2_CALL
    axis2_http_out_transport_info_set_cookie_header_func(
        axis2_http_out_transport_info_t * out_transport_info,
        const axutil_env_t * env,
        axis2_status_t(AXIS2_CALL
                *
                set_cookie_header)(axis2_http_out_transport_info_t *,
                        const axutil_env_t *,
                        const axis2_char_t *));
    
    AXIS2_EXTERN void AXIS2_CALL
    axis2_http_out_transport_info_set_session_func(
        axis2_http_out_transport_info_t * out_transport_info,
        const axutil_env_t * env,
        axis2_status_t(AXIS2_CALL
                *
                set_session)(axis2_http_out_transport_info_t *,
                        const axutil_env_t *,
                        const axis2_char_t *,
                        const axis2_char_t *));

    AXIS2_EXTERN void AXIS2_CALL
    axis2_http_out_transport_info_set_free_func(
        axis2_http_out_transport_info_t * out_transport_info,
        const axutil_env_t * env,
        void(AXIS2_CALL
                * free_function)(axis2_http_out_transport_info_t *,
                        const axutil_env_t *));

    /** Set content type. */
#define AXIS2_HTTP_OUT_TRANSPORT_INFO_SET_CONTENT_TYPE(out_transport_info, \
               env, content_type) axis2_http_out_transport_info_set_content_type (out_transport_info, env, content_type)

    /** Set char encoding. */
#define AXIS2_HTTP_OUT_TRANSPORT_INFO_SET_CHAR_ENCODING(out_transport_info,\
               env, encoding) axis2_http_out_transport_info_set_char_encoding(out_transport_info, env, encoding)
    
    /** Set cookie_header. */
#define AXIS2_HTTP_OUT_TRANSPORT_INFO_SET_COOKIE_HEADER(out_transport_info, \
               env, cookie_header) axis2_http_out_transport_info_set_cookie_header (out_transport_info, env, cookie_header)
    
    /** Set session. */
#define AXIS2_HTTP_OUT_TRANSPORT_INFO_SET_SESSION(out_transport_info, \
               env, session_id, session_value) axis2_http_out_transport_info_set_session (out_transport_info, env, session_id, session_value)

    /** Free. */
#define AXIS2_HTTP_OUT_TRANSPORT_INFO_FREE(out_transport_info, env)\
                    axis2_http_out_transport_info_free(out_transport_info, env)

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