Site Map | Careers | Contact Us

• PRODUCTS
• SUPPORT
• RESOURCES

• PARTNERS
• CUSTOMERS
• ABOUT US

Home > Support > Documentation

rtxStream.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2007 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_

#include "rtxsrc/rtxContext.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);

#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_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_USER   1000

#define OSRTSTRM_K_BUFSIZE 1024

#define OSRTSTRM_K_INVALIDMARK ((size_t)-1)

#define OSRTSTREAM_BYTEINDEX(pctxt) \
(((pctxt)->pStream->id == OSRTSTRMID_DIRECTBUF) ? \
((pctxt)->pStream->bytesProcessed + (pctxt)->buffer.byteIndex) : \
((pctxt)->pStream->ioBytes))

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

typedef struct OSRTSTREAM {
   OSRTStreamReadProc  read;   /*< pointer to read function  */
   OSRTStreamBlockingReadProc blockingRead;/*< pointer to blockingRead function*/
   OSRTStreamWriteProc write;  /*< pointer to write function */
   OSRTStreamFlushProc flush;  /*< pointer to flush function */
   OSRTStreamCloseProc close;  /*< pointer to close function */
   OSRTStreamSkipProc  skip;   /*< pointer to skip function  */
   OSRTStreamMarkProc  mark;   /*< pointer to mark function  */
   OSRTStreamResetProc reset;  /*< pointer to reset function  */

   void*     extra;          /*< pointer to stream-specific data      */

   size_t    bufsize;        /*< physical size of pctxt->buffer.data buf */
   size_t    readAheadLimit; /*< read ahead limit (used by ::rtxStreamMark/::rtxStreamReset */
   size_t    bytesProcessed; /*< the number of bytes already processed */
   size_t    markedBytesProcessed; /*< the marked number of bytes already processed */
   size_t    ioBytes;        /*< the actual number of bytes already read/written    */
   size_t    nextMarkOffset; /* offset of next appropriate mark position */

   OSUINT32  id;             /*< id of stream (see OSRTSTRMID_* macros  */

   /* this should be included in extra..
   OSRTSOCKET socket;         *< socket handle for socket streams     */

   OSUINT16  flags;          /*< flags (see OSRTSTRMF_* macros          */
} OSRTSTREAM;

EXTERNRTX int rtxStreamClose (OSCTXT* pctxt);

EXTERNRTX int rtxStreamFlush (OSCTXT* pctxt);

EXTERNRTX int rtxStreamInit (OSCTXT* pctxt);

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

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

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

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

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

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

EXTERNRTX int rtxStreamReset (OSCTXT* pctxt);

EXTERNRTX OSBOOL rtxStreamMarkSupported (OSCTXT* pctxt);

EXTERNRTX OSBOOL rtxStreamIsOpened (OSCTXT* pctxt);

EXTERNRTX OSBOOL rtxStreamIsReadable (OSCTXT* pctxt);

EXTERNRTX OSBOOL rtxStreamIsWritable (OSCTXT* pctxt);

EXTERNRTX int rtxStreamRelease (OSCTXT* pctxt);

#ifdef __cplusplus
}
#endif

#endif /* _RTXSTREAM_H_ */

©Copyright 2001-2007. Objective Systems, Inc. All Rights Reserved.