Main Page | Modules | Class List | Directories | File List | Class Members | File Members

axis2_stream_ops Struct Reference
[Stream]

Axis2 stream operations struct. More...

#include <axis2_stream.h>

List of all members.

Public Attributes

axis2_status_t(* free )(struct axis2_stream *stream)
axis2_status_t(* read )(void *buffer, size_t count)
axis2_status_t(* write )(const void *buffer, size_t count)
void *(* file_open )(const char *file_name, const char *options)
axis2_status_t(* file_close )(void *file_ptr)
axis2_char_t(* file_get_char )(void *file_ptr)
axis2_status_t(* file_unget_char )(const char chr, void *file_ptr)


Detailed Description

Axis2 stream operations struct.

Encapsulator struct for operations of axis2_stream


Member Data Documentation

axis2_status_t( * axis2_stream_ops::file_close)(void *file_ptr)
 

close a file

Parameters:
file_ptr file pointer of the file need to be closed
Returns:
status code

axis2_char_t( * axis2_stream_ops::file_get_char)(void *file_ptr)
 

reads a once character from a file

Parameters:
file_ptr pointer to the file to be read from
Returns:
char read

void*( * axis2_stream_ops::file_open)(const char *file_name, const char *options)
 

open a file for read according to the file options given

Parameters:
file_name file to be opened
options file options given.
Returns:
status code

axis2_status_t( * axis2_stream_ops::file_unget_char)(const char chr, void *file_ptr)
 

write a previously read character back to the file stream

Parameters:
chr charater to write back
file_ptr file pointer from which chr is read previously and need to be written back to
Returns:
status code

axis2_status_t( * axis2_stream_ops::free)(struct axis2_stream *stream)
 

deletes the stream

Returns:
axis2_status_t AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_status_t( * axis2_stream_ops::read)(void *buffer, size_t count)
 

reads from stream

Parameters:
buffer buffer into which the content is to be read
size size of the buffer
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE

axis2_status_t( * axis2_stream_ops::write)(const void *buffer, size_t count)
 

writes into stream

Parameters:
buffer buffer to be written
size size of the buffer
Returns:
satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE


The documentation for this struct was generated from the following file:
Generated on Thu Nov 24 13:58:32 2005 for Axis2/C by  doxygen 1.4.2