adapter_control_interface.h File Reference

The declarations in this header file correspond to the definitions in adapter.c. More...

#include "adapter_api.h"
#include "internal.h"

Go to the source code of this file.

Data Structures
struct	ControlInterfaceConfigData
	Type used to hold control interface configuration data. More...

Typedefs
typedef struct ControlInterfaceState *	ControlInterfaceHandle
	Type used as the handle (pointer to an opaque structure) for a control interface. Each handle represents an instance of an interface.

Functions
CdiReturnStatus	ControlInterfaceInitialize (const char *adapter_ip_addr_str, CdiAdapterHandle *ret_handle_ptr)
CdiReturnStatus	ControlInterfaceCreate (const ControlInterfaceConfigData *config_data_ptr, ControlInterfaceHandle *ret_handle_ptr)
void	ControlInterfaceDestroy (ControlInterfaceHandle handle)
AdapterConnectionHandle	ControlInterfaceGetConnection (ControlInterfaceHandle handle)
AdapterEndpointHandle	ControlInterfaceGetEndpoint (ControlInterfaceHandle handle)
CdiPoolHandle	ControlInterfaceGetWorkRequestPoolHandle (ControlInterfaceHandle handle)

Detailed Description

The declarations in this header file correspond to the definitions in adapter.c.

Function Documentation

ControlInterfaceCreate()

CdiReturnStatus ControlInterfaceCreate	(	const ControlInterfaceConfigData *	config_data_ptr,
		ControlInterfaceHandle *	ret_handle_ptr )

Create a Tx control interface. NOTE: For a receiver (which is a server), we have to get the destination IP and port information from the transmitter (the client) before this function can be used.

Parameters

config_data_ptr	Pointer to control interface configuration data.
ret_handle_ptr	Address where to write returned handle of the control interface.

Returns

A value from the CdiReturnStatus enumeration.

ControlInterfaceDestroy()

void ControlInterfaceDestroy

(

ControlInterfaceHandle

handle

)

Destroy a specific TX or RX control interface and free resources that were created for it.

Parameters

handle

Handle of control interface to destroy.

ControlInterfaceGetConnection()

AdapterConnectionHandle ControlInterfaceGetConnection

(

ControlInterfaceHandle

handle

)

Return the adapter connection associated with the specified control interface.

Parameters

handle

Handle of control interface.

Returns

Handle of adapter connection.

ControlInterfaceGetEndpoint()

AdapterEndpointHandle ControlInterfaceGetEndpoint

(

ControlInterfaceHandle

handle

)

Return the adapter endpoint associated with the specified control interface.

Parameters

handle

Handle of control interface.

Returns

Handle of adapter endpoint.

ControlInterfaceGetWorkRequestPoolHandle()

CdiPoolHandle ControlInterfaceGetWorkRequestPoolHandle

(

ControlInterfaceHandle

handle

)

Return the handle of the work request pool associated with the specified control interface.

Parameters

handle

Handle of control interface.

Returns

Handle of work request pool.

ControlInterfaceInitialize()

CdiReturnStatus ControlInterfaceInitialize	(	const char *	adapter_ip_addr_str,
		CdiAdapterHandle *	ret_handle_ptr )

Initialize the control interface using the specific adapter IP and return a handle to the adapter.

Parameters

adapter_ip_addr_str	Pointer to adapter's IP address string.
ret_handle_ptr	Address where to write returned handle of the adapter.

Returns

A value from the CdiReturnStatus enumeration.