AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Utils::Event::EventEncoderStream Class Reference

#include <EventEncoderStream.h>

+ Inheritance diagram for Aws::Utils::Event::EventEncoderStream:

Public Member Functions

 EventEncoderStream (size_t bufferSize=DEFAULT_BUF_SIZE)
 
void SetSignatureSeed (const Aws::String &seed)
 
EventEncoderStreamWriteEvent (const Aws::Utils::Event::Message &msg)
 
void SetSigner (Aws::Client::AWSAuthSigner *signer)
 
void Close ()
 

Detailed Description

A buffered I/O stream that binary-encodes the bits written to it according to the AWS event-stream spec.

Definition at line 28 of file EventEncoderStream.h.

Constructor & Destructor Documentation

◆ EventEncoderStream()

Aws::Utils::Event::EventEncoderStream::EventEncoderStream ( size_t  bufferSize = DEFAULT_BUF_SIZE)
explicit

Creates a stream for encoding events sent by the client.

Parameters
bufferSizeThe length of the underlying buffer.

Member Function Documentation

◆ Close()

void Aws::Utils::Event::EventEncoderStream::Close ( )
inline

Allows a stream writer to communicate the end of the stream to a stream reader.

Any writes to the stream after this call are not guaranteed to be read by another concurrent read thread.

Definition at line 61 of file EventEncoderStream.h.

◆ SetSignatureSeed()

void Aws::Utils::Event::EventEncoderStream::SetSignatureSeed ( const Aws::String seed)
inline

Sets the signature seed used by event-stream events. Every event uses its previous event's signature to calculate its own signature. Setting this value affects the signature calculation of the first event.

Definition at line 43 of file EventEncoderStream.h.

◆ SetSigner()

void Aws::Utils::Event::EventEncoderStream::SetSigner ( Aws::Client::AWSAuthSigner signer)
inline

Sets the signer implementation used for every event.

Definition at line 53 of file EventEncoderStream.h.

◆ WriteEvent()

EventEncoderStream& Aws::Utils::Event::EventEncoderStream::WriteEvent ( const Aws::Utils::Event::Message msg)

Writes an event-stream message to the underlying buffer.


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