AWS IoT Device SDK C++ v2 1.44.1
AWS IoT Device SDK C++ v2
Loading...
Searching...
No Matches
Aws::Eventstreamrpc Namespace Reference

Classes

class  AbstractShapeBase
struct  AwsEventstreamConnectionImplClearSharedTask
struct  AwsEventstreamContinuationReleaseTask
class  ClientConnection
class  ClientConnectionImpl
class  ClientContinuationHandler
class  ClientContinuationImpl
class  ClientOperation
class  ConnectionCallbackContext
class  ConnectionConfig
class  ConnectionLifecycleHandler
struct  ContinuationSharedState
class  EventStreamHeader
class  EventstreamResultVariantType
class  MessageAmendment
struct  MessageDeserialization
struct  MessageResult
class  OnMessageFlushCallbackContainer
class  OnMessageFlushCallbackContainerWrapper
class  OperationError
class  OperationModelContext
class  ResponseRetriever
struct  RpcError
class  ServiceModel
class  StreamResponseHandler

Typedefs

using HeaderValueType = aws_event_stream_header_value_type
using MessageType = aws_event_stream_rpc_message_type
using OnMessageFlushCallback = std::function<void(int errorCode)>
using ConnectMessageAmender = std::function<const MessageAmendment &(void)>
using ExpectedResponseFactory
using ErrorResponseFactory
using LoneResponseRetriever = std::function<ExpectedResponseFactory(const Crt::String &modelName)>
using StreamingResponseRetriever = std::function<ExpectedResponseFactory(const Crt::String &modelName)>
using ErrorResponseRetriever = std::function<ErrorResponseFactory(const Crt::String &modelName)>

Enumerations

enum  EventStreamRpcStatusCode {
  EVENT_STREAM_RPC_SUCCESS = 0 , EVENT_STREAM_RPC_NULL_PARAMETER , EVENT_STREAM_RPC_UNINITIALIZED , EVENT_STREAM_RPC_ALLOCATION_ERROR ,
  EVENT_STREAM_RPC_CONNECTION_SETUP_FAILED , EVENT_STREAM_RPC_CONNECTION_ACCESS_DENIED , EVENT_STREAM_RPC_CONNECTION_ALREADY_ESTABLISHED , EVENT_STREAM_RPC_CONNECTION_CLOSED ,
  EVENT_STREAM_RPC_CONTINUATION_CLOSED , EVENT_STREAM_RPC_UNKNOWN_PROTOCOL_MESSAGE , EVENT_STREAM_RPC_UNMAPPED_DATA , EVENT_STREAM_RPC_UNSUPPORTED_CONTENT_TYPE ,
  EVENT_STREAM_RPC_CRT_ERROR , EVENT_STREAM_RPC_CONTINUATION_NOT_YET_OPENED
}
enum  ResultType { NONE , OPERATION_RESPONSE , OPERATION_ERROR , RPC_ERROR }
enum class  ConnectionCallbackActionType { None , CompleteConnectPromise , DisconnectionCallback }
enum class  EventStreamMessageRoutingType { Response , Stream , Error }
enum class  ContinuationStateType {
  None , PendingActivate , Activated , PendingClose ,
  Closed
}

Functions

static void s_protocolMessageCallback (int errorCode, void *userData) noexcept
static void s_fillNativeHeadersArray (const Crt::List< EventStreamHeader > &headers, struct aws_array_list *headersArray, Crt::Allocator *m_allocator=Crt::g_allocator)
static void s_zeroSharedReference (struct aws_task *task, void *arg, enum aws_task_status status)
static const EventStreamHeaders_GetHeaderByName (const Crt::List< EventStreamHeader > &headers, const Crt::String &name) noexcept
static void s_releaseContinuation (struct aws_task *task, void *arg, enum aws_task_status status)

Typedef Documentation

◆ ConnectMessageAmender

using Aws::Eventstreamrpc::ConnectMessageAmender = std::function<const MessageAmendment &(void)>

Allows the application to add headers and change the payload of the CONNECT packet sent out by the client.

Returns
The MessageAmendment for the client to use during an attempt to connect.

◆ ErrorResponseFactory

Initial value:
std::function<
std::unique_ptr< T, std::function< void(T *)> > ScopedResource
Definition Types.h:163
aws_allocator Allocator
Definition Allocator.h:14
string_view StringView
Definition StringView.h:856

◆ ErrorResponseRetriever

◆ ExpectedResponseFactory

◆ HeaderValueType

using Aws::Eventstreamrpc::HeaderValueType = aws_event_stream_header_value_type

◆ LoneResponseRetriever

◆ MessageType

using Aws::Eventstreamrpc::MessageType = aws_event_stream_rpc_message_type

◆ OnMessageFlushCallback

using Aws::Eventstreamrpc::OnMessageFlushCallback = std::function<void(int errorCode)>

A callback prototype that is called upon flushing a message over the wire.

Parameters
errorCodeA non-zero value if an error occurred while attempting to flush the message.

◆ StreamingResponseRetriever

Enumeration Type Documentation

◆ ConnectionCallbackActionType

Enumerator
None 
CompleteConnectPromise 
DisconnectionCallback 

◆ ContinuationStateType

Enumerator
None 
PendingActivate 
Activated 
PendingClose 
Closed 

◆ EventStreamMessageRoutingType

Enumerator
Response 
Stream 
Error 

◆ EventStreamRpcStatusCode

Enumerator
EVENT_STREAM_RPC_SUCCESS 
EVENT_STREAM_RPC_NULL_PARAMETER 
EVENT_STREAM_RPC_UNINITIALIZED 
EVENT_STREAM_RPC_ALLOCATION_ERROR 
EVENT_STREAM_RPC_CONNECTION_SETUP_FAILED 
EVENT_STREAM_RPC_CONNECTION_ACCESS_DENIED 
EVENT_STREAM_RPC_CONNECTION_ALREADY_ESTABLISHED 
EVENT_STREAM_RPC_CONNECTION_CLOSED 
EVENT_STREAM_RPC_CONTINUATION_CLOSED 
EVENT_STREAM_RPC_UNKNOWN_PROTOCOL_MESSAGE 
EVENT_STREAM_RPC_UNMAPPED_DATA 
EVENT_STREAM_RPC_UNSUPPORTED_CONTENT_TYPE 
EVENT_STREAM_RPC_CRT_ERROR 
EVENT_STREAM_RPC_CONTINUATION_NOT_YET_OPENED 

◆ ResultType

Enumerator
NONE 
OPERATION_RESPONSE 
OPERATION_ERROR 
RPC_ERROR 

Function Documentation

◆ s_fillNativeHeadersArray()

void Aws::Eventstreamrpc::s_fillNativeHeadersArray ( const Crt::List< EventStreamHeader > & headers,
struct aws_array_list * headersArray,
Crt::Allocator * m_allocator = Crt::g_allocator )
static

◆ s_GetHeaderByName()

const EventStreamHeader * Aws::Eventstreamrpc::s_GetHeaderByName ( const Crt::List< EventStreamHeader > & headers,
const Crt::String & name )
staticnoexcept

◆ s_protocolMessageCallback()

void Aws::Eventstreamrpc::s_protocolMessageCallback ( int errorCode,
void * userData )
staticnoexcept

◆ s_releaseContinuation()

void Aws::Eventstreamrpc::s_releaseContinuation ( struct aws_task * task,
void * arg,
enum aws_task_status status )
static

◆ s_zeroSharedReference()

void Aws::Eventstreamrpc::s_zeroSharedReference ( struct aws_task * task,
void * arg,
enum aws_task_status status )
static