CDI SDK
SDK for transporting chunks of data reliably and with low latency using a polled mode network driver.
Loading...
Searching...
No Matches
adapter_control_interface.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
13#ifndef ADAPTER_CONTROL_INTERFACE_H__
14#define ADAPTER_CONTROL_INTERFACE_H__
15
16#include "adapter_api.h"
17#include "internal.h"
18
19//*********************************************************************************************************************
20//***************************************** START OF DEFINITIONS AND TYPES ********************************************
21//*********************************************************************************************************************
22
28
45
46//*********************************************************************************************************************
47//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
48//*********************************************************************************************************************
49
58CdiReturnStatus ControlInterfaceInitialize(const char* adapter_ip_addr_str, CdiAdapterHandle* ret_handle_ptr);
59
70 ControlInterfaceHandle* ret_handle_ptr);
71
78
87
96
105
106#endif // ADAPTER_CONTROL_INTERFACE_H__
The declarations in this header file correspond to the definitions in adapter.c.
void(* MessageFromEndpoint)(void *param_ptr, Packet *packet_ptr, EndpointMessageType message_type)
Prototype of function used to process packet messages from the endpoint.
Definition adapter_api.h:105
CdiReturnStatus ControlInterfaceCreate(const ControlInterfaceConfigData *config_data_ptr, ControlInterfaceHandle *ret_handle_ptr)
Definition adapter_control_interface.c:103
void ControlInterfaceDestroy(ControlInterfaceHandle handle)
Definition adapter_control_interface.c:178
AdapterEndpointHandle ControlInterfaceGetEndpoint(ControlInterfaceHandle handle)
Definition adapter_control_interface.c:91
CdiReturnStatus ControlInterfaceInitialize(const char *adapter_ip_addr_str, CdiAdapterHandle *ret_handle_ptr)
Definition adapter_control_interface.c:66
struct ControlInterfaceState * ControlInterfaceHandle
Type used as the handle (pointer to an opaque structure) for a control interface. Each handle represe...
Definition adapter_control_interface.h:27
AdapterConnectionHandle ControlInterfaceGetConnection(ControlInterfaceHandle handle)
Definition adapter_control_interface.c:85
CdiPoolHandle ControlInterfaceGetWorkRequestPoolHandle(ControlInterfaceHandle handle)
Definition adapter_control_interface.c:97
CdiReturnStatus
Values used for API function return codes.
Definition cdi_core_api.h:189
The declarations in this header file correspond to the definitions in internal.c.
Structure used to hold adapter connection state.
Definition adapter_api.h:254
Structure used to hold adapter endpoint state.
Definition adapter_api.h:110
Structure definition behind the handles shared with the user's application program....
Definition adapter_api.h:384
Structure used to hold state data for a single log of any type (stdout, callback or file).
Definition logger.c:79
This structure represents the current state of a memory pool.
Definition pool.c:46
Type used to hold control interface configuration data.
Definition adapter_control_interface.h:32
CdiAdapterHandle control_interface_adapter_handle
Handle of adapter used for control interface.
Definition adapter_control_interface.h:33
int port_number
Port number related to this control interface.
Definition adapter_control_interface.h:42
CdiLogHandle log_handle
Handle of logger associated with this control interface.
Definition adapter_control_interface.h:39
void * msg_from_endpoint_param_ptr
Parameter passed to queue message function.
Definition adapter_control_interface.h:37
MessageFromEndpoint msg_from_endpoint_func_ptr
Address of function used to queue packet messages from the endpoint.
Definition adapter_control_interface.h:36
const char * tx_dest_ip_addr_str
Tx destination IP. Only used by Tx control interface.
Definition adapter_control_interface.h:41
const char * bind_ip_addr_str
IP address to bind to.
Definition adapter_control_interface.h:43
Type used to hold control interface state data.
Definition adapter_control_interface.c:32