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 #include <freeswan.h>
  35 #include <pluto/constants.h>
  36 #include <pluto/defs.h>
  37
  38
  39 /**
  40  * @brief UDP-Packet, contains data, sender and receiver
  41  */
  42 typedef struct packet_s packet_t;
  43 struct packet_s {
  44         /**
  45          * Address family, such as AF_INET
  46          */
  47         int family;
  48         size_t sockaddr_len;
  49
  50         /**
  51          * source address structure
  52          */
  53         struct sockaddr source;
  54
  55         /**
  56          * destination address structure
  57          */
  58         struct sockaddr destination;
  59
  60          /**
  61           * message data
  62           */
  63         chunk_t data;
  64
  65         /**
  66          * @brief                       set destination of packet, using address string
  67          *
  68          * @param address       ip address string
  69          * @param port          port number
  70          * @return                      SUCCESS
  71          *                                      NOT_SUPPORTED
  72          */
  73         status_t (*set_destination) (packet_t *packet, char *address, u_int16_t port);
  74
  75         /**
  76          * @brief                       set destination of packet, using address string
  77          *
  78          * @param address       ip address string
  79          * @param port          port number
  80          * @return                      SUCCESS
  81          *                                      NOT_SUPPORTED
  82          */
  83         status_t (*set_source) (packet_t *packet, char *address, u_int16_t port);
  84
  85         /**
  86          * @brief                       destroy the packet, freeing contained data
  87          *
  88          * @param packet        packet to destroy
  89          * @return                      SUCCESS
  90          */
  91         status_t (*destroy) (packet_t *packet);
  92 };
  93
  94 /**
  95  * @brief create an empty packet
  96  *
  97  * @param family                address-family, such as AF_INET
  98  * @return                      NULL when family not supported
  99  */
 100 packet_t *packet_create(int family);
 101
 102 #endif /*PACKET_H_*/