STUN module (rfc5389)
FlagAttribute
Implements a zero-length STUN/TURN flag attribute (presence implies the flag is set).
FlagAttribute
#include <icy/stun/attributes.h>class FlagAttributeDefined in src/stun/include/icy/stun/attributes.h:348
Inherits:
Attribute
Implements a zero-length STUN/TURN flag attribute (presence implies the flag is set).
List of all members
| Name | Kind | Owner |
|---|---|---|
FlagAttribute | function | Declared here |
clone | function | Declared here |
read | function | Declared here |
write | function | Declared here |
Size | 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 |
|---|---|---|
FlagAttribute | ||
std::unique_ptr< Attribute > | clone virtual override | Returns a deep copy of this attribute. |
void | read virtual inline override | No-op: flag attributes carry no body bytes. |
void | write virtual const inline override | No-op: flag attributes carry no body bytes. |
FlagAttribute
FlagAttribute(uint16_t type)Defined in src/stun/include/icy/stun/attributes.h:352
Parameters
typeWire type code for the concrete attribute.
clone
virtual override
virtual std::unique_ptr< Attribute > clone() overrideDefined in src/stun/include/icy/stun/attributes.h:355
Returns a deep copy of this attribute.
Reimplements
read
virtual inline override
virtual inline void read(BitReader &) overrideDefined in src/stun/include/icy/stun/attributes.h:360
No-op: flag attributes carry no body bytes.
Reimplements
write
virtual const inline override
virtual inline void write(BitWriter &) const overrideDefined in src/stun/include/icy/stun/attributes.h:363
No-op: flag attributes carry no body bytes.
Reimplements
Public Static Attributes
| Return | Name | Description |
|---|---|---|
constexpr uint16_t | Size static constexpr |
Size
static constexpr
constexpr uint16_t Size = 0