axis2_stream_ops Struct Reference
[stream]

Axis2 stream ops struct. More...

#include <axis2_stream.h>

List of all members.

Public Attributes

axis2_status_t(* free_fn )(axis2_stream_t *stream, const axis2_env_t *env)
axis2_status_t(* free_void_arg )(void *stream, const axis2_env_t *env)
int(* read )(axis2_stream_t *stream, const axis2_env_t *env, void *buffer, size_t count)
int(* write )(axis2_stream_t *stream, const axis2_env_t *env, const void *buffer, size_t count)
int(* skip )(axis2_stream_t *stream, const axis2_env_t *env, int count)
int(* get_char )(axis2_stream_t *stream, const axis2_env_t *env)
int(* unget_char )(axis2_stream_t *stream, const axis2_env_t *env, int ch)
int(* get_len )(axis2_stream_t *stream, const axis2_env_t *env)
axis2_stream_type_t(* get_type )(axis2_stream_t *stream, const axis2_env_t *env)


Detailed Description

Axis2 stream ops struct.

Encapsulator struct for ops of axis2_stream


Member Data Documentation

axis2_status_t( * axis2_stream_ops::free_fn)(axis2_stream_t *stream, const axis2_env_t *env)
 

Deletes the stream

Returns:
axis2_status_t AXIS2_SUCCESS on success else AXIS2_FAILURE

int( * axis2_stream_ops::get_char)(axis2_stream_t *stream, const axis2_env_t *env)
 

Reads the next character from stream and returns it as an unsigned char cast to an int, or EOF on end of file or error.

Returns:
next character in the stream

int( * axis2_stream_ops::get_len)(axis2_stream_t *stream, const axis2_env_t *env)
 

Returns the length of the stream (applicable only to basic stream)

Returns:
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_stream_type_t( * axis2_stream_ops::get_type)(axis2_stream_t *stream, const axis2_env_t *env)
 

Returns the type of the stream as axis2_stream_type_t

Returns:
Type of the stream

int( * axis2_stream_ops::read)(axis2_stream_t *stream, const axis2_env_t *env, void *buffer, size_t count)
 

reads from stream

Parameters:
buffer buffer into which the content is to be read
count size of the buffer
Returns:
no: of bytes read

int( * axis2_stream_ops::skip)(axis2_stream_t *stream, const axis2_env_t *env, int count)
 

Skips over and discards n bytes of data from this input stream.

Parameters:
count number of bytes to be discarded
Returns:
no: of bytes actually skipped

int( * axis2_stream_ops::unget_char)(axis2_stream_t *stream, const axis2_env_t *env, int ch)
 

Pushes a character back to stream, cast to unsigned char, where it is available for subsequent read operations

Parameters:
charachter to be pushed
Returns:
the pushed character or EOF if an error

int( * axis2_stream_ops::write)(axis2_stream_t *stream, const axis2_env_t *env, const void *buffer, size_t count)
 

writes into stream

Parameters:
buffer buffer to be written
count size of the buffer
Returns:
no: of bytes actually written


The documentation for this struct was generated from the following file:
Generated on Thu Aug 31 17:32:41 2006 for Axis2/C by  doxygen 1.4.6