Stream.h File Reference

OpenSOAP API Stream Processing. More...

#include <OpenSOAP/ByteArray.h>

Go to the source code of this file.

Typedefs
typedef tagOpenSOAPStream	OpenSOAPStream
	OPenSOAPStream Structure Type Definition.
typedef OpenSOAPStream *	OpenSOAPStreamPtr
	OpenSOAPStream Pointer Type Definition.
Functions
int	OpenSOAPStreamRelease (OpenSOAPStreamPtr s)
	Release OpenSOAP Stream.
int	OpenSOAPStreamRead (OpenSOAPStreamPtr s, unsigned char *buf, size_t *buf_sz)
	Read From OpenSOAP Stream.
int	OpenSOAPStreamWrite (OpenSOAPStreamPtr s, const unsigned char *buf, size_t *buf_sz)
	Write To OpenSOAP Stream.
int	OpenSOAPStreamReadToDelm (OpenSOAPStreamPtr s, const unsigned char *delm, size_t delm_sz, OpenSOAPByteArrayPtr buf)
	Read From OpenSOAP Stream Up To Delimiter.
int	OpenSOAPStreamReadChunkedData (OpenSOAPStreamPtr s, OpenSOAPByteArrayPtr buf)
	Read Chunked Data From OpenSOAP Stream.
int	OpenSOAPStreamReadWithSize (OpenSOAPStreamPtr s, size_t sz, OpenSOAPByteArrayPtr buf)
	Read Specified Size From OpenSOAP Stream. If size is 0, read as much as possible.
int	OpenSOAPStreamWriteByteArray (OpenSOAPStreamPtr s, OpenSOAPByteArrayPtr buf, size_t *write_sz)
	Write To OpenSOAP Stream.

---

Detailed Description

OpenSOAP API Stream Processing.

Author:

OpenSOAP Development Team

---

Function Documentation

int OpenSOAPStreamRead (  OpenSOAPStreamPtr  s, unsigned char *  buf, size_t *  buf_sz )

Read From OpenSOAP Stream. Parameters: s  OpenSOAPStreamPtr [in] ((|s|)) OpenSOAP Stream buf  unsigned char * [out] ((|buf|)) Read Buffer buf_sz  size_t * [in, out] ((|buf_sz|)) Read Buffer size. After calling this function, contains actual size read. Returns: Error Code

int OpenSOAPStreamReadChunkedData (  OpenSOAPStreamPtr  s, OpenSOAPByteArrayPtr  buf )

Read Chunked Data From OpenSOAP Stream. Parameters: s  OpenSOAPStreamPtr [in] ((|s|)) OpenSOAP Stream buf  OpenSOAPByteArrayPtr [out] ((|buf|)) Read Buffer Returns: Error Code

int OpenSOAPStreamReadToDelm (  OpenSOAPStreamPtr  s, const unsigned char *  delm, size_t  delm_sz, OpenSOAPByteArrayPtr  buf )

Read From OpenSOAP Stream Up To Delimiter. Parameters: s  OpenSOAPStreamPtr [in] ((|s|)) OpenSOAP Stream delm  const unsigned char * [in] ((|delm|)) Delimiter String delm_sz  size_t [in] ((|delm_sz|)) Delimiter Size buf  OpenSOAPByteArrayPtr [out] ((|buf|)) Read Buffer Returns: Error Code

int OpenSOAPStreamReadWithSize (  OpenSOAPStreamPtr  s, size_t  sz, OpenSOAPByteArrayPtr  buf )

Read Specified Size From OpenSOAP Stream. If size is 0, read as much as possible. Parameters: s  OpenSOAPStreamPtr [in] ((|s|)) OpenSOAP Stream sz  size_t [in] ((|sz|)) Read size buf  OpenSOAPByteArrayPtr [out] ((|buf|)) Read Buffer Returns: Error Code

int OpenSOAPStreamRelease (  OpenSOAPStreamPtr  s  )

Release OpenSOAP Stream. Parameters: s  OpenSOAPStreamPtr [in] ((|s|)) OpenSOAP Stream Returns: Error Code

int OpenSOAPStreamWrite (  OpenSOAPStreamPtr  s, const unsigned char *  buf, size_t *  buf_sz )

Write To OpenSOAP Stream. Parameters: s  OpenSOAPStreamPtr [in] ((|s|)) OpenSOAP Stream buf  const unsigned char * [in] ((|buf|)) Write Buffer buf_sz  size_t * [in, out] ((|buf_sz|)) Write Buffer size. After calling this function, contains actual size written. Returns: Error Code

int OpenSOAPStreamWriteByteArray (  OpenSOAPStreamPtr  s, OpenSOAPByteArrayPtr  buf, size_t *  write_sz )

Write To OpenSOAP Stream. Parameters: s  OpenSOAPStreamPtr [in] ((|s|)) OpenSOAP Stream buf  OpenSOAPByteArrayPtr [in] ((|buf|)) Write Buffer write_sz  size_t * [out] ((|write_sz|)) Write Size Returns: Error Code

---