stream_priv.h

Go to the documentation of this file.

/* Copyright (C) 2026 Chris Piker <chris-piker@uiowa.edu>
 *
 * This file is part of das2C, the Core Das2 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_stream_priv_h_
#define _das_stream_priv_h_
 
#include <das3/stream.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Why aren't these functions public?
 *
 * The dataset builder (builder.c) is the only caller.  It shadows each
 * dataset into the reader's stream while the stream is open, so lookups by
 * packet ID work without the stream owning it, then hands ownership over
 * with takeDesc when the stream closes.  Together they equal
 * DasStream_addDesc() split in time.  Public, v3.0 would freeze that
 * half-owned state for everyone.  If a stream filter ever needs it, move it
 * to stream.h then; adding a function is a compatible change.
 */
 
DasErrCode DasStream_shadowDesc(DasStream* pThis, DasDesc* pDesc, int nPktId);
 
DasErrCode DasStream_takeDesc(DasStream* pThis, DasDesc* pDesc, int nPktId);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _das_stream_priv_h_ */