aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/network/packet.h
diff options
context:
space:
mode:
authorMartin Willi <martin@strongswan.org>2005-11-29 08:08:03 +0000
committerMartin Willi <martin@strongswan.org>2005-11-29 08:08:03 +0000
commitdf3c59d0889a337eff9f994e92a5dc165ba1729f (patch)
tree7973747444155ea669e3f2dc1177b9b2eb3fc8a1 /Source/charon/network/packet.h
parented37dee61daf5bb272c04b79787da282abaa9447 (diff)
downloadstrongswan-df3c59d0889a337eff9f994e92a5dc165ba1729f.tar.bz2
strongswan-df3c59d0889a337eff9f994e92a5dc165ba1729f.tar.xz
- changed allocation behavior
Diffstat (limited to 'Source/charon/network/packet.h')
-rw-r--r--Source/charon/network/packet.h23
1 files changed, 12 insertions, 11 deletions
diff --git a/Source/charon/network/packet.h b/Source/charon/network/packet.h
index 2e41e8a6c..bc8d3f5b6 100644
--- a/Source/charon/network/packet.h
+++ b/Source/charon/network/packet.h
@@ -1,7 +1,7 @@
/**
* @file packet.h
*
- * @brief UDP-Packet, contains data, sender and receiver.
+ * @brief Interface of packet_t.
*
*/
@@ -30,7 +30,9 @@
typedef struct packet_t packet_t;
/**
- * @brief UDP-Packet, contains data, sender and receiver
+ * @brief Abstraction of an UDP-Packet, contains data, sender and receiver.
+ *
+ * @ingroup network
*/
struct packet_t {
@@ -50,28 +52,27 @@ struct packet_t {
chunk_t data;
/**
- * @brief Clones a packet_t object
+ * @brief Clones a packet_t object.
*
- * @param packet calling object
+ * @param packet calling object
* @param clone pointer to a packet_t object pointer where the new object is stored
- * @return - SUCCESS if successful
- * - OUT_OF_RES
*/
- status_t (*clone) (packet_t *packet, packet_t **clone);
+ packet_t* (*clone) (packet_t *packet);
/**
- * @brief destroy the packet, freeing contained data
+ * @brief Destroy the packet, freeing contained data.
*
* @param packet packet to destroy
- * @return - SUCCESS
*/
- status_t (*destroy) (packet_t *packet);
+ void (*destroy) (packet_t *packet);
};
/**
* @brief create an empty packet
*
- * @return - NULL when family not supported
+ * @return created packet_t object
+ *
+ * @ingroup network
*/
packet_t *packet_create();