#include <MessageRequest.h>

Inheritance diagram for alexaClientSDK::avsCommon::avs::MessageRequest:

[legend]

Classes
struct	EventHeaders
	A struct to hold event namespace and name. More...

struct	NamedReader
	A struct to hold an `AttachmentReader` alongside its name. More...

Public Types
using	MessageRequestResolveFunction = std::function< bool(const std::shared_ptr< EditableMessageRequest > &req, const std::string &resolveKey)>

Public Member Functions
	MessageRequest (const std::string &jsonContent, const std::string &uriPathExtension="", const unsigned int threshold=0, const std::string &streamMetricName="")

	MessageRequest (const std::string &jsonContent, const unsigned int threshold, const std::string &streamMetricName)

	MessageRequest (const std::string &jsonContent, bool isSerialized, const std::string &uriPathExtension="", std::vector< std::pair< std::string, std::string >> headers={}, MessageRequestResolveFunction resolver=nullptr, const unsigned int threshold=0, const std::string &streamMetricName="")

	MessageRequest (const MessageRequest &messageRequest)

virtual	~MessageRequest ()

void	addAttachmentReader (const std::string &name, std::shared_ptr< attachment::AttachmentReader > attachmentReader)

std::string	getJsonContent () const

bool	getIsSerialized () const

std::string	getUriPathExtension () const

int	attachmentReadersCount () const

std::shared_ptr< NamedReader >	getAttachmentReader (size_t index) const

virtual void	responseStatusReceived (avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status status)

virtual void	sendCompleted (avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status status)

virtual void	exceptionReceived (const std::string &exceptionMessage)

void	addObserver (std::shared_ptr< avsCommon::sdkInterfaces::MessageRequestObserverInterface > observer)

void	removeObserver (std::shared_ptr< avsCommon::sdkInterfaces::MessageRequestObserverInterface > observer)

EventHeaders	retrieveEventHeaders () const

const std::vector< std::pair< std::string, std::string > > &	getHeaders () const

bool	isResolved () const

std::shared_ptr< MessageRequest >	resolveRequest (const std::string &resolveKey) const

unsigned int	getStreamBytesThreshold () const

std::string	getStreamMetricName () const

Protected Attributes
std::mutex	m_observerMutex
	Mutex to guard access of m_observers. More...

std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::MessageRequestObserverInterface > >	m_observers
	Set of observers of MessageRequestObserverInterface. More...

std::string	m_jsonContent
	The JSON content to be sent to AVS. More...

bool	m_isSerialized
	True if sending this message must be serialized with sending other serialized messages. More...

std::string	m_uriPathExtension
	The path extension to be appended to the base URL when sending. More...

std::vector< std::shared_ptr< NamedReader > >	m_readers
	The AttachmentReaders of the Attachments data to be sent to AVS. More...

std::vector< std::pair< std::string, std::string > >	m_headers
	Optional headers to send with this request to AVS. More...

MessageRequestResolveFunction	m_resolver
	Resolver function to resolve current message request to a valid state. Null if message is already resolved. More...

std::string	m_streamMetricName
	The name for the stream byte metric. More...

unsigned int	m_streamBytesThreshold
	The threshold for the number of bytes for when we should record the stream metric. More...

Detailed Description

This is a wrapper class which allows a client to send a Message to AVS, and be notified when the attempt to send the Message was completed.

Member Typedef Documentation

◆ MessageRequestResolveFunction

using alexaClientSDK::avsCommon::avs::MessageRequest::MessageRequestResolveFunction = std::function<bool(const std::shared_ptr<EditableMessageRequest>& req, const std::string& resolveKey)>

Function to resolve an editable message request based on the provided resolveKey by updating the MessageRequest.

Parameters

[in,out]	req	Target editable request message that will be modified in place.
	resolveKey	Key used to resolve the message request

Returns: true if resolving successfully, else @ false

Note: This function need to be thread-safe, and is allowed to block.

Constructor & Destructor Documentation

◆ MessageRequest() [1/4]

alexaClientSDK::avsCommon::avs::MessageRequest::MessageRequest	(	const std::string &	jsonContent,
		const std::string &	uriPathExtension = `""`,
		const unsigned int	threshold = `0`,
		const std::string &	streamMetricName = `""`
	)

Constructor.

Parameters

jsonContent	The message to be sent to AVS.
uriPathExtension	An optional uri path extension which will be appended to the base url of the AVS. endpoint. If not specified, the default AVS path extension should be used by the sender implementation.
threshold.	An optional threshold to ACL to send the metric specified by streamMetricName. If this isn't specified no metric will be recorded.
streamMetricName.	An optional metric name for ACL to submit when the threshold is met. If this isn't specified no metric will be recorded.

◆ MessageRequest() [2/4]

alexaClientSDK::avsCommon::avs::MessageRequest::MessageRequest	(	const std::string &	jsonContent,
		const unsigned int	threshold,
		const std::string &	streamMetricName
	)

Constructor.

Parameters

jsonContent	The message to be sent to AVS.
threshold.	A required threshold to ACL to send the metric specified by streamMetricName.
streamMetricName.	A required metric name for ACL to submit when the threshold is met.

