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
  29 #include <sys/types.h>
  30 #include <sys/socket.h>
  31 #include <netinet/in.h>
  32 #include <arpa/inet.h>
  33 #include <stdlib.h>
  34
  35
  36 /**
  37  * @brief UDP-Packet, contains data, sender and receiver
  38  */
  39 typedef struct packet_s packet_t;
  40 struct packet_s {
  41         /**
  42          * Address family, such as AF_INET
  43          */
  44         int family;
  45
  46         /**
  47          *
  48          */
  49         size_t sockaddr_len;
  50
  51         /**
  52          * source address structure
  53          */
  54         struct sockaddr source;
  55
  56         /**
  57          * destination address structure
  58          */
  59         struct sockaddr destination;
  60
  61          /**
  62           * message data
  63           */
  64         chunk_t data;
  65
  66         /**
  67          * @brief                       set destination of packet, using address string
  68          *
  69          * @param packet                calling object
  70          * @param address       ip address string
  71          * @param port          port number
  72          * @return                      - SUCCESS
  73          *                                      - NOT_SUPPORTED
  74          */
  75         status_t (*set_destination) (packet_t *packet, char *address, u_int16_t port);
  76
  77         /**
  78          * @brief                       set destination of packet, using address string
  79          *
  80          * @param packet                calling object
  81          * @param address       ip address string
  82          * @param port          port number
  83          * @return                      - SUCCESS
  84          *                                      - NOT_SUPPORTED
  85          */
  86         status_t (*set_source) (packet_t *packet, char *address, u_int16_t port);
  87
  88         /**
  89          * @brief                       Clones a packet_t object
  90          *
  91          * @param packet                calling object
  92          * @param clone         pointer to a packet_t object pointer where the new object is stored
  93          * @return                      - SUCCESS if successful
  94          *                                      - OUT_OF_RES
  95          */
  96         status_t (*clone) (packet_t *packet, packet_t **clone);
  97
  98         /**
  99          * @brief                       destroy the packet, freeing contained data
 100          *
 101          * @param packet        packet to destroy
 102          * @return                      - SUCCESS
 103          */
 104         status_t (*destroy) (packet_t *packet);
 105 };
 106
 107 /**
 108  * @brief create an empty packet
 109  *
 110  * @param family                address-family, such as AF_INET
 111  * @return                      - NULL when family not supported
 112  */
 113 packet_t *packet_create(int family);
 114
 115 #endif /*PACKET_H_*/