- moved algorithm definitions from payloads to corresponding transforms
[strongswan.git] / Source / charon / network / 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 #include <network/host.h>
29
30
31 typedef struct packet_t packet_t;
32 /**
33 * @brief UDP-Packet, contains data, sender and receiver
34 */
35 struct packet_t {
36
37 /**
38 * source address structure
39 */
40 host_t *source;
41
42 /**
43 * destination address structure
44 */
45 host_t *destination;
46
47 /**
48 * message data
49 */
50 chunk_t data;
51
52 /**
53 * @brief Clones a packet_t object
54 *
55 * @param packet calling object
56 * @param clone pointer to a packet_t object pointer where the new object is stored
57 * @return - SUCCESS if successful
58 * - OUT_OF_RES
59 */
60 status_t (*clone) (packet_t *packet, packet_t **clone);
61
62 /**
63 * @brief destroy the packet, freeing contained data
64 *
65 * @param packet packet to destroy
66 * @return - SUCCESS
67 */
68 status_t (*destroy) (packet_t *packet);
69 };
70
71 /**
72 * @brief create an empty packet
73 *
74 * @return - NULL when family not supported
75 */
76 packet_t *packet_create();
77
78 #endif /*PACKET_H_*/