XBinder  Version 2.9.x
Classes | Macros | Typedefs | Functions
rtxStream.h File Reference

Input/output data stream type definitions and function prototypes. More...

#include "rtxsrc/rtxContext.h"
#include "rtxsrc/rtxMemBuf.h"

Go to the source code of this file.

Classes

struct  OSRTSTREAM
 The stream control block. More...
 

Macros

#define rtxStreamBlockingRead   rtxStreamRead
 rtxStreamBlockingRead is deprecated. More...
 

Typedefs

typedef long(* OSRTStreamReadProc) (struct OSRTSTREAM *pStream, OSOCTET *pbuffer, size_t nocts)
 Stream read function pointer type. More...
 
typedef OSRTStreamReadProc OSRTStreamBlockingReadProc
 OSRTStreamBlockingReadProc is deprecated. More...
 
typedef long(* OSRTStreamWriteProc) (struct OSRTSTREAM *pStream, const OSOCTET *data, size_t numocts)
 Stream write function pointer type. More...
 
typedef int(* OSRTStreamFlushProc) (struct OSRTSTREAM *pStream)
 Stream flush function pointer type. More...
 
typedef int(* OSRTStreamCloseProc) (struct OSRTSTREAM *pStream)
 Stream close function pointer type. More...
 
typedef int(* OSRTStreamSkipProc) (struct OSRTSTREAM *pStream, size_t skipBytes)
 Stream skip function pointer type. More...
 
typedef int(* OSRTStreamMarkProc) (struct OSRTSTREAM *pStream, size_t readAheadLimit)
 Stream mark function pointer type. More...
 
typedef int(* OSRTStreamResetProc) (struct OSRTSTREAM *pStream)
 Stream reset function pointer type. More...
 
typedef int(* OSRTStreamGetPosProc) (struct OSRTSTREAM *pStream, size_t *ppos)
 Stream get position function pointer type. More...
 
typedef int(* OSRTStreamSetPosProc) (struct OSRTSTREAM *pStream, size_t pos)
 Stream set position function pointer type. More...
 
typedef struct OSRTSTREAM OSRTSTREAM
 The stream control block. More...
 

Functions

EXTERNRT int rtxStreamClose (OSCTXT *pctxt)
 This function closes the input or output stream and releases any system resources associated with the stream. More...
 
EXTERNRT int rtxStreamFlush (OSCTXT *pctxt)
 This function flushes the output stream and forces any buffered output octets to be written out. More...
 
EXTERNRT int rtxStreamLoadInputBuffer (OSCTXT *pctxt, OSSIZE nbytes)
 This is for meant for internal use by the runtime. More...
 
EXTERNRT int rtxStreamInit (OSCTXT *pctxt)
 This function initializes a stream part of the context block. More...
 
EXTERNRT int rtxStreamInitCtxtBuf (OSCTXT *pctxt)
 This function initializes a stream to use the context memory buffer for stream buffering. More...
 
EXTERNRT int rtxStreamRemoveCtxtBuf (OSCTXT *pctxt)
 This function removes the use of a context memory buffer from a stream. More...
 
EXTERNRT long rtxStreamRead (OSCTXT *pctxt, OSOCTET *pbuffer, size_t nocts)
 Read up to nocts bytes of data from the input stream into an array of octets. More...
 
EXTERNRT long rtxStreamRead2 (OSCTXT *pctxt, OSOCTET *pbuffer, size_t nocts, size_t bufSize)
 Attempt to read nocts bytes from the input stream into an array of octets. More...
 
EXTERNRT int rtxStreamSkip (OSCTXT *pctxt, size_t skipBytes)
 This function skips over and discards the specified amount of data octets from this input stream. More...
 
EXTERNRT long rtxStreamWrite (OSCTXT *pctxt, const OSOCTET *data, size_t numocts)
 This function writes the specified amount of octets from the specified array to the output stream. More...
 
EXTERNRT int rtxStreamGetIOBytes (OSCTXT *pctxt, size_t *pPos)
 This function returns the number of processed octets. More...
 
EXTERNRT int rtxStreamMark (OSCTXT *pctxt, size_t readAheadLimit)
 Marks the current position in this input stream. More...
 
EXTERNRT int rtxStreamReset (OSCTXT *pctxt)
 Repositions this stream to the position recorded by the last call to the rtxStreamMark function. More...
 
EXTERNRT OSBOOL rtxStreamMarkSupported (OSCTXT *pctxt)
 Tests if this input stream supports the mark and reset methods. More...
 
EXTERNRT OSBOOL rtxStreamIsOpened (OSCTXT *pctxt)
 Tests if this stream opened (for reading or writing). More...
 
EXTERNRT OSBOOL rtxStreamIsReadable (OSCTXT *pctxt)
 Tests if this stream opened for reading. More...
 
EXTERNRT OSBOOL rtxStreamIsWritable (OSCTXT *pctxt)
 Tests if this stream opened for writing. More...
 
EXTERNRT int rtxStreamRelease (OSCTXT *pctxt)
 This function releases the stream's resources. More...
 
EXTERNRT void rtxStreamSetCapture (OSCTXT *pctxt, OSRTMEMBUF *pmembuf)
 This function sets a capture buffer for the stream. More...
 
EXTERNRT OSRTMEMBUF * rtxStreamGetCapture (OSCTXT *pctxt)
 This function returns the capture buffer currently assigned to the stream. More...
 
EXTERNRT int rtxStreamGetPos (OSCTXT *pctxt, size_t *ppos)
 Get the current position in input stream. More...
 
EXTERNRT int rtxStreamSetPos (OSCTXT *pctxt, size_t pos)
 Set the current position in input stream. More...
 

Detailed Description

Input/output data stream type definitions and function prototypes.

Definition in file rtxStream.h.