Module org.pcap4j.core

Package org.pcap4j.packet

Class Dot11SupportedRatesElement

java.lang.Object

org.pcap4j.packet.Dot11InformationElement

org.pcap4j.packet.Dot11AbstractSupportedRatesElement

org.pcap4j.packet.Dot11SupportedRatesElement

All Implemented Interfaces:

java.io.Serializable

public final class Dot11SupportedRatesElement
extends Dot11AbstractSupportedRatesElement

IEEE802.11 Supported Rates element

       1         1          0-8
 +----------+----------+-----------------
 |Element ID|  Length  | Supported Rates
 +----------+----------+-----------------
 Element ID: 1
 

The Supported Rates element specifies up to eight rates in the OperationalRateSet parameter, as described in the MLME-JOIN.request and MLME-START.request primitives, and zero or more BSS membership selectors. The Information field is encoded as 1 to 8 octets, where each octet describes a single Supported Rate or BSS membership selector. Within Beacon, Probe Response, Association Response, Reassociation Response, Mesh Peering Open, and Mesh Peering Confirm management frames, each Supported Rate contained in the BSSBasicRateSet parameter is encoded as an octet with the MSB (bit 7) set to 1, and bits 6 to 0 are set to the data rate, if necessary rounded up to the next 500kb/s, in units of 500 kb/s. Rates not contained in the BSSBasicRateSet parameter are encoded with the MSB set to 0, and bits 6 to 0 are set to the appropriate value. The MSB of each Supported Rate octet in other management frame types is ignored by receiving STAs. Within Beacon, Probe Response, Association Response, Reassociation Response, Mesh Peering Open, and Mesh Peering Confirm management frames, each BSS membership selector contained in the BSSMembershipSelectorSet parameter is encoded as an octet with the MSB (bit 7) set to 1, and bits 6 to 0 are set to the encoded value for the selector. A BSS membership selector that has the MSB (bit 7) set to 1 in the Supported Rates element is defined to be basic.

Since:

pcap4j 1.7.0

See Also:

IEEE802.11, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Dot11SupportedRatesElement.Builder

Nested classes/interfaces inherited from class org.pcap4j.packet.Dot11AbstractSupportedRatesElement

Dot11AbstractSupportedRatesElement.BssMembershipSelector, Dot11AbstractSupportedRatesElement.Datum, Dot11AbstractSupportedRatesElement.Rate

Field Summary

Fields

Modifier and Type	Field	Description
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Dot11SupportedRatesElement(byte[] rawData, int offset, int length)
private	Dot11SupportedRatesElement(Dot11SupportedRatesElement.Builder builder)

Method Summary

Modifier and Type	Method	Description
Dot11SupportedRatesElement.Builder	getBuilder()
java.lang.String	getElementName()
static Dot11SupportedRatesElement	newInstance(byte[] rawData, int offset, int length)	A static factory method.

Methods inherited from class org.pcap4j.packet.Dot11AbstractSupportedRatesElement

equals, getBssMembershipSelectors, getRates, getRawData, hashCode, length, toString, toString

Methods inherited from class org.pcap4j.packet.Dot11InformationElement

getElementId, getLength, getLengthAsInt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Dot11SupportedRatesElement

private Dot11SupportedRatesElement(byte[] rawData,
                                   int offset,
                                   int length)
                            throws IllegalRawDataException

Parameters:

rawData - rawData

offset - offset

length - length

Throws:

IllegalRawDataException - if parsing the raw data fails.

Dot11SupportedRatesElement

private Dot11SupportedRatesElement(Dot11SupportedRatesElement.Builder builder)

Parameters:

builder - builder

Method Detail

newInstance

public static Dot11SupportedRatesElement newInstance(byte[] rawData,
                                                     int offset,
                                                     int length)
                                              throws IllegalRawDataException

A static factory method. This method validates the arguments by ByteArrays.validateBounds(byte[], int, int), which may throw exceptions undocumented here.

Parameters:

rawData - rawData

offset - offset

length - length

Returns:

a new Dot11SupportedRatesElement object.

Throws:

IllegalRawDataException - if parsing the raw data fails.

getBuilder

public Dot11SupportedRatesElement.Builder getBuilder()

Specified by:

getBuilder in class Dot11AbstractSupportedRatesElement

Returns:

a new Builder object populated with this object's fields.

getElementName

public java.lang.String getElementName()

Specified by:

getElementName in class Dot11AbstractSupportedRatesElement

Returns:

element name