Azure::Core::IO::BodyStream Class Reference

Used to read data to/from a service.

#include <body_stream.hpp>

Inheritance diagram for Azure::Core::IO::BodyStream:

Public Member Functions
virtual	~BodyStream ()=default
	Destructs BodyStream.
virtual int64_t	Length () const =0
	Get the length of the data.
virtual void	Rewind ()
	Resets the stream back to the beginning (for retries).
size_t	Read (uint8_t *buffer, size_t count, Azure::Core::Context const &context=Azure::Core::Context())
	Read portion of data into a buffer.
size_t	ReadToCount (uint8_t *buffer, size_t count, Azure::Core::Context const &context=Azure::Core::Context())
	Read Azure::Core::IO::BodyStream into a buffer until the buffer is filled, or until the stream is read to end.
std::vector< uint8_t >	ReadToEnd (Azure::Core::Context const &context=Azure::Core::Context())
	Read Azure::Core::IO::BodyStream until the stream is read to end, allocating memory for the entirety of contents.

Constructor & Destructor Documentation

~BodyStream()

virtual Azure::Core::IO::BodyStream::~BodyStream ( )

virtualdefault

Member Function Documentation

Length()

virtual int64_t Azure::Core::IO::BodyStream::Length ( ) const

pure virtual

Remarks

Used with the HTTP Content-Length header.

Implemented in Azure::Core::IO::MemoryBodyStream, Azure::Core::IO::FileBodyStream, and Azure::Core::IO::ProgressBodyStream.

Read()

size_t Azure::Core::IO::BodyStream::Read ( uint8_t *  buffer, size_t  count, Azure::Core::Context const &  context = Azure::Core::Context()  )

inline

Remarks

Throws if error/cancelled.

Parameters

buffer	Pointer to a first byte of the byte buffer to read the data into.
count	Size of the buffer to read the data into.
context	A context to control the request lifetime.

Returns

Number of bytes read.

ReadToCount()

size_t Azure::Core::IO::BodyStream::ReadToCount	(	uint8_t *	buffer,
		size_t	count,
		Azure::Core::Context const &	context = Azure::Core::Context()
	)

Parameters

buffer	Pointer to a first byte of the byte buffer to read the data into.
count	Size of the buffer to read the data into.
context	A context to control the request lifetime.

Returns

Number of bytes read.

ReadToEnd()

std::vector< uint8_t > Azure::Core::IO::BodyStream::ReadToEnd

(

Azure::Core::Context const &

context = Azure::Core::Context()

)

Parameters

context

A context to control the request lifetime.

Returns

A vector of bytes containing the entirety of data read from the body.

Rewind()

virtual void Azure::Core::IO::BodyStream::Rewind ( )

inlinevirtual

Remarks

Derived classes that send data in an HTTP request MUST override this and implement it properly.

Reimplemented in Azure::Core::IO::MemoryBodyStream, Azure::Core::IO::FileBodyStream, and Azure::Core::IO::ProgressBodyStream.

---

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

• inc/azure/core/io/body_stream.hpp