Source/charon/packet.h

   1 /**
   2  * @file packet.h
   3  *
   4  * @brief UDP-Packet, contains data, sender and receiver.
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2005 Jan Hutter, Martin Willi
  10  * Hochschule fuer Technik Rapperswil
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the
  14  * Free Software Foundation; either version 2 of the License, or (at your
  15  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  */
  22
  23 #ifndef PACKET_H_
  24 #define PACKET_H_
  25
  26
  27 #include <types.h>
  28 #include <utils/host.h>
  29
  30
  31
  32 /**
  33  * @brief UDP-Packet, contains data, sender and receiver
  34  */
  35 typedef struct packet_s packet_t;
  36 struct packet_s {
  37
  38         /**
  39          * source address structure
  40          */
  41         host_t *source;
  42
  43         /**
  44          * destination address structure
  45          */
  46         host_t *destination;
  47
  48          /**
  49           * message data
  50           */
  51         chunk_t data;
  52
  53         /**
  54          * @brief                       Clones a packet_t object
  55          *
  56          * @param packet                calling object
  57          * @param clone         pointer to a packet_t object pointer where the new object is stored
  58          * @return                      - SUCCESS if successful
  59          *                                      - OUT_OF_RES
  60          */
  61         status_t (*clone) (packet_t *packet, packet_t **clone);
  62
  63         /**
  64          * @brief                       destroy the packet, freeing contained data
  65          *
  66          * @param packet        packet to destroy
  67          * @return                      - SUCCESS
  68          */
  69         status_t (*destroy) (packet_t *packet);
  70 };
  71
  72 /**
  73  * @brief create an empty packet
  74  *
  75  * @param family                address-family, such as AF_INET
  76  * @return                      - NULL when family not supported
  77  */
  78 packet_t *packet_create();
  79
  80 #endif /*PACKET_H_*/