oob.h

Go to the documentation of this file.

/* Copyright (C) 2015-2017 Chris Piker <chris-piker@uiowa.edu>
 *
 * This file is part of libdas2, 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 libdas2; if not, see <http://www.gnu.org/licenses/>. 
 */


/* Copyright 2003-2017 Chris Piker  <chris-piker@uiowa.edu>
 *                     Jeremy Faden <jeremy-faden@uiowa.edu>
 *
 * Licensed under the open source Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may 
 * obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


#ifndef _das_out_of_band_h_
#define _das_out_of_band_h_

#include <das2/util.h>
#include <das2/buffer.h>

#ifdef __cplusplus
extern "C" {
#endif

#define EXCEPTION_UNTYPED ""

#define DAS2_EXCEPT_NO_DATA_IN_INTERVAL "NoDataInInterval"
#define DAS2_EXCEPT_ILLEGAL_ARGUMENT    "IllegalArgument"
#define DAS2_EXCEPT_SERVER_ERROR        "ServerError"

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;

void OutOfBand_clean(OutOfBand* pThis);


typedef struct stream_exception {
   OutOfBand base;
   
   char* sType;      /* NoDataInInterval, Exception */
   size_t uTypeLen;
   
   char* sMsg;      /* May be altered by encode function to change " to ' */
   size_t uMsgLen;
   
} OobExcept;

void OobExcept_init(OobExcept* pThis);

void OobExcept_set(OobExcept* pThis, const char* sType, const char* sMsg);

DasErrCode OobExcept_decode(OobExcept* pThis, DasBuf* str);

DasErrCode OobExcept_encode(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;

void OobComment_init(OobComment* pThis);

DasErrCode OobComment_encode(OobComment* pThis, DasBuf* pBuf);

DasErrCode OobComment_decode(OobComment* pThis, DasBuf* sbuf);


DasErrCode OutOfBand_decode(DasBuf* pBuf, OutOfBand** ppObjs, int* which);

#ifdef __cplusplus
}
#endif

#endif /* _das_out_of_band_h_ */