NetBurner 3.1
UDPPacket Class Reference

UDP Packet Class. More...

#include <udp.h>

Public Member Functions

 UDPPacket (OS_FIFO *pFifo, uint32_t timeout)
 Constructor to create a UDP Packet object from a UDP FIFO entry. More...
 
 UDPPacket (int sock)
 Constructor to create a UDP Packet object from an open UDP socket. More...
 
 UDPPacket (PoolPtr p)
 Constructor to create a UDP packet from a system pool buffer. More...
 
 UDPPacket (UDPPacket &pkt)
 Constructor to create a new UDP packet from an existing UDP packet. More...
 
 ~UDPPacket ()
 UDP packet object destructor. Frees any associated memory. More...
 
void SetSourcePort (uint16_t port)
 Set the source port number of a UDP Packet object. More...
 
uint16_t GetSourcePort (void) const
 Get the source port number of a UDP Packet object. More...
 
IPADDR4 GetSourceAddress4 (void)
 Get the source IPv4 address a UDP Packet object. More...
 
IPADDR4 GetDestinationAddress4 ()
 Get the destination IPv4 address a UDP Packet object. More...
 
MACADR GetMacSource ()
 Get the source MAC address a UDP Packet object. More...
 
IPADDR6 GetSourceAddress6 (void)
 Get the source IPv6 address a UDP Packet object. More...
 
IPADDR6 GetDestinationAddress6 ()
 Get the destination IPv6 address a UDP Packet object. More...
 
void SetDestinationPort (uint16_t)
 Set the destination port number of a UDP Packet object. More...
 
uint16_t GetDestinationPort (void) const
 Get the destination port number of a UDP Packet object. More...
 
puint8_t GetDataBuffer (bool bReAllocateIfNeeded=false)
 Get a pointer to the UDP Packet object's data buffer. More...
 
void SetDataSize (uint16_t numBytes)
 Set the UDP Packet data size. More...
 
uint16_t GetDataSize (void) const
 Get the UDP Packet object data size. More...
 
void AddData (puint8_t pData, uint16_t len)
 Add data to a UDP Packet object. More...
 
void AddData (PCSTR pData)
 Add data to a UDP Packet object as a NULL terminated ASCII string. More...
 
void AddDataWord (uint16_t w)
 Add a 16-bit unsigned integer to a UDP Packet object. More...
 
void AddDataByte (uint8_t b)
 Add an 8-bit unsigned integer to a UDP Packet object. More...
 
BOOL Validate (void)
 Verify a received UDP packet. More...
 
void ResetData (void)
 Set the data size of a UDP Packet object to 0.
 
void SendAndKeep4 (IPADDR4 destIP, uint8_t ttl=0)
 Make a copy of a UDP Packet and send it. The original packet will remain intact. More...
 
void Send4 (IPADDR4 destIP, uint8_t ttl=0)
 Send the UDP Packet and free the pool buffer. More...
 
void SendViaInterfaceNum4 (IPADDR4 destIP, int interface, uint8_t ttl=0)
 Send the UDP Packet using the specified interface, and free the pool buffer. More...
 
void SendAndKeep6 (const IPADDR6 &to, uint8_t ttl=0)
 Make a copy of a UDP Packet and send it. The original packet will remain intact. More...
 
void Send6 (const IPADDR6 &to, uint8_t ttl=0)
 Send the UDP Packet and free the pool buffer. More...
 
void SendViaInterfaceNum6 (const IPADDR6 &to, int interface, uint8_t ttl=0)
 Send the UDP Packet using the specified interface, and free the pool buffer. More...
 

Detailed Description

UDP Packet Class.


The documentation for this class was generated from the following files: