Class representing an IEEE 802.3 PDU. More...

#include <dot3.h>

Inheritance diagram for Tins::Dot3:

Public Types
typedef HWAddress< 6 >	address_type
	The address type.

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

Public Member Functions
	Dot3 (const address_type &dst_hw_addr=address_type(), const address_type &src_hw_addr=address_type())
	Constructor for creating an Dot3 PDU. More...

	Dot3 (const uint8_t *buffer, uint32_t total_sz)
	Constructs a Dot3 object from a buffer and adds a LLC object with the remaining data as the inner PDU. More...

address_type	dst_addr () const
	Getter for the destination hardware address. More...

address_type	src_addr () const
	Getter for the source hardware address. More...

uint16_t	length () const
	Getter for the length field. More...

void	dst_addr (const address_type &address)
	Setter for the destination hardware address. More...

void	src_addr (const address_type &address)
	Setter for the source hardware address. More...

void	length (uint16_t value)
	Setter for the length field. More...

uint32_t	header_size () const
	Returns the Dot3 frame's header length. More...

void	send (PacketSender &sender, const NetworkInterface &iface)

bool	matches_response (const uint8_t *ptr, uint32_t total_sz) const
	Check whether ptr points to a valid response for this PDU. More...

PDU *	recv_response (PacketSender &sender, const NetworkInterface &iface)

PDUType	pdu_type () const
	Getter for the PDU's type. More...

Dot3 *	clone () const

Public Member Functions inherited from Tins::PDU
	PDU ()
	Default constructor.

	PDU (PDU &&rhs) TINS_NOEXCEPT
	Move constructor. More...

PDU &	operator= (PDU &&rhs) TINS_NOEXCEPT
	Move assignment operator. More...

virtual	~PDU ()
	PDU destructor. More...

virtual uint32_t	trailer_size () const
	Trailer's size. More...

uint32_t	size () const
	The whole chain of PDU's size, including this one. More...

virtual uint32_t	advertised_size () const
	The whole chain of PDU's advertised size, including this one. More...

PDU *	inner_pdu () const
	Getter for the inner PDU. More...

PDU *	parent_pdu () const

PDU *	release_inner_pdu ()
	Releases the inner PDU. More...

void	inner_pdu (PDU *next_pdu)
	Sets the child PDU. More...

void	inner_pdu (const PDU &next_pdu)
	Sets the child PDU. More...

serialization_type	serialize ()
	Serializes the whole chain of PDU's, including this one. More...

template<typename T >
T *	find_pdu (PDUType type=T::pdu_flag)
	Finds and returns the first PDU that matches the given flag. More...

template<typename T >
const T *	find_pdu (PDUType type=T::pdu_flag) const
	Finds and returns the first PDU that matches the given flag. More...

template<typename T >
T &	rfind_pdu (PDUType type=T::pdu_flag)
	Finds and returns the first PDU that matches the given flag. More...

template<typename T >
const T &	rfind_pdu (PDUType type=T::pdu_flag) const
	Finds and returns the first PDU that matches the given flag. More...

virtual bool	matches_flag (PDUType flag) const
	Check whether this PDU matches the specified flag. More...

Static Public Member Functions
static metadata	extract_metadata (const uint8_t *buffer, uint32_t total_sz)
	Extracts metadata for this protocol based on the buffer provided. More...

Static Public Attributes
static const PDU::PDUType	pdu_flag = PDU::IEEE802_3
	This PDU's flag.

static const address_type	BROADCAST
	Represents the Dot3 broadcast address.

Static Public Attributes inherited from Tins::PDU
static const endian_type	endianness = BE

Additional Inherited Members
Protected Member Functions inherited from Tins::PDU
	PDU (const PDU &other)
	Copy constructor.

PDU &	operator= (const PDU &other)
	Copy assignment operator.

void	copy_inner_pdu (const PDU &pdu)
	Copy other PDU's inner PDU(if any). More...

virtual void	prepare_for_serialize ()
	Prepares this PDU for serialization. More...

void	serialize (uint8_t *buffer, uint32_t total_sz)
	Serializes this PDU and propagates this action to child PDUs. More...

