Source/charon/network/packet.h

   1 /**
   2  * @file packet.h
   3  *
   4  * @brief Interface of packet_t.
   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 <network/host.h>
  29
  30
  31 typedef struct packet_t packet_t;
  32 /**
  33  * @brief Abstraction of an UDP-Packet, contains data, sender and receiver.
  34  *
  35  * @ingroup network
  36  */
  37 struct packet_t {
  38
  39         /**
  40          * source address structure
  41          */
  42         host_t *source;
  43
  44         /**
  45          * destination address structure
  46          */
  47         host_t *destination;
  48
  49          /**
  50           * message data
  51           */
  52         chunk_t data;
  53
  54         /**
  55          * @brief                       Clones a packet_t object.
  56          *
  57          * @param packet        calling object
  58          * @param clone         pointer to a packet_t object pointer where the new object is stored
  59          */
  60         packet_t* (*clone) (packet_t *packet);
  61
  62         /**
  63          * @brief                       Destroy the packet, freeing contained data.
  64          *
  65          * @param packet        packet to destroy
  66          */
  67         void (*destroy) (packet_t *packet);
  68 };
  69
  70 /**
  71  * @brief create an empty packet
  72  *
  73  * @return                      created packet_t object
  74  *
  75  * @ingroup network
  76  */
  77 packet_t *packet_create();
  78
  79 #endif /*PACKET_H_*/