oob.h

Go to the documentation of this file.

/* Copyright (C) 2015-2026 Chris Piker <chris-piker@uiowa.edu>
 *
 * This file is part of das2C, the Core Das2 C Library.
 * 
 * Libdas2 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.
 *
 * Libdas2 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_out_of_band_h_
#define _das_out_of_band_h_
 
#include <das3/util.h>
#include <das3/buffer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum except_type {
   DAS_EX_UNKNOWN, DAS_EX_NO_DATA, DAS_EX_SERVER_ERR, DAS_EX_QUERY_ERR
} das_except_t;
 
DAS_API const char* das_except_toStr(das_except_t nType, int nDasVer);
 
DAS_API das_except_t das_except_fromStr(const char* sType);
 
typedef enum oob_type {OOB_EXCEPT, OOB_COMMENT} oob_t;
 
typedef struct out_of_band {
   oob_t pkttype;
   void (*clean)(struct out_of_band* pThis);
} OutOfBand;
 
DAS_API void OutOfBand_clean(OutOfBand* pThis);
 
 
typedef struct stream_exception {
   OutOfBand base;
   
   das_except_t nType;
   
   char* sMsg;
   size_t uMsgLen;
   
} OobExcept;
 
DAS_API void OobExcept_init(OobExcept* pThis);
 
DAS_API void OobExcept_set(OobExcept* pThis, das_except_t nType, const char* sMsg);
 
DAS_API const char* OobExcept_typeStr(const OobExcept* pThis);
 
DAS_API DasErrCode OobExcept_decode(OobExcept* pThis, DasBuf* str);
 
DAS_API DasErrCode OobExcept_encode(OobExcept* pThis, DasBuf* pBuf);
 
DAS_API DasErrCode OobExcept_encode3(OobExcept* pThis, DasBuf* pBuf);
 
 
typedef struct stream_comment{
   OutOfBand base;
   
   char* sType;
   size_t uTypeLen;
   
   char* sSrc;
   size_t uSrcLen;
   
   char* sVal;
   size_t uValLen;
} OobComment;
 
DAS_API void OobComment_init(OobComment* pThis);
 
DAS_API DasErrCode OobComment_encode(OobComment* pThis, DasBuf* pBuf);
 
DAS_API DasErrCode OobComment_encode3(OobComment* pThis, DasBuf* pBuf);
 
DAS_API DasErrCode OobComment_decode(OobComment* pThis, DasBuf* sbuf);
 
 
DAS_API DasErrCode OutOfBand_decode(DasBuf* pBuf, OutOfBand** ppObjs, int* which);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _das_out_of_band_h_ */