◆ MessageRequest() [3/4]

alexaClientSDK::avsCommon::avs::MessageRequest::MessageRequest	(	const std::string &	jsonContent,
		bool	isSerialized,
		const std::string &	uriPathExtension = `""`,
		std::vector< std::pair< std::string, std::string >>	headers = `{}`,
		MessageRequestResolveFunction	resolver = `nullptr`,
		const unsigned int	threshold = `0`,
		const std::string &	streamMetricName = `""`
	)

Constructor.

Parameters

jsonContent	The message to be sent to AVS.
isSerialized	True if sending this message must be serialized with sending other serialized messages.
uriPathExtension	An optional uri path extension which will be appended to the base url of the AVS.
headers	key/value pairs of extra HTTP headers to use with this request. endpoint. If not specified, the default AVS path extension should be used by the sender implementation.
resolver	Function to resolve message. Null if message doesn't need resolving. Resolving function aims to support the use case that one message request will be sent to multiple places with some fields having different values for different destinations. In such use cases, `MessageRequest` works as a container with all required info to build different versions of requests. The resolving function contains the logic to build the target message request based on the info in the original request, and provided resolveKey.
threshold.	An optional threshold to ACL to send the metric specified by streamMetricName. If this isn't specified no metric will be recorded.
streamMetricName.	An optional metric name for ACL to submit when the threshold is met. If this isn't specified no metric will be recorded.

◆ MessageRequest() [4/4]

alexaClientSDK::avsCommon::avs::MessageRequest::MessageRequest ( const MessageRequest & messageRequest )

Constructor to construct a MessageRequest which contains a copy of the data in MessageRequest.

Parameters

messageRequest MessageRequest to copy from

Note: Observers are not considered data and don't get copied by this constructor.

◆ ~MessageRequest()

virtual alexaClientSDK::avsCommon::avs::MessageRequest::~MessageRequest ( )

virtual

Destructor.

Member Function Documentation

◆ addAttachmentReader()

void alexaClientSDK::avsCommon::avs::MessageRequest::addAttachmentReader	(	const std::string &	name,
		std::shared_ptr< attachment::AttachmentReader >	attachmentReader
	)

Adds an attachment reader to the message. The attachment data will be the next part in the message to be sent to AVS.

Note: : The order by which the message attachments sent to AVS is the one by which they have been added to it.

Parameters

name	The name of the message part containing the attachment data.
attachmentReader	The attachment data to be sent to AVS along with the message.

◆ addObserver()

void alexaClientSDK::avsCommon::avs::MessageRequest::addObserver ( std::shared_ptr< avsCommon::sdkInterfaces::MessageRequestObserverInterface > observer )

Add observer of MessageRequestObserverInterface.

Parameters

observer The observer to be added to the set.

◆ attachmentReadersCount()

int alexaClientSDK::avsCommon::avs::MessageRequest::attachmentReadersCount ( ) const

Gets the number of AttachmentReaders in this message.

Returns: The number of readers in this message.

◆ exceptionReceived()

virtual void alexaClientSDK::avsCommon::avs::MessageRequest::exceptionReceived ( const std::string & exceptionMessage )

virtual

This function will be called if AVS responds with an exception message to this message request being sent.

Parameters

exceptionMessage The exception message.

◆ getAttachmentReader()

std::shared_ptr<NamedReader> alexaClientSDK::avsCommon::avs::MessageRequest::getAttachmentReader ( size_t index ) const

Retrieves the ith AttachmentReader in the message.

Parameters

index The index of the AttachmentReader to retrieve.

Returns: NamedReader of the ith attachment in the message. A null pointer is returned when index is out of bound.

◆ getHeaders()

const std::vector<std::pair<std::string, std::string> >& alexaClientSDK::avsCommon::avs::MessageRequest::getHeaders ( ) const

Get additional HTTP headers for this request

Returns: key/value pairs of extra HTTP headers to use with this request.

◆ getIsSerialized()

bool alexaClientSDK::avsCommon::avs::MessageRequest::getIsSerialized ( ) const

Return true if sending this message must be serialized with sending other serialized messages.

Returns: True if sending this message must be serialized with sending other serialized messages.

◆ getJsonContent()

std::string alexaClientSDK::avsCommon::avs::MessageRequest::getJsonContent ( ) const

Retrieves the JSON content to be sent to AVS.

Returns: The JSON content to be sent to AVS.

◆ getStreamBytesThreshold()

unsigned int alexaClientSDK::avsCommon::avs::MessageRequest::getStreamBytesThreshold ( ) const

Get the stream bytes threshold, to determine when we should record the stream metric.

Returns: m_threshold

◆ getStreamMetricName()

std::string alexaClientSDK::avsCommon::avs::MessageRequest::getStreamMetricName ( ) const

Get the name for the bytes stream metric.

Returns: m_streamMetricName

◆ getUriPathExtension()

std::string alexaClientSDK::avsCommon::avs::MessageRequest::getUriPathExtension ( ) const

Retrieves the path extension to be appended to the base URL when sending.

