rtxStream.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2020 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/
#ifndef _RTXSTREAM_H_
#define _RTXSTREAM_H_

#ifndef _NO_STREAM

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

#ifdef __cplusplus
extern "C" {
#endif

struct OSRTSTREAM;

typedef long (*OSRTStreamReadProc)
   (struct OSRTSTREAM* pStream, OSOCTET* pbuffer, size_t bufSize);

typedef long (*OSRTStreamBlockingReadProc)
   (struct OSRTSTREAM* pStream, OSOCTET* pbuffer, size_t toReadBytes);

typedef long (*OSRTStreamWriteProc)(struct OSRTSTREAM* pStream,
                                   const OSOCTET* data, size_t numocts);

typedef int (*OSRTStreamFlushProc)(struct OSRTSTREAM* pStream);

typedef int (*OSRTStreamCloseProc)(struct OSRTSTREAM* pStream);

typedef int (*OSRTStreamSkipProc)
   (struct OSRTSTREAM* pStream, size_t skipBytes);

typedef int (*OSRTStreamMarkProc)
   (struct OSRTSTREAM* pStream, size_t readAheadLimit);

typedef int (*OSRTStreamResetProc) (struct OSRTSTREAM* pStream);

typedef int (*OSRTStreamGetPosProc)
   (struct OSRTSTREAM* pStream, size_t* ppos);

typedef int (*OSRTStreamSetPosProc)
   (struct OSRTSTREAM* pStream, size_t pos);

#define OSRTSTRMF_INPUT      0x0001
#define OSRTSTRMF_OUTPUT     0x0002
#define OSRTSTRMF_BUFFERED   0x8000 /* direct-buffer stream    */
#define OSRTSTRMF_UNBUFFERED 0x4000 /* force unbuffered stream */
#define OSRTSTRMF_POSMARKED  0x2000 /* stream has marked position */
#define OSRTSTRMF_FIXINMEM   0x1000 /* disable flushing */
#define OSRTSTRMF_HEXTEXT    0x0800 /* do hex text / binary conversion */

#define OSRTSTRMF_BUF_INPUT    (OSRTSTRMF_INPUT|OSRTSTRMF_BUFFERED)
#define OSRTSTRMF_BUF_OUTPUT   (OSRTSTRMF_OUTPUT|OSRTSTRMF_BUFFERED)


#define OSRTSTRMID_FILE      1
#define OSRTSTRMID_SOCKET    2
#define OSRTSTRMID_MEMORY    3
#define OSRTSTRMID_BUFFERED  4
#define OSRTSTRMID_DIRECTBUF 5
#define OSRTSTRMID_CTXTBUF   6
#define OSRTSTRMID_ZLIB      7
#define OSRTSTRMID_USER   1000

#define OSRTSTRM_K_BUFSIZE 1024

#define OSRTSTRM_K_INVALIDMARK ((size_t)-1)

#define OSRTSTREAM_BYTEINDEX(pctxt) \
(((pctxt)->pStream->flags & OSRTSTRMF_BUFFERED) ?                    \
 ((pctxt)->pStream->bytesProcessed + (pctxt)->buffer.byteIndex) :    \
 ((pctxt)->pStream->bytesProcessed /* was ioBytes */ ))

#define OSRTSTREAM_ID(pctxt) ((pctxt)->pStream->id)
#define OSRTSTREAM_FLAGS(pctxt) ((pctxt)->pStream->flags)

typedef struct OSRTSTREAM {
   OSRTStreamReadProc  read;     
   OSRTStreamBlockingReadProc
      blockingRead;      
   OSRTStreamWriteProc write;   
   OSRTStreamFlushProc flush;   
   OSRTStreamCloseProc close;   
   OSRTStreamSkipProc  skip;    
   OSRTStreamMarkProc  mark;    
   OSRTStreamResetProc reset;   
   OSRTStreamGetPosProc getPos; 
   OSRTStreamSetPosProc setPos; 
   void*  extra;                
   size_t bufsize;              
   size_t readAheadLimit;       
   size_t bytesProcessed;       
   size_t markedBytesProcessed; 
   size_t ioBytes;              
   size_t nextMarkOffset;       
   size_t segsize;              
   OSUINT32 id;                 
   OSRTMEMBUF* pCaptureBuf;

   OSUINT16  flags;          
} OSRTSTREAM;

EXTERNRT int rtxStreamClose (OSCTXT* pctxt);

EXTERNRT int rtxStreamFlush (OSCTXT* pctxt);

EXTERNRT int rtxStreamInit (OSCTXT* pctxt);

EXTERNRT int rtxStreamInitCtxtBuf (OSCTXT* pctxt);

EXTERNRT int rtxStreamRemoveCtxtBuf (OSCTXT* pctxt);

EXTERNRT long rtxStreamRead
   (OSCTXT* pctxt, OSOCTET* pbuffer, size_t bufSize);

EXTERNRT long rtxStreamReadDirect
(OSCTXT* pctxt, OSOCTET* pbuffer, OSSIZE bufSize);

EXTERNRT long rtxStreamBlockingRead
   (OSCTXT* pctxt, OSOCTET* pbuffer, size_t readBytes);

EXTERNRT int rtxStreamSkip  (OSCTXT* pctxt, size_t skipBytes);

EXTERNRT long rtxStreamWrite
   (OSCTXT* pctxt, const OSOCTET* data, size_t numocts);

EXTERNRT int rtxStreamGetIOBytes (OSCTXT* pctxt, size_t* pPos);

EXTERNRT int rtxStreamMark (OSCTXT* pctxt, size_t readAheadLimit);

EXTERNRT int rtxStreamReset (OSCTXT* pctxt);

EXTERNRT OSBOOL rtxStreamMarkSupported (OSCTXT* pctxt);

EXTERNRT OSBOOL rtxStreamIsOpened (OSCTXT* pctxt);

EXTERNRT OSBOOL rtxStreamIsReadable (OSCTXT* pctxt);

EXTERNRT OSBOOL rtxStreamIsWritable (OSCTXT* pctxt);

EXTERNRT int rtxStreamRelease (OSCTXT* pctxt);

EXTERNRT void rtxStreamSetCapture (OSCTXT* pctxt, OSRTMEMBUF* pmembuf);

EXTERNRT OSRTMEMBUF* rtxStreamGetCapture (OSCTXT* pctxt);

EXTERNRT int rtxStreamGetPos (OSCTXT* pctxt, size_t* ppos);

EXTERNRT int rtxStreamSetPos (OSCTXT* pctxt, size_t pos);

#ifdef __cplusplus
}
#endif

#endif /* _NO_STREAM */
#endif /* _RTXSTREAM_H_ */