AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::avsCommon::utils::libcurlUtils::HttpPut Class Reference

LIBCURL based implementation of HttpPutInterface. More...

#include <HttpPut.h>

Inheritance diagram for alexaClientSDK::avsCommon::utils::libcurlUtils::HttpPut:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::avsCommon::utils::libcurlUtils::HttpPut:
Collaboration graph
[legend]

Public Member Functions

 ~HttpPut ()=default
 
 HttpPut (const HttpPut &rhs)=delete
 
HttpPutoperator= (const HttpPut &rhs)=delete
 
HTTPResponse doPut (const std::string &url, const std::vector< std::string > &headers, const std::string &data) override
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::utils::libcurlUtils::HttpPutInterface
virtual ~HttpPutInterface ()=default
 Virtual destructor to assure proper cleanup of derived types. More...
 

Static Public Member Functions

static std::unique_ptr< HttpPutcreate ()
 

Detailed Description

LIBCURL based implementation of HttpPutInterface.

Constructor & Destructor Documentation

◆ ~HttpPut()

alexaClientSDK::avsCommon::utils::libcurlUtils::HttpPut::~HttpPut ( )
default

HttpPut destructor

◆ HttpPut()

alexaClientSDK::avsCommon::utils::libcurlUtils::HttpPut::HttpPut ( const HttpPut rhs)
delete

Deleted copy constructor.

Parameters
rhsThe 'right hand side' to not copy.

Member Function Documentation

◆ create()

static std::unique_ptr<HttpPut> alexaClientSDK::avsCommon::utils::libcurlUtils::HttpPut::create ( )
static

Create a new HttpPut instance, passing ownership of the new instance on to the caller.

Returns
Returns an std::unique_ptr to the new HttpPut instance, or nullptr of the operation failed.

◆ doPut()

HTTPResponse alexaClientSDK::avsCommon::utils::libcurlUtils::HttpPut::doPut ( const std::string &  url,
const std::vector< std::string > &  headers,
const std::string &  data 
)
overridevirtual

Perform an HTTP Put request returning the response body as a string. This method blocks for the duration of the request.

Parameters
urlThe URL to send the PUT to.
headersvector of strings to add in the header.
dataThe PUT data to send in the request.
Returns
An object describing the response to the PUT request.

Implements alexaClientSDK::avsCommon::utils::libcurlUtils::HttpPutInterface.

◆ operator=()

HttpPut& alexaClientSDK::avsCommon::utils::libcurlUtils::HttpPut::operator= ( const HttpPut rhs)
delete

Deleted assignment operator.

Parameters
rhsThe 'right hand side' to not copy.
Returns
The object assigned to.

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

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