# UInt16ListAttribute

<a id="uint16listattribute"></a>

# UInt16ListAttribute

```cpp
#include <icy/stun/attributes.h>

class UInt16ListAttribute
```

[Defined in src/stun/include/icy/stun/attributes.h:425](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L425)

> **Inherits:** [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute)

Implements a STUN/TURN attribute that holds a list of attribute type codes. Used by the UNKNOWN-ATTRIBUTES attribute (RFC 5389 section 15.9).

## List of all members

| Name | Kind | Owner |
|------|------|-------|
| [`UInt16ListAttribute`](#uint16listattribute-1) | `function` | Declared here |
| [`UInt16ListAttribute`](#uint16listattribute-2) | `function` | Declared here |
| [`~UInt16ListAttribute`](#uint16listattribute-3) | `function` | Declared here |
| [`clone`](#clone-18) | `function` | Declared here |
| [`size`](#size-16) | `function` | Declared here |
| [`getType`](#gettype) | `function` | Declared here |
| [`setType`](#settype) | `function` | Declared here |
| [`addType`](#addtype) | `function` | Declared here |
| [`read`](#read-13) | `function` | Declared here |
| [`write`](#write-42) | `function` | Declared here |
| [`_attrTypes`](#_attrtypes) | `variable` | Declared here |
| [`~Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute-1) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`clone`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#clone-12) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`read`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#read-7) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`write`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#write-36) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`type`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#type-17) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`size`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#size-12) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`paddingBytes`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#paddingbytes) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`paddedBytes`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#paddedbytes) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`consumePadding`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#consumepadding) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`writePadding`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#writepadding) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`typeString`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#typestring) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`TypeID`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#typeid) | `variable` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`create`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#create-10) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`paddingBytes`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#paddingbytes-1) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`paddedBytes`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#paddedbytes-1) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`typeString`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#typestring-1) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`_type`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#_type-1) | `variable` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`_size`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#_size-3) | `variable` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute-2) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`setLength`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#setlength) | `function` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |
| [`Type`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#type-18) | `enum` | Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) |

## Inherited from [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute)

| Kind | Name | Description |
|------|------|-------------|
| `function` | [`~Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute-1) `virtual` `inline` |  |
| `function` | [`clone`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#clone-12) `virtual` | Returns a deep copy of this attribute. |
| `function` | [`read`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#read-7) `virtual` | Reads the body (not the type or size) for this type of attribute from the given buffer. |
| `function` | [`write`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#write-36) `virtual` `const` | Writes the body (not the type or size) to the given buffer. |
| `function` | [`type`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#type-17) `const` |  |
| `function` | [`size`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#size-12) `const` |  |
| `function` | [`paddingBytes`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#paddingbytes) `const` `inline` |  |
| `function` | [`paddedBytes`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#paddedbytes) `const` `inline` |  |
| `function` | [`consumePadding`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#consumepadding) `const` | Advances the reader past any 4-byte alignment padding that follows this attribute's body. |
| `function` | [`writePadding`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#writepadding) `const` | Writes zero-fill padding bytes to align this attribute to a 4-byte boundary. |
| `function` | [`typeString`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#typestring)  |  |
| `variable` | [`TypeID`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#typeid) `static` `constexpr` |  |
| `function` | [`create`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#create-10) `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`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#paddingbytes-1) `static` `inline` `constexpr` | Returns the 4-byte alignment padding required for a body of `size` bytes. |
| `function` | [`paddedBytes`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#paddedbytes-1) `static` `inline` `constexpr` | Returns the body length including 4-byte alignment padding. |
| `function` | [`typeString`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#typestring-1) `static` |  |
| `variable` | [`_type`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#_type-1)  |  |
| `variable` | [`_size`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#_size-3)  |  |
| `function` | [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute-2)  |  |
| `function` | [`setLength`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#setlength)  | Updates the stored body length. |
| `enum` | [`Type`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#type-18)  |  |

## Public Methods

| Return | Name | Description |
|--------|------|-------------|
|  | [`UInt16ListAttribute`](#uint16listattribute-1)  |  |
|  | [`UInt16ListAttribute`](#uint16listattribute-2)  | Copy constructor; duplicates the type list. |
|  | [`~UInt16ListAttribute`](#uint16listattribute-3) `virtual` |  |
| std::unique_ptr< [`Attribute`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) > | [`clone`](#clone-18) `virtual` `override` | Returns a deep copy of this attribute. |
| `size_t` | [`size`](#size-16) `const` |  |
| `uint16_t` | [`getType`](#gettype) `const` | Returns the type code at the given list position. |
| `void` | [`setType`](#settype)  | Overwrites the type code at the given list position. |
| `void` | [`addType`](#addtype)  | Appends a type code to the list and updates the attribute size. |
| `void` | [`read`](#read-13) `virtual` `override` | Reads the body (not the type or size) for this type of attribute from the given buffer. |
| `void` | [`write`](#write-42) `virtual` `const` `override` | Writes the body (not the type or size) to the given buffer. |

---

<a id="uint16listattribute-1"></a>

### UInt16ListAttribute

```cpp
UInt16ListAttribute(uint16_t type, uint16_t size)
```

[Defined in src/stun/include/icy/stun/attributes.h:430](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L430)

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `type` | `uint16_t` | Wire type code for the concrete attribute. |
| `size` | `uint16_t` | Initial body length in bytes. |

---

<a id="uint16listattribute-2"></a>

### UInt16ListAttribute

```cpp
UInt16ListAttribute(const UInt16ListAttribute & r)
```

[Defined in src/stun/include/icy/stun/attributes.h:433](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L433)

Copy constructor; duplicates the type list.

---

<a id="uint16listattribute-3"></a>

### ~UInt16ListAttribute

`virtual`

```cpp
virtual ~UInt16ListAttribute()
```

[Defined in src/stun/include/icy/stun/attributes.h:434](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L434)

---

<a id="clone-18"></a>

### clone

`virtual` `override`

```cpp
virtual std::unique_ptr< Attribute > clone() override
```

[Defined in src/stun/include/icy/stun/attributes.h:437](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L437)

Returns a deep copy of this attribute.

#### Reimplements

- [`Attribute::clone`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#clone-12)

---

<a id="size-16"></a>

### size

`const`

```cpp
size_t size() const
```

[Defined in src/stun/include/icy/stun/attributes.h:440](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L440)

#### Returns
Number of attribute type codes in the list.

---

<a id="gettype"></a>

### getType

`const`

```cpp
uint16_t getType(int index) const
```

[Defined in src/stun/include/icy/stun/attributes.h:445](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L445)

Returns the type code at the given list position. 
#### Returns
[Attribute](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) type code at `index`.

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `index` | `int` | Zero-based list index. |

---

<a id="settype"></a>

### setType

```cpp
void setType(int index, uint16_t value)
```

[Defined in src/stun/include/icy/stun/attributes.h:450](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L450)

Overwrites the type code at the given list position.

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `index` | `int` | Zero-based list index. |
| `value` | `uint16_t` | New attribute type code. |

---

<a id="addtype"></a>

### addType

```cpp
void addType(uint16_t value)
```

[Defined in src/stun/include/icy/stun/attributes.h:454](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L454)

Appends a type code to the list and updates the attribute size.

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `value` | `uint16_t` | [Attribute](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#attribute) type code to append. |

---

<a id="read-13"></a>

### read

`virtual` `override`

```cpp
virtual void read(BitReader & reader) override
```

[Defined in src/stun/include/icy/stun/attributes.h:456](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L456)

Reads the body (not the type or size) for this type of attribute from the given buffer.

#### Reimplements

- [`Attribute::read`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#read-7)

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `reader` | [`BitReader`](https://auscaster.com/icey/docs/api-reference/icy-BitReader.md#bitreader) & | Source bit reader positioned at the attribute body. |

---

<a id="write-42"></a>

### write

`virtual` `const` `override`

```cpp
virtual void write(BitWriter & writer) const override
```

[Defined in src/stun/include/icy/stun/attributes.h:457](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L457)

Writes the body (not the type or size) to the given buffer.

#### Reimplements

- [`Attribute::write`](https://auscaster.com/icey/docs/api-reference/icy-stun-Attribute.md#write-36)

#### Parameters

| Parameter | Type | Description |
|-----------|------|-------------|
| `writer` | [`BitWriter`](https://auscaster.com/icey/docs/api-reference/icy-BitWriter.md#bitwriter) & | Destination bit writer. |

## Private Attributes

| Return | Name | Description |
|--------|------|-------------|
| `std::vector< uint16_t >` | [`_attrTypes`](#_attrtypes)  |  |

---

<a id="_attrtypes"></a>

### _attrTypes

```cpp
std::vector< uint16_t > _attrTypes
```

[Defined in src/stun/include/icy/stun/attributes.h:460](https://github.com/auscaster/icey/blob/main/src/stun/include/icy/stun/attributes.h#L460)