Detailed Description

Class representing an IEEE 802.3 PDU.

Constructor & Destructor Documentation

◆ Dot3() [1/2]

Tins::Dot3::Dot3	(	const address_type &	dst_hw_addr = `address_type()`,
		const address_type &	src_hw_addr = `address_type()`
	)

Constructor for creating an Dot3 PDU.

Constructor that builds an Dot3 PDU taking the interface name, destination's and source's MAC.

Parameters

dst_hw_addr	The destination hardware address.
src_hw_addr	The source hardware address.
child	The PDU which will be set as the inner PDU.

◆ Dot3() [2/2]

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

Constructs a Dot3 object from a buffer and adds a LLC object with the remaining data as the inner PDU.

If there is not enough size for a Dot3 header, a malformed_packet exception is thrown.

Parameters

buffer	The buffer from which this PDU will be constructed.
total_sz	The total size of the buffer.

Member Function Documentation

◆ clone()

Dot3* Tins::Dot3::clone ( ) const

inlinevirtual

See also: PDU::clone

Implements Tins::PDU.

◆ dst_addr() [1/2]

address_type Tins::Dot3::dst_addr ( ) const

inline

Getter for the destination hardware address.

Returns: The destination hardware address.

◆ dst_addr() [2/2]

void Tins::Dot3::dst_addr ( const address_type & address )

Setter for the destination hardware address.

Parameters

address The new destination hardware address.

◆ extract_metadata()

PDU::metadata Tins::Dot3::extract_metadata	(	const uint8_t *	buffer,
		uint32_t	total_sz
	)

static

Extracts metadata for this protocol based on the buffer provided.

Parameters

buffer	Pointer to a buffer
total_sz	Size of the buffer pointed by buffer

◆ header_size()

uint32_t Tins::Dot3::header_size ( ) const

virtual

Returns the Dot3 frame's header length.

Returns: An uint32_t with the header's size.

See also: PDU::header_size()

Implements Tins::PDU.

◆ length() [1/2]

uint16_t Tins::Dot3::length ( ) const

inline

Getter for the length field.

Returns: The length field value.

◆ length() [2/2]

void Tins::Dot3::length ( uint16_t value )

Setter for the length field.

Parameters

value The new value for the length field

◆ matches_response()

bool Tins::Dot3::matches_response	(	const uint8_t *	ptr,
		uint32_t	total_sz
	)		const

virtual

Check whether ptr points to a valid response for this PDU.

See also: PDU::matches_response

Parameters

ptr	The pointer to the buffer.
total_sz	The size of the buffer.

Reimplemented from Tins::PDU.

◆ pdu_type()

PDUType Tins::Dot3::pdu_type ( ) const

inlinevirtual

Getter for the PDU's type.

See also: PDU::pdu_type

Implements Tins::PDU.

◆ recv_response()

PDU * Tins::Dot3::recv_response	(	PacketSender &	sender,
		const NetworkInterface &	iface
	)

virtual

See also: PDU::recv_response

Reimplemented from Tins::PDU.

◆ send()

void Tins::Dot3::send	(	PacketSender &	sender,
		const NetworkInterface &	iface
	)

virtual

See also: PDU::send()

Reimplemented from Tins::PDU.

◆ src_addr() [1/2]

address_type Tins::Dot3::src_addr ( ) const

inline

Getter for the source hardware address.

Returns: The source hardware address.

◆ src_addr() [2/2]

void Tins::Dot3::src_addr ( const address_type & address )

Setter for the source hardware address.

Parameters

address The new source hardware address.

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

/builddir/build/BUILD/libtins-4.5/include/tins/dot3.h
/builddir/build/BUILD/libtins-4.5/src/dot3.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Dot3() [1/2]

◆ Dot3() [2/2]

Member Function Documentation

◆ clone()

◆ dst_addr() [1/2]

◆ dst_addr() [2/2]

◆ extract_metadata()

◆ header_size()

◆ length() [1/2]

◆ length() [2/2]

◆ matches_response()

◆ pdu_type()

◆ recv_response()

◆ send()

◆ src_addr() [1/2]

◆ src_addr() [2/2]