AWS SDK for C++  1.9.16
AWS SDK for C++
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Aws::Utils::Event::EventHeaderValue Class Reference

#include <EventHeader.h>

Public Types

enum  EventHeaderType {
  EventHeaderType::BOOL_TRUE = 0, EventHeaderType::BOOL_FALSE, EventHeaderType::BYTE, EventHeaderType::INT16,
  EventHeaderType::INT32, EventHeaderType::INT64, EventHeaderType::BYTE_BUF, EventHeaderType::STRING,
  EventHeaderType::TIMESTAMP, EventHeaderType::UUID, EventHeaderType::UNKNOWN
}
 

Public Member Functions

 EventHeaderValue ()=default
 
 EventHeaderValue (aws_event_stream_header_value_pair *header)
 
 EventHeaderValue (const Aws::String &s)
 
 EventHeaderValue (const ByteBuffer &bb)
 
 EventHeaderValue (ByteBuffer &&bb)
 
 EventHeaderValue (unsigned char byte)
 
 EventHeaderValue (bool b)
 
 EventHeaderValue (int16_t n)
 
 EventHeaderValue (int32_t n)
 
 EventHeaderValue (int64_t n, EventHeaderType type=EventHeaderType::INT64)
 
EventHeaderType GetType () const
 
bool GetEventHeaderValueAsBoolean () const
 
uint8_t GetEventHeaderValueAsByte () const
 
int16_t GetEventHeaderValueAsInt16 () const
 
int32_t GetEventHeaderValueAsInt32 () const
 
int64_t GetEventHeaderValueAsInt64 () const
 
ByteBuffer GetEventHeaderValueAsBytebuf () const
 
Aws::String GetEventHeaderValueAsString () const
 
int64_t GetEventHeaderValueAsTimestamp () const
 
Aws::Utils::UUID GetEventHeaderValueAsUuid () const
 
const ByteBufferGetUnderlyingBuffer () const
 

Static Public Member Functions

static EventHeaderType GetEventHeaderTypeForName (const Aws::String &name)
 
static Aws::String GetNameForEventHeaderType (EventHeaderType value)
 

Detailed Description

Interface of the header value of a message in event stream. Each type of header value should have it's own associated derived class based on this class.

Definition at line 28 of file EventHeader.h.

Member Enumeration Documentation

◆ EventHeaderType

Enumerator
BOOL_TRUE 
BOOL_FALSE 
BYTE 
INT16 
INT32 
INT64 
BYTE_BUF 
STRING 
TIMESTAMP 
UUID 
UNKNOWN 

Definition at line 31 of file EventHeader.h.

Constructor & Destructor Documentation

◆ EventHeaderValue() [1/10]

Aws::Utils::Event::EventHeaderValue::EventHeaderValue ( )
default

◆ EventHeaderValue() [2/10]

Aws::Utils::Event::EventHeaderValue::EventHeaderValue ( aws_event_stream_header_value_pair *  header)
inline

Definition at line 49 of file EventHeader.h.

◆ EventHeaderValue() [3/10]

Aws::Utils::Event::EventHeaderValue::EventHeaderValue ( const Aws::String s)
inline

Definition at line 89 of file EventHeader.h.

◆ EventHeaderValue() [4/10]

Aws::Utils::Event::EventHeaderValue::EventHeaderValue ( const ByteBuffer bb)
inline

Definition at line 95 of file EventHeader.h.

◆ EventHeaderValue() [5/10]

Aws::Utils::Event::EventHeaderValue::EventHeaderValue ( ByteBuffer &&  bb)
inline

Definition at line 101 of file EventHeader.h.

◆ EventHeaderValue() [6/10]

Aws::Utils::Event::EventHeaderValue::EventHeaderValue ( unsigned char  byte)
inlineexplicit

Definition at line 108 of file EventHeader.h.

◆ EventHeaderValue() [7/10]

Aws::Utils::Event::EventHeaderValue::EventHeaderValue ( bool  b)
inlineexplicit

Definition at line 114 of file EventHeader.h.

◆ EventHeaderValue() [8/10]

Aws::Utils::Event::EventHeaderValue::EventHeaderValue ( int16_t  n)
inlineexplicit

Definition at line 120 of file EventHeader.h.

◆ EventHeaderValue() [9/10]

Aws::Utils::Event::EventHeaderValue::EventHeaderValue ( int32_t  n)
inlineexplicit

Definition at line 126 of file EventHeader.h.

◆ EventHeaderValue() [10/10]

