AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::utils::http2::HTTP2ResponseSinkInterface Class Referenceabstract

#include <HTTP2ResponseSinkInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::utils::http2::HTTP2ResponseSinkInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~HTTP2ResponseSinkInterface ()=default
 
virtual bool onReceiveResponseCode (long responseCode)=0
 
virtual bool onReceiveHeaderLine (const std::string &line)=0
 
virtual HTTP2ReceiveDataStatus onReceiveData (const char *bytes, size_t size)=0
 
virtual void onResponseFinished (HTTP2ResponseFinishedStatus status)=0
 

Detailed Description

Interface for consuming data returned from an HTTP2RequestInterface.

Constructor & Destructor Documentation

◆ ~HTTP2ResponseSinkInterface()

virtual alexaClientSDK::avsCommon::utils::http2::HTTP2ResponseSinkInterface::~HTTP2ResponseSinkInterface ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ onReceiveData()

virtual HTTP2ReceiveDataStatus alexaClientSDK::avsCommon::utils::http2::HTTP2ResponseSinkInterface::onReceiveData ( const char *  bytes,
size_t  size 
)
pure virtual

Notification of receipt of body data in an HTTP2 response.

Note
Calls to this method may block network operations for the associated instance of HTTP2ConnectionInterface, so they should return quickly.
Parameters
bytesThe buffer containing the bytes to consume.
sizeThe number of bytes to consume.
Returns
Status of the operation.
See also
HTTP2ReceiveDataStatus.

Implemented in alexaClientSDK::avsCommon::utils::http2::HTTP2MimeResponseDecoder.

◆ onReceiveHeaderLine()

virtual bool alexaClientSDK::avsCommon::utils::http2::HTTP2ResponseSinkInterface::onReceiveHeaderLine ( const std::string &  line)
pure virtual

Notification than an HTTP header line was received.

Note
Calls to this method may block network operations for the associated instance of HTTP2ConnectionInterface, so they should return quickly.
Parameters
lineThe HTTP response header line that was received.
Returns
Whether receipt of the response should continue.

Implemented in alexaClientSDK::avsCommon::utils::http2::HTTP2MimeResponseDecoder.

◆ onReceiveResponseCode()

virtual bool alexaClientSDK::avsCommon::utils::http2::HTTP2ResponseSinkInterface::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
responseCodeThe response code received for the request.
Returns
Whether receipt of the response should continue.

Implemented in alexaClientSDK::avsCommon::utils::http2::HTTP2MimeResponseDecoder.

◆ onResponseFinished()

virtual void alexaClientSDK::avsCommon::utils::http2::HTTP2ResponseSinkInterface::onResponseFinished ( HTTP2ResponseFinishedStatus  status)
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
statusThe status with which receiving the response finished.
See also
HTTP2ResponseFinishedStatus.

Implemented in alexaClientSDK::avsCommon::utils::http2::HTTP2MimeResponseDecoder.


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

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0