aws-cdi-sdk/mainline/receive__buffer_8h_source.html

// -------------------------------------------------------------------------------------------

// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.

// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.

// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE

// -------------------------------------------------------------------------------------------


#ifndef RECEIVE_BUFFER_H__

#define RECEIVE_BUFFER_H__


#include "endpoint_manager.h"

#include "private.h"


typedef struct ReceiveBufferState* ReceiveBufferHandle;


CdiReturnStatus RxBufferInit(CdiLogHandle log_handle, CdiPoolHandle error_message_pool, int buffer_delay_ms,

                             int max_rx_payloads, CdiQueueHandle output_queue_handle,

                             ReceiveBufferHandle* receive_buffer_handle_ptr, CdiQueueHandle* input_queue_handle_ptr);


void RxBufferDestroy(ReceiveBufferHandle receive_buffer_handle);


#endif  // RECEIVE_BUFFER_H__

CdiReturnStatus
CdiReturnStatus
Values used for API function return codes.
Definition cdi_core_api.h:189

CdiQueueHandle
struct CdiQueueState * CdiQueueHandle
Type used as the handle (pointer to an opaque structure) for a queue. Each handle represents a instan...
Definition cdi_queue_api.h:32

endpoint_manager.h
The declarations in this header file correspond to the definitions in endpoint_manager....

private.h
This header file contains definitions of types and the one global variable used internally by the SDK...

RxBufferInit
CdiReturnStatus RxBufferInit(CdiLogHandle log_handle, CdiPoolHandle error_message_pool, int buffer_delay_ms, int max_rx_payloads, CdiQueueHandle output_queue_handle, ReceiveBufferHandle *receive_buffer_handle_ptr, CdiQueueHandle *input_queue_handle_ptr)
Definition receive_buffer.c:205

ReceiveBufferHandle
struct ReceiveBufferState * ReceiveBufferHandle
Forward declaration of a receive buffer handle type.
Definition receive_buffer.h:19

RxBufferDestroy
void RxBufferDestroy(ReceiveBufferHandle receive_buffer_handle)
Definition receive_buffer.c:263

CdiLogState
Structure used to hold state data for a single log of any type (stdout, callback or file).
Definition logger.c:79

CdiPoolState
This structure represents the current state of a memory pool.
Definition pool.c:46

ReceiveBufferState
Definition receive_buffer.c:29

ReceiveBufferState::error_message_pool
CdiPoolHandle error_message_pool
Pool used to hold error message strings.
Definition receive_buffer.c:32

ReceiveBufferState::log_handle
CdiLogHandle log_handle
Logger handle used for this connection. If NULL, the global logger is used.
Definition receive_buffer.c:31

ReceiveBufferState::output_queue_handle
CdiQueueHandle output_queue_handle
Configured handle of where payloads are to be sent after being delayed.
Definition receive_buffer.c:33