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
|
/*
* Copyright 2004,2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain count 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 AXUTIL_STREAM_H
#define AXUTIL_STREAM_H
#include <axutil_utils.h>
#include <axutil_utils_defines.h>
#include <axutil_env.h>
#include <stdio.h>
#ifdef __cplusplus
extern "C"
{
#endif
#define AXIS2_STREAM_DEFAULT_BUF_SIZE 2048
/**
* @defgroup axutil_stream stream
* @ingroup axis2_util
* @{
*/
/**
* \brief Axis2 stream types
*
* This is used to create a stream to correspond to
* particular i/o mtd
*/
enum axutil_stream_type
{
AXIS2_STREAM_BASIC = 0,
AXIS2_STREAM_FILE,
AXIS2_STREAM_SOCKET,
AXIS2_STREAM_MANAGED /* Example Wrapper stream for Apache2 read mechanism */
};
typedef enum axutil_stream_type axutil_stream_type_t;
typedef struct axutil_stream axutil_stream_t;
typedef int(
AXIS2_CALL
* AXUTIL_STREAM_READ)(
axutil_stream_t * stream,
const axutil_env_t * env,
void *buffer,
size_t count);
typedef int(
AXIS2_CALL
* AXUTIL_STREAM_WRITE)(
axutil_stream_t * stream,
const axutil_env_t * env,
const void *buffer,
size_t count);
typedef int(
AXIS2_CALL
* AXUTIL_STREAM_SKIP)(
axutil_stream_t * stream,
const axutil_env_t * env,
int count);
struct axutil_stream
{
axutil_stream_type_t stream_type;
int len;
int max_len;
/* Only one of these is used for a perticlar
* instance depending on the type
*/
axis2_char_t *buffer;
axis2_char_t *buffer_head;
FILE *fp;
int socket;
int axis2_eof;
/**
* reads from stream
* @param buffer buffer into which the content is to be read
* @param count size of the buffer
* @return no: of bytes read
*/
int(
AXIS2_CALL
* read)(
axutil_stream_t * stream,
const axutil_env_t * env,
void *buffer,
size_t count);
/**
* writes into stream
* @param buffer buffer to be written
* @param count size of the buffer
* @return no: of bytes actually written
*/
int(
AXIS2_CALL
* write)(
axutil_stream_t * stream,
const axutil_env_t * env,
const void *buffer,
size_t count);
/**
* Skips over and discards n bytes of data from this input stream.
* @param count number of bytes to be discarded
* @return no: of bytes actually skipped
*/
int(
AXIS2_CALL
* skip)(
axutil_stream_t * stream,
const axutil_env_t * env,
int count);
};
/**
* Deletes the stream
* @return axis2_status_t AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
AXIS2_EXTERN void AXIS2_CALL
axutil_stream_free(
axutil_stream_t * stream,
const axutil_env_t * env);
AXIS2_EXTERN void AXIS2_CALL
axutil_stream_free_void_arg(
void *stream,
const axutil_env_t * env);
/**
* reads from stream
* @param buffer buffer into which the content is to be read
* @param count size of the buffer
* @return no: of bytes read
*/
AXIS2_EXTERN int AXIS2_CALL
axutil_stream_read(
axutil_stream_t * stream,
const axutil_env_t * env,
void *buffer,
size_t count);
/**
* writes into stream
* @param buffer buffer to be written
* @param count size of the buffer
* @return no: of bytes actually written
*/
AXIS2_EXTERN int AXIS2_CALL
axutil_stream_write(
axutil_stream_t * stream,
const axutil_env_t * env,
const void *buffer,
size_t count);
/**
* Skips over and discards n bytes of data from this input stream.
* @param count number of bytes to be discarded
* @return no: of bytes actually skipped
*/
AXIS2_EXTERN int AXIS2_CALL
axutil_stream_skip(
axutil_stream_t * stream,
const axutil_env_t * env,
int count);
/**
* Returns the length of the stream (applicable only to basic stream)
* @return Length of the buffer if its type is basic, else -1
* (we can't define a length of a stream unless it is just a buffer)
*/
AXIS2_EXTERN int AXIS2_CALL
axutil_stream_get_len(
axutil_stream_t * stream,
const axutil_env_t * env);
/** \brief Constructor for creating an in memory stream
* @return axutil_stream (in memory)
*/
AXIS2_EXTERN axutil_stream_t *AXIS2_CALL
axutil_stream_create_basic(
const axutil_env_t * env);
/** \brief Constructor for creating a file stream
* @param valid file pointer (opened file)
* @return axutil_stream (file)
*/
AXIS2_EXTERN axutil_stream_t *AXIS2_CALL
axutil_stream_create_file(
const axutil_env_t * env,
FILE * fp);
/** \brief Constructor for creating a file stream
* @param valid socket (opened socket)
* @return axutil_stream (socket)
*/
AXIS2_EXTERN axutil_stream_t *AXIS2_CALL
axutil_stream_create_socket(
const axutil_env_t * env,
int socket);
/**
*Free stream
*/
AXIS2_EXTERN void AXIS2_CALL
axutil_stream_free(
axutil_stream_t * stream,
const axutil_env_t * env);
/**
* Free stream passed as void pointer. This will be
* cast into appropriate type and then pass the cast object
* into the module_desc structure's free method
*/
AXIS2_EXTERN void AXIS2_CALL
axutil_stream_free_void_arg(
void *stream,
const axutil_env_t * env);
/**
* Gets the buffer
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axutil_stream_get_buffer(
const axutil_stream_t * stream,
const axutil_env_t * env);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axutil_stream_flush_buffer(
axutil_stream_t * stream,
const axutil_env_t * env);
AXIS2_EXTERN int AXIS2_CALL
axutil_stream_peek_socket(
axutil_stream_t * stream,
const axutil_env_t * env,
void *buffer,
size_t count);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axutil_stream_flush(
axutil_stream_t * stream,
const axutil_env_t * env);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axutil_stream_close(
axutil_stream_t * stream,
const axutil_env_t * env);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axutil_stream_set_read(
axutil_stream_t * stream,
const axutil_env_t * env,
AXUTIL_STREAM_READ func);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axutil_stream_set_write(
axutil_stream_t * stream,
const axutil_env_t * env,
AXUTIL_STREAM_WRITE func);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axutil_stream_set_skip(
axutil_stream_t * stream,
const axutil_env_t * env,
AXUTIL_STREAM_SKIP func);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_STREAM_H */
|