Returns: The path extension to be appended to the base URL when sending.

◆ isResolved()

bool alexaClientSDK::avsCommon::avs::MessageRequest::isResolved ( ) const

Check whether message is resolved and ready to send.

Returns: true if message is already resolved, else false

◆ removeObserver()

void alexaClientSDK::avsCommon::avs::MessageRequest::removeObserver ( std::shared_ptr< avsCommon::sdkInterfaces::MessageRequestObserverInterface > observer )

Remove observer of MessageRequestObserverInterface.

Parameters

observer The observer to be removed from the set.

◆ resolveRequest()

std::shared_ptr<MessageRequest> alexaClientSDK::avsCommon::avs::MessageRequest::resolveRequest ( const std::string & resolveKey ) const

Resolve message to a valid message by updating the content of the message based on provided resolveKey

Parameters

resolveKey Key used to resolve message

Returns: New resolved MessageRequest

◆ responseStatusReceived()

virtual void alexaClientSDK::avsCommon::avs::MessageRequest::responseStatusReceived ( avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status status )

virtual

Called when the Response code is received.

Parameters

status The status of the response that was received.

◆ retrieveEventHeaders()

EventHeaders alexaClientSDK::avsCommon::avs::MessageRequest::retrieveEventHeaders ( ) const

Retrieve MessageRequest event headers (namespace and name).

Returns: EventHeaders containing the namespace and name.

◆ sendCompleted()

virtual void alexaClientSDK::avsCommon::avs::MessageRequest::sendCompleted ( avsCommon::sdkInterfaces::MessageRequestObserverInterface::Status status )

virtual

This is called once the send request has completed. The status parameter indicates success or failure.

Parameters

status Whether the send request succeeded or failed.

Reimplemented in alexaClientSDK::capabilityAgents::playbackController::PlaybackMessageRequest, alexaClientSDK::capabilityAgents::doNotDisturb::DNDMessageRequest, and alexaClientSDK::avsCommon::avs::WaitableMessageRequest.

Member Data Documentation

◆ m_headers

std::vector<std::pair<std::string, std::string> > alexaClientSDK::avsCommon::avs::MessageRequest::m_headers

protected

Optional headers to send with this request to AVS.

◆ m_isSerialized

bool alexaClientSDK::avsCommon::avs::MessageRequest::m_isSerialized

protected

True if sending this message must be serialized with sending other serialized messages.

◆ m_jsonContent

std::string alexaClientSDK::avsCommon::avs::MessageRequest::m_jsonContent

protected

The JSON content to be sent to AVS.

◆ m_observerMutex

std::mutex alexaClientSDK::avsCommon::avs::MessageRequest::m_observerMutex

protected

Mutex to guard access of m_observers.

◆ m_observers

std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::MessageRequestObserverInterface> > alexaClientSDK::avsCommon::avs::MessageRequest::m_observers

protected

Set of observers of MessageRequestObserverInterface.

◆ m_readers

std::vector<std::shared_ptr<NamedReader> > alexaClientSDK::avsCommon::avs::MessageRequest::m_readers

protected

The AttachmentReaders of the Attachments data to be sent to AVS.

◆ m_resolver

MessageRequestResolveFunction alexaClientSDK::avsCommon::avs::MessageRequest::m_resolver

protected

Resolver function to resolve current message request to a valid state. Null if message is already resolved.

◆ m_streamBytesThreshold

unsigned int alexaClientSDK::avsCommon::avs::MessageRequest::m_streamBytesThreshold

protected

The threshold for the number of bytes for when we should record the stream metric.

◆ m_streamMetricName

std::string alexaClientSDK::avsCommon::avs::MessageRequest::m_streamMetricName

protected

The name for the stream byte metric.

◆ m_uriPathExtension

std::string alexaClientSDK::avsCommon::avs::MessageRequest::m_uriPathExtension

protected

The path extension to be appended to the base URL when sending.

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

/workplace/avs-device-sdk/AVSCommon/AVS/include/AVSCommon/AVS/MessageRequest.h

Classes

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ MessageRequestResolveFunction

Constructor & Destructor Documentation

◆ MessageRequest() [1/4]

◆ MessageRequest() [2/4]

◆ MessageRequest() [3/4]

◆ MessageRequest() [4/4]

◆ ~MessageRequest()

Member Function Documentation

◆ addAttachmentReader()

◆ addObserver()

◆ attachmentReadersCount()

◆ exceptionReceived()

◆ getAttachmentReader()

◆ getHeaders()

◆ getIsSerialized()

◆ getJsonContent()

◆ getStreamBytesThreshold()

◆ getStreamMetricName()

◆ getUriPathExtension()

◆ isResolved()

◆ removeObserver()

◆ resolveRequest()

◆ responseStatusReceived()

◆ retrieveEventHeaders()

◆ sendCompleted()

Member Data Documentation

◆ m_headers

◆ m_isSerialized

◆ m_jsonContent

◆ m_observerMutex

◆ m_observers

◆ m_readers

◆ m_resolver

◆ m_streamBytesThreshold

◆ m_streamMetricName

◆ m_uriPathExtension