8e5f9e9f8b1a9c8bf9fb7da9a64e4f6e5b2453bb
[strongswan.git] / 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 size_t sockaddr_len;
46
47 /**
48 * source address structure
49 */
50 struct sockaddr source;
51
52 /**
53 * destination address structure
54 */
55 struct sockaddr destination;
56
57 /**
58 * message data
59 */
60 chunk_t data;
61
62 /**
63 * @brief set destination of packet, using address string
64 *
65 * @param address ip address string
66 * @param port port number
67 * @return SUCCESS
68 * NOT_SUPPORTED
69 */
70 status_t (*set_destination) (packet_t *packet, char *address, u_int16_t port);
71
72 /**
73 * @brief set destination of packet, using address string
74 *
75 * @param address ip address string
76 * @param port port number
77 * @return SUCCESS
78 * NOT_SUPPORTED
79 */
80 status_t (*set_source) (packet_t *packet, char *address, u_int16_t port);
81
82 /**
83 * @brief destroy the packet, freeing contained data
84 *
85 * @param packet packet to destroy
86 * @return SUCCESS
87 */
88 status_t (*destroy) (packet_t *packet);
89 };
90
91 /**
92 * @brief create an empty packet
93 *
94 * @param family address-family, such as AF_INET
95 * @return NULL when family not supported
96 */
97 packet_t *packet_create(int family);
98
99 #endif /*PACKET_H_*/