Aws::Utils::Event::EventHeaderValue::EventHeaderValue ( int64_t  n,
EventHeaderType  type = EventHeaderType::INT64 
)
inlineexplicit

Definition at line 132 of file EventHeader.h.

Member Function Documentation

◆ GetEventHeaderTypeForName()

static EventHeaderType Aws::Utils::Event::EventHeaderValue::GetEventHeaderTypeForName ( const Aws::String name)
static

◆ GetEventHeaderValueAsBoolean()

bool Aws::Utils::Event::EventHeaderValue::GetEventHeaderValueAsBoolean ( ) const
inline

Get header value as boolean. Log error if derived class doesn't override this function.

Definition at line 155 of file EventHeader.h.

◆ GetEventHeaderValueAsByte()

uint8_t Aws::Utils::Event::EventHeaderValue::GetEventHeaderValueAsByte ( ) const
inline

Get header value as byte. Log error if derived class doesn't override this function.

Definition at line 170 of file EventHeader.h.

◆ GetEventHeaderValueAsBytebuf()

ByteBuffer Aws::Utils::Event::EventHeaderValue::GetEventHeaderValueAsBytebuf ( ) const
inline

Get header value as ByteBuffer. Log error if derived class doesn't override this function.

Definition at line 230 of file EventHeader.h.

◆ GetEventHeaderValueAsInt16()

int16_t Aws::Utils::Event::EventHeaderValue::GetEventHeaderValueAsInt16 ( ) const
inline

Get header value as 16 bit integer. Log error if derived class doesn't override this function.

Definition at line 185 of file EventHeader.h.

◆ GetEventHeaderValueAsInt32()

int32_t Aws::Utils::Event::EventHeaderValue::GetEventHeaderValueAsInt32 ( ) const
inline

Get header value as 32 bit integer. Log error if derived class doesn't override this function.

Definition at line 200 of file EventHeader.h.

◆ GetEventHeaderValueAsInt64()

int64_t Aws::Utils::Event::EventHeaderValue::GetEventHeaderValueAsInt64 ( ) const
inline

Get header value as 64 bit integer. Log error if derived class doesn't override this function.

Definition at line 215 of file EventHeader.h.

◆ GetEventHeaderValueAsString()

Aws::String Aws::Utils::Event::EventHeaderValue::GetEventHeaderValueAsString ( ) const
inline

Get header value as String. Log error if derived class doesn't override this function.

Definition at line 245 of file EventHeader.h.

◆ GetEventHeaderValueAsTimestamp()

int64_t Aws::Utils::Event::EventHeaderValue::GetEventHeaderValueAsTimestamp ( ) const
inline

Get header value as timestamp in 64 bit integer. Log error if derived class doesn't override this function.

Definition at line 260 of file EventHeader.h.

◆ GetEventHeaderValueAsUuid()

Aws::Utils::UUID Aws::Utils::Event::EventHeaderValue::GetEventHeaderValueAsUuid ( ) const
inline

Get header value as UUID. Log error if derived class doesn't override this function.

Definition at line 275 of file EventHeader.h.

◆ GetNameForEventHeaderType()

static Aws::String Aws::Utils::Event::EventHeaderValue::GetNameForEventHeaderType ( EventHeaderType  value)
static

◆ GetType()

EventHeaderType Aws::Utils::Event::EventHeaderValue::GetType ( ) const
inline

Definition at line 145 of file EventHeader.h.

◆ GetUnderlyingBuffer()

const ByteBuffer& Aws::Utils::Event::EventHeaderValue::GetUnderlyingBuffer ( ) const
inline

Definition at line 288 of file EventHeader.h.

Member Data Documentation

◆ boolValue

bool Aws::Utils::Event::EventHeaderValue::boolValue

Definition at line 298 of file EventHeader.h.

◆ byteValue

uint8_t Aws::Utils::Event::EventHeaderValue::byteValue

Definition at line 299 of file EventHeader.h.

◆ int16Value

int16_t Aws::Utils::Event::EventHeaderValue::int16Value

Definition at line 300 of file EventHeader.h.

◆ int32Value

int32_t Aws::Utils::Event::EventHeaderValue::int32Value

Definition at line 301 of file EventHeader.h.

◆ int64Value

int64_t Aws::Utils::Event::EventHeaderValue::int64Value

Definition at line 302 of file EventHeader.h.

◆ timestampValue

int64_t Aws::Utils::Event::EventHeaderValue::timestampValue

Definition at line 303 of file EventHeader.h.


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