io.h

Go to the documentation of this file.

/* Copyright (C) 2015-2024 Chris Piker <chris-piker@uiowa.edu>
 * Copyright (C) 2004-2006 Jeremy Faden <jeremy-faden@uiowa.edu> 
 *
 * This file is part of das2C, the Core Das C Library.
 * 
 * das2C is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * das2C is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 2.1 along with das2C; if not, see <http://www.gnu.org/licenses/>. 
 */
 
#ifndef _das_io_h_
#define _das_io_h_
 
#include <stdio.h>
#include <zlib.h>
/* #include <das3/stream.h> */
#include <das3/oob.h>
#include <das3/processor.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* 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, plus the tag style */
   int      model;      /* Expected datastructure types in the stream  */
 
   bool     compressed; /* 1 if stream is compressed or should be compressed */
 
   bool     bEmbedAsBytes; /* read-side: recover undecodable embedded formats as
                              opaque bytes instead of failing (DasIO_embedAsBytes) */
 
   int      mode;       /* STREAM_MODE_STRING, STREAM_MODE_FILE,
                         * STREAM_MODE_SOCKET, STREAM_MODE_SSL */
 
   char     sName[DASIO_NAME_SZ]; /* A human readable name for data source or sink */
   
   long int offset;     /* current offset for file reads */
 
   int      dasver;     /* Stream major version number, must be set explicitly for output */
   
   /* Socket I/O */
   int      nSockFd;    /* Socket file descriptor */
   
   /* SSL I/O */
   void*    pSsl;       /* OpenSSL connection */
   
   /* 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;
 
DAS_API DasIO* new_DasIO_cfile(const char* sProg, FILE* file, const char* mode);
 
DAS_API DasErrCode DasIO_model(DasIO* pThis, int nModel);
 
#define DasIO_getModel(P) (P->model)
 
DAS_API void DasIO_embedAsBytes(DasIO* pThis, bool bEnable);
 
 
DAS_API DasIO* new_DasIO_cmd(const char* sProg, const char* sCmd);
 
 
 
DAS_API DasIO* new_DasIO_file(const char* sProg, const char* sFile, const char* mode);
 
DAS_API DasIO* new_DasIO_socket(const char* sProg, int nSockFd, const char* mode);
 
DAS_API DasIO* new_DasIO_str(const char* sProg, char* sbuf, size_t len, const char* mode);
 
DAS_API DasIO* new_DasIO_ssl(const char* sProg, void* pSsl, const char* mode);
 
DAS_API void del_DasIO(DasIO* pThis);
 
 
 
DAS_API int DasIO_addProcessor(DasIO* pThis, StreamHandler* pProc);
 
DAS_API int DasIO_readAll(DasIO* pThis);
 
 
DAS_API DasErrCode DasIO_writeStreamDesc(DasIO* pThis, DasStream* pSd);
 
DAS_API DasErrCode DasIO_writePktDesc(DasIO* pThis, PktDesc* pd);
 
DAS_API DasErrCode DasIO_writeDesc(DasIO* pThis, DasDesc* pDesc, int iPktId);
 
DAS_API DasErrCode DasIO_writePktData(DasIO* pThis, PktDesc* pPd);
 
DasErrCode DasIO_writeData(DasIO* pThis, DasDesc* pDesc, int iPktId);
 
DAS_API DasErrCode DasIO_writeException(DasIO* pThis, OobExcept* pSe);
 
DAS_API DasErrCode 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
 
DAS_API DasErrCode DasIO_sendLog(DasIO* pThis, int level, char * msg, ... );
 
DAS_API void DasIO_setLogLvl(DasIO* pThis, int minLevel);
 
DAS_API int DasIO_getLogLvl(const DasIO* pThis);
 
DAS_API 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
 */
DAS_API DasErrCode DasIO_setTaskSize(DasIO* pThis, int size);
 
DAS_API DasErrCode DasIO_setTaskProgress( DasIO* pThis, int progress );
 
DAS_API void DasIO_throwException(
   DasIO* pThis, DasStream* pSd, das_except_t type, char* msg
);
 
DAS_API void DasIO_close(DasIO* pThis);
 
DAS_API int DasIO_serverExcept(DasIO* pThis, const char* fmt, ...);
 
DAS_API int DasIO_queryExcept(DasIO* pThis, const char* fmt, ...);
 
 
DAS_API int DasIO_closeNoData(DasIO* pThis, const char* fmt, ...);
 
DAS_API int DasIO_printf(DasIO* pThis, const char* format, ...);
 
DAS_API size_t DasIO_write(DasIO* pThis, const char* data, int length);
 
DAS_API int DasIO_read(DasIO* pThis, DasBuf* pBuf, size_t nBytes);
 
DAS_API int DasIO_readUntil(
   DasIO* pThis, DasBuf* pBuf, size_t nBytes, char cStop
);
 
DAS_API int DasIO_getc(DasIO* pThis);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _das_io_h_ */