stream
[utilities]


Classes

struct  axis2_stream_ops
 Axis2 stream ops struct. More...
struct  axis2_stream
 Axis2 Stream struct. More...

Defines

#define AXIS2_STREAM_FREE(stream, env)   ((stream->ops)->free_fn(stream, env))
#define AXIS2_STREAM_FREE_VOID_ARG(stream, env)   ((stream->ops)->free_void_arg(stream, env))
#define AXIS2_STREAM_READ(stream, env, buffer, count)   ((stream)->ops->read(stream, env, buffer, count))
#define AXIS2_STREAM_WRITE(stream, env, buffer, count)   ((stream)->ops->write(stream, env, buffer, count))
#define AXIS2_STREAM_SKIP(stream, env, count)   ((stream)->ops->write(stream, env, count))
#define AXIS2_STREAM_GET_CHAR(stream, env)   ((stream)->ops->get_char(stream, env))
#define AXIS2_STREAM_UNGET_CHAR(stream, env, ch)   ((stream)->ops->unget_char(stream, env, ch))
#define AXIS2_STREAM_BASIC_GET_LEN(stream, env)   ((stream)->ops->get_len(stream, env))
#define AXIS2_STREAM_GET_TYPE(stream, env)   ((stream)->ops->get_type(stream, env))

Typedefs

typedef enum axis2_stream_type axis2_stream_type_t

Enumerations

enum  axis2_stream_type { AXIS2_STREAM_BASIC = 0, AXIS2_STREAM_FILE, AXIS2_STREAM_SOCKET, AXIS2_STREAM_MANAGED }
 Axis2 stream types. More...

Functions

AXIS2_EXTERN axis2_stream_taxis2_stream_create_basic (const axis2_env_t *env)
 Constructor for creating an in memory stream.
AXIS2_EXTERN axis2_stream_taxis2_stream_create_file (const axis2_env_t *env, FILE *fp)
 Constructor for creating a file stream.
AXIS2_EXTERN axis2_stream_taxis2_stream_create_socket (const axis2_env_t *env, int socket)
 Constructor for creating a file stream.
AXIS2_EXTERN axis2_status_t axis2_stream_free_void_arg (void *stream, const axis2_env_t *env)

Enumeration Type Documentation

enum axis2_stream_type
 

Axis2 stream types.

This is used to create a stream to correspond to particular i/o mtd


Function Documentation

AXIS2_EXTERN axis2_stream_t* axis2_stream_create_basic const axis2_env_t env  ) 
 

Constructor for creating an in memory stream.

Returns:
axis2_stream (in memory)

AXIS2_EXTERN axis2_stream_t* axis2_stream_create_file const axis2_env_t env,
FILE *  fp
 

Constructor for creating a file stream.

Parameters:
valid file pointer (opened file)
Returns:
axis2_stream (file)

AXIS2_EXTERN axis2_stream_t* axis2_stream_create_socket const axis2_env_t env,
int  socket
 

Constructor for creating a file stream.

Parameters:
valid socket (opened socket)
Returns:
axis2_stream (socket)

AXIS2_EXTERN axis2_status_t axis2_stream_free_void_arg void *  stream,
const axis2_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


Generated on Thu Aug 31 17:32:42 2006 for Axis2/C by  doxygen 1.4.6