AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::HTTPContentFetcherInterface::Header Struct Reference

#include <HTTPContentFetcherInterface.h>

Public Member Functions

 Header ()

Public Attributes

bool successful
avsCommon::utils::http::HTTPResponseCode responseCode
 The HTTP status code received. More...
std::string contentType
 The value of the Content-Type HTTP header. More...
ssize_t contentLength
 The value of the Content-Length HTTP header. More...

Detailed Description

A struct that represents the header that was retrieved from the HTTP connection. Objects that receive this struct are responsible for checking if the successful field is true before reading the other fields.

Constructor & Destructor Documentation

◆ Header()

alexaClientSDK::avsCommon::sdkInterfaces::HTTPContentFetcherInterface::Header::Header ( )

Member Data Documentation

◆ contentLength

ssize_t alexaClientSDK::avsCommon::sdkInterfaces::HTTPContentFetcherInterface::Header::contentLength

The value of the Content-Length HTTP header.

◆ contentType

std::string alexaClientSDK::avsCommon::sdkInterfaces::HTTPContentFetcherInterface::Header::contentType

The value of the Content-Type HTTP header.

◆ responseCode

avsCommon::utils::http::HTTPResponseCode alexaClientSDK::avsCommon::sdkInterfaces::HTTPContentFetcherInterface::Header::responseCode

The HTTP status code received.

◆ successful

bool alexaClientSDK::avsCommon::sdkInterfaces::HTTPContentFetcherInterface::Header::successful

If false, there was an error retrieving the header. For instance, the content fetcher may have reached a timeout waiting for the server. If this field's value is false, all other field values should be ignored.

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0