libtins 4.5
Loading...
Searching...
No Matches
Tins::VXLAN Class Reference

Represents a VXLAN PDU. More...

#include <vxlan.h>

Inheritance diagram for Tins::VXLAN:
Tins::PDU

Public Member Functions

 VXLAN (const small_uint< 24 > vni=0)
 Constructs a VXLAN PDU.
 
 VXLAN (const uint8_t *buffer, uint32_t total_sz)
 Constructs a VXLAN object from a buffer and adds the Ethernet II PDU.
 
uint8_t get_flags () const
 Getter for the flags.
 
small_uint< 24 > get_vni () const
 Getter for the VNI.
 
void set_flags (uint8_t new_flags)
 Setter for the flags.
 
void set_vni (small_uint< 24 > new_vni)
 Setter for the VNI.
 
uint32_t header_size () const
 Returns the VXLAN frame's header length.
 
PDUType pdu_type () const
 Getter for the PDU's type.
 
VXLANclone () const
 
- Public Member Functions inherited from Tins::PDU
 PDU ()
 Default constructor.
 
 PDU (PDU &&rhs) TINS_NOEXCEPT
 Move constructor.
 
PDUoperator= (PDU &&rhs) TINS_NOEXCEPT
 Move assignment operator.
 
virtual ~PDU ()
 PDU destructor.
 
virtual uint32_t trailer_size () const
 Trailer's size.
 
uint32_t size () const
 The whole chain of PDU's size, including this one.
 
virtual uint32_t advertised_size () const
 The whole chain of PDU's advertised size, including this one.
 
PDUinner_pdu () const
 Getter for the inner PDU.
 
PDUparent_pdu () const
 
PDUrelease_inner_pdu ()
 Releases the inner PDU.
 
void inner_pdu (PDU *next_pdu)
 Sets the child PDU.
 
void inner_pdu (const PDU &next_pdu)
 Sets the child PDU.
 
serialization_type serialize ()
 Serializes the whole chain of PDU's, including this one.
 
template<typename T >
T * find_pdu (PDUType type=T::pdu_flag)
 Finds and returns the first PDU that matches the given flag.
 
template<typename T >
const T * find_pdu (PDUType type=T::pdu_flag) const
 Finds and returns the first PDU that matches the given flag.
 
template<typename T >
T & rfind_pdu (PDUType type=T::pdu_flag)
 Finds and returns the first PDU that matches the given flag.
 
template<typename T >
const T & rfind_pdu (PDUType type=T::pdu_flag) const
 Finds and returns the first PDU that matches the given flag.
 
virtual void send (PacketSender &sender, const NetworkInterface &iface)
 Send the stack of PDUs through a PacketSender.
 
virtual PDUrecv_response (PacketSender &sender, const NetworkInterface &iface)
 Receives a matching response for this packet.
 
virtual bool matches_response (const uint8_t *ptr, uint32_t total_sz) const
 Check whether ptr points to a valid response for this PDU.
 
virtual bool matches_flag (PDUType flag) const
 Check whether this PDU matches the specified flag.
 

Static Public Attributes

static const PDU::PDUType pdu_flag = PDU::VXLAN
 This PDU's flag.
 
- Static Public Attributes inherited from Tins::PDU
static const endian_type endianness = BE
 

Additional Inherited Members

- Public Types inherited from Tins::PDU
enum  endian_type { BE , LE }
 
enum  PDUType {
  RAW , ETHERNET_II , IEEE802_3 , DOT3 = IEEE802_3 ,
  RADIOTAP , DOT11 , DOT11_ACK , DOT11_ASSOC_REQ ,
  DOT11_ASSOC_RESP , DOT11_AUTH , DOT11_BEACON , DOT11_BLOCK_ACK ,
  DOT11_BLOCK_ACK_REQ , DOT11_CF_END , DOT11_DATA , DOT11_CONTROL ,
  DOT11_DEAUTH , DOT11_DIASSOC , DOT11_END_CF_ACK , DOT11_MANAGEMENT ,
  DOT11_PROBE_REQ , DOT11_PROBE_RESP , DOT11_PS_POLL , DOT11_REASSOC_REQ ,
  DOT11_REASSOC_RESP , DOT11_RTS , DOT11_QOS_DATA , LLC ,
  SNAP , IP , ARP , TCP ,
  UDP , ICMP , BOOTP , DHCP ,
  EAPOL , RC4EAPOL , RSNEAPOL , DNS ,
  LOOPBACK , IPv6 , ICMPv6 , SLL ,
  DHCPv6 , DOT1AD , DOT1Q , PPPOE ,
  STP , PPI , IPSEC_AH , IPSEC_ESP ,
  PKTAP , MPLS , DOT11_CONTROL_TA , VXLAN ,
  UNKNOWN = 999 , USER_DEFINED_PDU = 1000
}
 Enum which identifies each type of PDU. More...
 
typedef byte_array serialization_type
 
- Protected Member Functions inherited from Tins::PDU
 PDU (const PDU &other)
 Copy constructor.
 
PDUoperator= (const PDU &other)
 Copy assignment operator.
 
void copy_inner_pdu (const PDU &pdu)
 Copy other PDU's inner PDU(if any).
 
virtual void prepare_for_serialize ()
 Prepares this PDU for serialization.
 
void serialize (uint8_t *buffer, uint32_t total_sz)
 Serializes this PDU and propagates this action to child PDUs.
 

Detailed Description

Represents a VXLAN PDU.

This class represents a VXLAN PDU.

See also
RawPDU

Constructor & Destructor Documentation

◆ VXLAN() [1/2]

Tins::VXLAN::VXLAN ( const small_uint< 24 > vni = 0)

Constructs a VXLAN PDU.

Parameters
vniVXLAN Network Identifier.

◆ VXLAN() [2/2]

Tins::VXLAN::VXLAN ( const uint8_t * buffer,
uint32_t total_sz )

Constructs a VXLAN object from a buffer and adds the Ethernet II PDU.

Parameters
bufferThe buffer from which this PDU will be constructed.
total_szThe total size of the buffer.

Member Function Documentation

◆ clone()

VXLAN * Tins::VXLAN::clone ( ) const
inlinevirtual
See also
PDU::clone

Implements Tins::PDU.

◆ header_size()

uint32_t Tins::VXLAN::header_size ( ) const
inlinevirtual

Returns the VXLAN frame's header length.

This method overrides PDU::header_size. This size includes the payload and options size.

Returns
An uint32_t with the header's size.
See also
PDU::header_size

Implements Tins::PDU.

◆ pdu_type()

PDUType Tins::VXLAN::pdu_type ( ) const
inlinevirtual

Getter for the PDU's type.

See also
PDU::pdu_type

Implements Tins::PDU.

◆ set_flags()

void Tins::VXLAN::set_flags ( uint8_t new_flags)
inline

Setter for the flags.

Parameters
new_flagsThe new flags.

◆ set_vni()

void Tins::VXLAN::set_vni ( small_uint< 24 > new_vni)
inline

Setter for the VNI.

Parameters
new_vniThe new VNI.

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