alexaClientSDK::acl::MimeResponseStatusHandlerInterface Class Reference

#include <MimeResponseStatusHandlerInterface.h>

Inheritance diagram for alexaClientSDK::acl::MimeResponseStatusHandlerInterface:

Public Member Functions
virtual	~MimeResponseStatusHandlerInterface ()=default
virtual void	onActivity ()=0
virtual bool	onReceiveResponseCode (long responseCode)=0
virtual void	onResponseFinished (avsCommon::utils::http2::HTTP2ResponseFinishedStatus status, const std::string &nonMimeBody)=0

Detailed Description

Handle HTTP response codes and finished notifications for mime encoded responses from AVS.

Constructor & Destructor Documentation

~MimeResponseStatusHandlerInterface()

virtual alexaClientSDK::acl::MimeResponseStatusHandlerInterface::~MimeResponseStatusHandlerInterface ( )

virtualdefault

Destructor.

Member Function Documentation

onActivity()

virtual void alexaClientSDK::acl::MimeResponseStatusHandlerInterface::onActivity ( )

pure virtual

Notification of network activity between this client and AVS. (this is used to detect sustained inactivity requiring the send of a ping).

Implemented in alexaClientSDK::acl::MessageRequestHandler.

onReceiveResponseCode()

virtual bool alexaClientSDK::acl::MimeResponseStatusHandlerInterface::onReceiveResponseCode ( long  responseCode )

pure virtual

Notification that an HTTP response code was returned for the request.

Note

Calls to this method may block network operations for the associated instance of HTTP2ConnectionInterface, so they should return quickly.

Parameters

responseCode

The response code received for the request.

Returns

Whether receipt of the response should continue.

Implemented in alexaClientSDK::acl::MessageRequestHandler.

onResponseFinished()

virtual void alexaClientSDK::acl::MimeResponseStatusHandlerInterface::onResponseFinished ( avsCommon::utils::http2::HTTP2ResponseFinishedStatus  status, const std::string &  nonMimeBody  )

pure virtual

Notification that the request/response cycle has finished and no further notifications will be provided.

Note

Calls to this method may block network operations for the associated instance of HTTP2ConnectionInterface, so they should return quickly.

Parameters

status	The status included in the response.
nonMimeBody	The body of the reply (for non HTTPResponseCode::SUCCESS_OK responses)

Implemented in alexaClientSDK::acl::MessageRequestHandler.

---

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

• /workplace/avs-device-sdk/ACL/include/ACL/Transport/MimeResponseStatusHandlerInterface.h