UInt8Attribute
UInt8Attribute
#include <icy/stun/attributes.h>class UInt8AttributeDefined in src/stun/include/icy/stun/attributes.h:229
Inherits:
Attribute
Implements a STUN/TURN attribute that holds an 8-bit integer.
List of all members
| Name | Kind | Owner |
|---|---|---|
UInt8Attribute | function | Declared here |
UInt8Attribute | function | Declared here |
clone | function | Declared here |
value | function | Declared here |
setValue | function | Declared here |
getBit | function | Declared here |
setBit | function | Declared here |
read | function | Declared here |
write | function | Declared here |
Size | variable | Declared here |
_bits | variable | Declared here |
~Attribute | function | Inherited from Attribute |
clone | function | Inherited from Attribute |
read | function | Inherited from Attribute |
write | function | Inherited from Attribute |
type | function | Inherited from Attribute |
size | function | Inherited from Attribute |
paddingBytes | function | Inherited from Attribute |
paddedBytes | function | Inherited from Attribute |
consumePadding | function | Inherited from Attribute |
writePadding | function | Inherited from Attribute |
typeString | function | Inherited from Attribute |
TypeID | variable | Inherited from Attribute |
create | function | Inherited from Attribute |
paddingBytes | function | Inherited from Attribute |
paddedBytes | function | Inherited from Attribute |
typeString | function | Inherited from Attribute |
_type | variable | Inherited from Attribute |
_size | variable | Inherited from Attribute |
Attribute | function | Inherited from Attribute |
setLength | function | Inherited from Attribute |
Type | enum | Inherited from Attribute |
Inherited from Attribute
| Kind | Name | Description |
|---|---|---|
function | ~Attribute virtual inline | |
function | clone virtual | Returns a deep copy of this attribute. |
function | read virtual | Reads the body (not the type or size) for this type of attribute from the given buffer. |
function | write virtual const | Writes the body (not the type or size) to the given buffer. |
function | type const | |
function | size const | |
function | paddingBytes const inline | |
function | paddedBytes const inline | |
function | consumePadding const | Advances the reader past any 4-byte alignment padding that follows this attribute's body. |
function | writePadding const | Writes zero-fill padding bytes to align this attribute to a 4-byte boundary. |
function | typeString | |
variable | TypeID static constexpr | |
function | create static | Creates an attribute of the given wire type and body size. Returns nullptr if the type is unknown or the size is invalid. |
function | paddingBytes static inline constexpr | Returns the 4-byte alignment padding required for a body of size bytes. |
function | paddedBytes static inline constexpr | Returns the body length including 4-byte alignment padding. |
function | typeString static | |
variable | _type | |
variable | _size | |
function | Attribute | |
function | setLength | Updates the stored body length. |
enum | Type |
Public Methods
| Return | Name | Description |
|---|---|---|
UInt8Attribute | ||
UInt8Attribute | Copy constructor. | |
std::unique_ptr< Attribute > | clone virtual override | Returns a deep copy of this attribute. |
uint8_t | value const inline | |
void | setValue inline | Sets the stored 8-bit value. |
bool | getBit const | Returns the state of a single bit within the stored byte. |
void | setBit | Sets or clears a single bit within the stored byte. |
void | read virtual override | Reads the body (not the type or size) for this type of attribute from the given buffer. |
void | write virtual const override | Writes the body (not the type or size) to the given buffer. |
UInt8Attribute
UInt8Attribute(uint16_t type)Defined in src/stun/include/icy/stun/attributes.h:233
Parameters
typeWire type code for the concrete attribute.
UInt8Attribute
UInt8Attribute(const UInt8Attribute & r)Defined in src/stun/include/icy/stun/attributes.h:236
Copy constructor.
clone
virtual override
virtual std::unique_ptr< Attribute > clone() overrideDefined in src/stun/include/icy/stun/attributes.h:239
Returns a deep copy of this attribute.
Reimplements
value
const inline
inline uint8_t value() constDefined in src/stun/include/icy/stun/attributes.h:244
Returns
The stored 8-bit value.
setValue
inline
inline void setValue(uint8_t bits)Defined in src/stun/include/icy/stun/attributes.h:248
Sets the stored 8-bit value.
Parameters
bitsValue to store.
getBit
const
bool getBit(int index) constDefined in src/stun/include/icy/stun/attributes.h:253
Returns the state of a single bit within the stored byte.
Parameters
indexBit position (0 = LSB, 7 = MSB).
Returns
true if the bit is set.
setBit
void setBit(int index, bool value)Defined in src/stun/include/icy/stun/attributes.h:258
Sets or clears a single bit within the stored byte.
Parameters
indexBit position (0 = LSB, 7 = MSB).valuetrue to set, false to clear.
read
virtual override
virtual void read(BitReader & reader) overrideDefined in src/stun/include/icy/stun/attributes.h:260
Reads the body (not the type or size) for this type of attribute from the given buffer.
Parameters
readerSource bit reader positioned at the attribute body.
Reimplements
write
virtual const override
virtual void write(BitWriter & writer) const overrideDefined in src/stun/include/icy/stun/attributes.h:261
Writes the body (not the type or size) to the given buffer.
Parameters
writerDestination bit writer.
Reimplements
Public Static Attributes
| Return | Name | Description |
|---|---|---|
constexpr uint16_t | Size static constexpr |
Size
static constexpr
constexpr uint16_t Size = 1Defined in src/stun/include/icy/stun/attributes.h:241
Private Attributes
| Return | Name | Description |
|---|---|---|
uint8_t | _bits |
_bits
uint8_t _bits