Source/charon/network/socket.h

   1 /**
   2  * @file socket.h
   3  *
   4  * @brief Interface for socket_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 SOCKET_H_
  24 #define SOCKET_H_
  25
  26
  27 #include <types.h>
  28 #include <network/packet.h>
  29
  30
  31 /**
  32  * @brief Maximum size of a packet.
  33  *
  34  * 3000 Bytes should be sufficient, see IKEv2 draft
  35  *
  36  * @ingroup network
  37  */
  38 #define MAX_PACKET 3000
  39
  40
  41 typedef struct socket_t socket_t;
  42
  43 /**
  44  * @brief Abstraction of one (ipv4), or in future, of multiple sockets.
  45  *
  46  * Receiver reads from here, sender writes to here.
  47  *
  48  * @ingroup network
  49  */
  50 struct socket_t {
  51         /**
  52          * @brief Receive a packet.
  53          *
  54          * reads a packet from one of the sockets.
  55          * source will be set, dest not implemented
  56          *
  57          *
  58          * @param sock                  socket_t object to work on
  59          * @param packet                pinter gets address from allocated packet_t
  60          * @return                              FAILED when unable to receive
  61          *                                              SUCCESS when packet successfully received
  62          */
  63         status_t (*receive) (socket_t *sock, packet_t **packet);
  64
  65         /**
  66          * @brief Send a packet.
  67          *
  68          * sends a packet via desired socket.
  69          * uses source and dest in packet.
  70          *
  71          * @param sock                  socket_t object to work on
  72          * @param packet[out]   packet_t to send
  73          * @return                              FAILED when unable to send
  74          *                                              SUCCESS when packet successfully sent
  75          */
  76         status_t (*send) (socket_t *sock, packet_t *packet);
  77
  78         /**
  79          * @brief Destroy sockets.
  80          *
  81          * close sockets and destroy socket_t object
  82          *
  83          * @param sock                  socket_t to destroy
  84          * @return                              SUCCESS
  85          */
  86         void (*destroy) (socket_t *sock);
  87 };
  88
  89 /**
  90  * @brief socket_t constructor.
  91  *
  92  * currently creates one socket, listening on all addresses
  93  * on port.
  94  *
  95  * @param port                          port to bind socket to
  96  * @return                              the created socket, or NULL on error
  97  *
  98  * @ingroup network
  99  */
 100 socket_t *socket_create(u_int16_t port);
 101
 102
 103 #endif /*SOCKET_H_*/