/* Chrysalide - Outil d'analyse de fichiers binaires
 * packed.h - prototypes pour le regroupement de bribes de paquets réseau
 *
 * Copyright (C) 2017 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  Chrysalide is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Chrysalide 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Chrysalide.  If not, see <http://www.gnu.org/licenses/>.
 */


#ifndef _COMMON_PACKED_H
#define _COMMON_PACKED_H


#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>


#include "io.h"



/* Rassemblement de données d'un paquet */
typedef struct _packed_buffer
{
    uint8_t *data;                          /* Données à traiter           */
    size_t allocated;                       /* Taille allouée              */

    size_t used;                            /* Quantité de données utiles  */
    size_t pos;                             /* Tête de lecture/écriture    */

} packed_buffer;


/* Initialise un paquet réseau pour une constitution. */
void init_packed_buffer(packed_buffer *);

/* Réinitialise un paquet réseau pour une constitution. */
void reset_packed_buffer(packed_buffer *);

/* Efface les données contenues par un paquet réseau. */
void exit_packed_buffer(packed_buffer *);

/* Indique le nombre d'octets de la charge utile d'un paquet. */
size_t get_packed_buffer_payload_length(const packed_buffer *);

/* Ajoute des données à un paquet en amont à un envoi. */
bool extend_packed_buffer(packed_buffer *, const void *, size_t, bool);

/* Récupère des données depuis un paquet après une réception. */
bool extract_packed_buffer(packed_buffer *, void *, size_t, bool);

/* Lit des données depuis un flux local. */
bool read_packed_buffer(packed_buffer *, int);

/* Ecrit des données dans un flux local. */
bool write_packed_buffer(packed_buffer *, int);

/* Réceptionne des données depuis un flux réseau. */
bool recv_packed_buffer(packed_buffer *, int);

/* Envoie des données au travers un flux réseau. */
bool send_packed_buffer(packed_buffer *, int);



#endif  /* _COMMON_PACKED_H */