#include <Mqtt5Client.h>

Public Attributes
Crt::Optional< OutboundTopicAliasBehaviorType >	m_outboundBehavior

Crt::Optional< uint16_t >	m_outboundCacheMaxSize

Crt::Optional< InboundTopicAliasBehaviorType >	m_inboundBehavior

Crt::Optional< uint16_t >	m_inboundCacheMaxSize

Detailed Description

Configuration for all client topic aliasing behavior.

Member Data Documentation

◆ m_inboundBehavior

Crt::Optional<InboundTopicAliasBehaviorType> Aws::Crt::Mqtt5::TopicAliasingOptions::m_inboundBehavior

Controls whether or not the client allows the broker to use topic aliasing when sending publishes. Even if inbound topic aliasing is enabled, it is up to the server to choose whether or not to use it.

If left undefined, then inbound topic aliasing is disabled.

◆ m_inboundCacheMaxSize

Crt::Optional<uint16_t> Aws::Crt::Mqtt5::TopicAliasingOptions::m_inboundCacheMaxSize

If inbound topic aliasing is enabled, this will control the size of the inbound alias cache. If inbound aliases are enabled and this is zero or undefined, then a sensible default will be used (25). If inbound aliases are disabled, this setting has no effect.

Behaviorally, this value overrides anything present in the topic_alias_maximum field of the CONNECT packet options.

◆ m_outboundBehavior

Crt::Optional<OutboundTopicAliasBehaviorType> Aws::Crt::Mqtt5::TopicAliasingOptions::m_outboundBehavior

Controls what kind of outbound topic aliasing behavior the client should attempt to use.

If topic aliasing is not supported by the server, this setting has no effect and any attempts to directly manipulate the topic alias id in outbound publishes will be ignored.

If left undefined, then outbound topic aliasing is disabled.

◆ m_outboundCacheMaxSize

Crt::Optional<uint16_t> Aws::Crt::Mqtt5::TopicAliasingOptions::m_outboundCacheMaxSize

If outbound topic aliasing is set to LRU, this controls the maximum size of the cache. If outbound topic aliasing is set to LRU and this is zero or undefined, a sensible default is used (25). If outbound topic aliasing is not set to LRU, then this setting has no effect.

The final size of the cache is determined by the minimum of this setting and the value of the topic_alias_maximum property of the received CONNACK. If the received CONNACK does not have an explicit positive value for that field, outbound topic aliasing is disabled for the duration of that connection.

The documentation for this struct was generated from the following file: