das2/das2io.h

Go to the documentation of this file.

#ifndef _das2_io_h_
#define _das2_io_h_

#include <stdio.h>
#include <zlib.h>
#include <das2/stream.h>
#include <das2/oob.h>
#include <das2/processor.h>

/* used internally for implementing stream inflate/deflate, etc/ */
#define STREAM_MODE_STRING 0

/* stream is going directly to socket (not used) */
#define STREAM_MODE_SOCKET 1

/* stream is going to file */
#define STREAM_MODE_FILE   2

/* max number of stream processor objects */
#define DAS2_MAX_PROCESSORS 10

#define DASIO_NAME_SZ 128

typedef struct das_io_struct {
   char     rw;         /* w' for write, 'r' for read */
   bool     compressed; /* 1 if stream is compressed or should be compressed */
   
   int      mode;       /* STREAM_MODE_STRING or STREAM_MODE_FILE */
   char     sName[DASIO_NAME_SZ]; /* A human readable name for data source or sink */
   
   int      offset;     /* current offset for file reads */
   
   /* File I/O */
   FILE     *file;      /* input/output file  (File I/O) */
   
   /* Buffer IO */
   char     *sBuffer;   /* buffer for string input/output */
   int      nLength;    /* length of buffer pointed to by sbuffer */
   
   /* Compressed I/O */
   z_stream *zstrm;     /* z_stream for inflate/deflate operations */
   Byte     *inbuf;     /* input buffer */
   Byte     *outbuf;    /* output buffer */
   int      zerr;       /* error code for last stream operation */
   int      eof;        /* set if end of input file */
   
   /* data object processor's with callbacks  (Input / Output) */
   StreamHandler* pProcs[DAS2_MAX_PROCESSORS+1];
   bool bSentHeader;
   
   /* Sub Object Writing (output) */
   DasBuf* pDb;        /* Sub-Object serializing buffer */
   
   int logLevel;       /* to-stream logging level. (output) */
   
   int taskSize;       /* progress indicator max value (output) */
   long tmLastProgMsg; /* Time the last progress message was emitted (output)*/
   
   OobComment cmt;     /* Hold buffers for comments and logs */
} DasIO;

DasIO* new_DasIO_cfile(const char* sProg, FILE* file, const char* mode);

DasIO* new_DasIO_file(const char* sProg, const char* sFile, const char* mode);

DasIO* new_DasIO_str(const char* sProg, char* sbuf, size_t len, const char* mode);

void del_DasIO(DasIO* pThis);


int DasIO_addProcessor(DasIO* pThis, StreamHandler* pProc);


int DasIO_readAll(DasIO* pThis);


ErrorCode DasIO_writeStreamDesc(DasIO* pThis, StreamDesc* pSd);

ErrorCode DasIO_writePktDesc(DasIO* pThis, PktDesc* pd);

ErrorCode DasIO_writePktData(DasIO* pThis, PktDesc* pPd);

ErrorCode DasIO_writeException(DasIO* pThis, OobExcept* pSe);

ErrorCode DasIO_writeComment(DasIO* pThis, OobComment* pSc);

#define LOGLVL_FINEST 0
#define LOGLVL_FINER 300
#define LOGLVL_FINE 400
#define LOGLVL_CONFIG 500
#define LOGLVL_INFO 600
#define LOGLVL_WARNING 700
#define LOGLVL_ERROR 800

ErrorCode DasIO_sendLog(DasIO* pThis, int level, char * msg, ... );

void DasIO_setLogLvl(DasIO* pThis, int minLevel);

int DasIO_getLogLvl(const DasIO* pThis);

const char* LogLvl_string(int logLevel);


/* Identifies the size of task for producing a stream, in arbitrary units. 
 * 
 * This number is used to generate a relative progress position, and also as
 * a weight if several Das2 Streams (implicitly of similar type) are combined.
 * See setTaskProgress().
 * 
 * @memberof DasIO
 */
ErrorCode DasIO_setTaskSize(DasIO* pThis, int size);

ErrorCode DasIO_setTaskProgress( DasIO* pThis, int progress );

void DasIO_throwException(
   DasIO* pThis, StreamDesc* pSd, const char* type, char* msg
);

void DasIO_close(DasIO* pThis);

int DasIO_printf(DasIO* pThis, const char* format, ...);

int DasIO_write(DasIO* pThis, const char* data, int length);

int DasIO_read(DasIO* pThis, DasBuf* pBuf, size_t nBytes);

int DasIO_getc(DasIO* pThis);



#endif /* _das2_io_h_ */

---