CDI SDK
SDK for transporting chunks of data reliably and with low latency using a polled mode network driver.
Loading...
Searching...
No Matches
receive_buffer.h
Go to the documentation of this file.
1// -------------------------------------------------------------------------------------------
2// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
3// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
4// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
5// -------------------------------------------------------------------------------------------
6
12
13#ifndef RECEIVE_BUFFER_H__
14#define RECEIVE_BUFFER_H__
15
16#include "endpoint_manager.h"
17#include "private.h"
18
19typedef struct ReceiveBufferState* ReceiveBufferHandle;
20
38CdiReturnStatus RxBufferInit(CdiLogHandle log_handle, CdiPoolHandle error_message_pool, int buffer_delay_ms,
39 int max_rx_payloads, CdiQueueHandle output_queue_handle,
40 ReceiveBufferHandle* receive_buffer_handle_ptr, CdiQueueHandle* input_queue_handle_ptr);
41
48void RxBufferDestroy(ReceiveBufferHandle receive_buffer_handle);
49
50#endif // RECEIVE_BUFFER_H__
CdiReturnStatus
CdiReturnStatus
Values used for API function return codes.
Definition cdi_core_api.h:189
CdiLogHandle
struct CdiLogState * CdiLogHandle
Forward declaration to create pointer to log handle.
Definition cdi_log_api.h:40
CdiPoolHandle
struct CdiPoolState * CdiPoolHandle
Type used as the handle (pointer to an opaque structure) for a Memory Pool. Each handle represents a ...
Definition cdi_pool_api.h:97
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...
ReceiveBufferHandle
struct ReceiveBufferState * ReceiveBufferHandle
Forward reference of structure to create pointers later.
Definition private.h:90
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
RxBufferDestroy
void RxBufferDestroy(ReceiveBufferHandle receive_buffer_handle)
Definition receive_buffer.c:263
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
Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.