/*
 * libdivecomputer
 *
 * Copyright (C) 2023 Jef Driesen
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA
 */

#ifndef DC_PACKET_H
#define DC_PACKET_H

#include <libdivecomputer/common.h>
#include <libdivecomputer/context.h>
#include <libdivecomputer/iostream.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/**
 * Create a packet I/O stream layered on top of another base I/O stream.
 *
 * This layered I/O allows reading and writing a byte stream from the
 * underlying packet oriented transport. It changes the packet oriented
 * base transport into a stream oriented transport.
 *
 * @param[out]  iostream    A location to store the packet I/O stream.
 * @param[in]   context     A valid context.
 * @param[in]   base        A valid I/O stream.
 * @param[in]   isize       The input packet size in bytes.
 * @param[in]   osize       The output packet size in bytes.
 * @returns #DC_STATUS_SUCCESS on success, or another #dc_status_t code
 * on failure.
 */
dc_status_t
dc_packet_open (dc_iostream_t **iostream, dc_context_t *context, dc_iostream_t *base, size_t isize, size_t osize);

#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* DC_PACKET_H */