libtins  3.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Classes | Public Member Functions | Static Public Attributes | List of all members
Tins::SNAP Class Reference

Represents a SNAP frame. More...

#include <snap.h>

Inheritance diagram for Tins::SNAP:
Tins::PDU

Public Member Functions

 SNAP ()
 Creates an instance of SNAP This constructor sets the dsap and ssap fields to 0xaa, and the id field to 3.
 
 SNAP (const uint8_t *buffer, uint32_t total_sz)
 Constructs a SNAP object from a buffer and adds all identifiable PDUs found in the buffer as children of this one. More...
 
void control (uint8_t new_control)
 Setter for the Control field. More...
 
void org_code (small_uint< 24 > new_org)
 Setter for the Organization Code field. More...
 
void eth_type (uint16_t new_eth)
 Setter for the Ethernet Type field. More...
 
uint8_t dsap () const
 Getter for the DSAP field. More...
 
uint8_t ssap () const
 Getter for the SSAP field. More...
 
uint8_t control () const
 Getter for the Control field. More...
 
small_uint< 24 > org_code () const
 Getter for the Organization Code field. More...
 
uint16_t eth_type () const
 Getter for the Ethernet Type field. More...
 
uint32_t header_size () const
 Returns the SNAP frame's header length. More...
 
PDUType pdu_type () const
 Getter for the PDU's type. More...
 
SNAPclone () const
 Clones this PDU. More...
 
- Public Member Functions inherited from Tins::PDU
 PDU ()
 Default constructor.
 
 PDU (PDU &&rhs) TINS_NOEXCEPT
 Move constructor. More...
 
PDUoperator= (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...
 
PDUinner_pdu () const
 Getter for the inner PDU. More...
 
PDUrelease_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 void send (PacketSender &sender, const NetworkInterface &iface)
 Send the stack of PDUs through a PacketSender. More...
 
virtual PDUrecv_response (PacketSender &sender, const NetworkInterface &iface)
 Receives a matching response for this packet. More...
 
virtual bool matches_response (const uint8_t *ptr, uint32_t total_sz) const
 Check whether ptr points to a valid response for this PDU. More...
 
virtual bool matches_flag (PDUType flag) const
 Check whether this PDU matches the specified flag. More...
 

Static Public Attributes

static const PDU::PDUType pdu_flag = PDU::SNAP
 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, DOT1Q, PPPOE, STP,
  PPI, IPSEC_AH, IPSEC_ESP, PKTAP,
  MPLS, 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). More...
 
virtual void prepare_for_serialize (const PDU *parent)
 Prepares this PDU for serialization. More...
 
void serialize (uint8_t *buffer, uint32_t total_sz, const PDU *parent)
 Serializes this PDU and propagates this action to child PDUs. More...
 

Detailed Description

Represents a SNAP frame.

Note that this PDU contains the 802.3 LLC structure + SNAP frame. So far only unnumbered information structure is supported.

Constructor & Destructor Documentation

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

Constructs a SNAP object from a buffer and adds all identifiable PDUs found in the buffer as children of this one.

If the next PDU is not recognized, then a RawPDU is used.

If there is not enough size for a SNAP header in the buffer, a malformed_packet exception is thrown.

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

Member Function Documentation

SNAP* Tins::SNAP::clone ( ) const
inlinevirtual

Clones this PDU.

See Also
PDU::clone

Implements Tins::PDU.

void Tins::SNAP::control ( uint8_t  new_control)

Setter for the Control field.

Parameters
new_idThe new Control to be set.
uint8_t Tins::SNAP::control ( ) const
inline

Getter for the Control field.

Returns
The Control field.
uint8_t Tins::SNAP::dsap ( ) const
inline

Getter for the DSAP field.

Returns
The DSAP field.
void Tins::SNAP::eth_type ( uint16_t  new_eth)

Setter for the Ethernet Type field.

Parameters
new_ethThe new Ethernet Type to be set.
uint16_t Tins::SNAP::eth_type ( ) const
inline

Getter for the Ethernet Type field.

Returns
The Ethernet Type field.
uint32_t Tins::SNAP::header_size ( ) const
virtual

Returns the SNAP frame's header length.

Returns
The header's size.
See Also
PDU::header_size()

Implements Tins::PDU.

void Tins::SNAP::org_code ( small_uint< 24 >  new_org)

Setter for the Organization Code field.

Parameters
new_orgThe new Organization Code to be set.
small_uint<24> Tins::SNAP::org_code ( ) const
inline

Getter for the Organization Code field.

Returns
The Organization Code field.
PDUType Tins::SNAP::pdu_type ( ) const
inlinevirtual

Getter for the PDU's type.

See Also
PDU::pdu_type

Implements Tins::PDU.

uint8_t Tins::SNAP::ssap ( ) const
inline

Getter for the SSAP field.

Returns
The SSAP field.

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