Structure definition used to define the virtual table API interface for adapters. More...

#include <adapter_api.h>

Data Fields
CdiReturnStatus(*	CreateConnection )(AdapterConnectionHandle handle, int port_number, const char *bind_ip_addr_str)
	Create a new connection.

CdiReturnStatus(*	DestroyConnection )(AdapterConnectionHandle handle)
	Destroy an open connection.

CdiReturnStatus(*	Open )(AdapterEndpointHandle handle, const char remote_address_str, int port_number, const char bind_ip_addr_str)
	Opens a new endpoint. For send type (transmit) endpoints, a pointer to the remote_address_str must be provided, otherwise the value must be NULL. etc.).

CdiReturnStatus(*	Close )(AdapterEndpointHandle handle)
	Closes an open endpoint.

CdiReturnStatus(*	Poll )(AdapterEndpointHandle handle)
	Perform poll on an endpoint.

EndpointTransmitQueueLevel(*	GetTransmitQueueLevel )(AdapterEndpointHandle handle)
	Checks transmit queue level. A polled mode endpoint will return kEndpointTransmitBufferFull when its transmit queue is full while awaiting acknowledgements. Non-polled endpoints always return kEndpointTransmitBufferNa.

CdiReturnStatus(*	Send )(const AdapterEndpointHandle handle, const Packet *packet_ptr, bool flush_packets)
	Sends the data in memory specified by the SGL to the endpoint.

CdiReturnStatus(*	RxBuffersFree )(const AdapterEndpointHandle handle, const CdiSgList *sgl_ptr)
	Returns a receive data buffer to the endpoint's free pool.

CdiReturnStatus(*	GetPort )(const AdapterEndpointHandle handle, int *ret_port_number_ptr)
	Returns the port number being used by the endpoint.

CdiReturnStatus(*	Reset )(AdapterEndpointHandle handle)
	Reset an open endpoint.

CdiReturnStatus(*	Start )(AdapterEndpointHandle handle)
	Start an open endpoint.

CdiReturnStatus(*	Shutdown )(CdiAdapterHandle adapter)
	Shuts down an adapter, freeing all of its associated resources.

Detailed Description

Structure definition used to define the virtual table API interface for adapters.

Field Documentation

◆ Close

CdiReturnStatus(* AdapterVirtualFunctionPtrTable::Close) (AdapterEndpointHandle handle)

Closes an open endpoint.

See also: CdiAdapterCloseEndpoint

◆ CreateConnection

CdiReturnStatus(* AdapterVirtualFunctionPtrTable::CreateConnection) (AdapterConnectionHandle handle, int port_number, const char *bind_ip_addr_str)

Create a new connection.

See also: CdiAdapterCreateConnection

◆ DestroyConnection

CdiReturnStatus(* AdapterVirtualFunctionPtrTable::DestroyConnection) (AdapterConnectionHandle handle)

Destroy an open connection.

See also: CdiAdapterDestroyConnection

◆ GetPort

CdiReturnStatus(* AdapterVirtualFunctionPtrTable::GetPort) (const AdapterEndpointHandle handle, int *ret_port_number_ptr)

Returns the port number being used by the endpoint.

See also: CdiAdapterGetPort

◆ GetTransmitQueueLevel

EndpointTransmitQueueLevel(* AdapterVirtualFunctionPtrTable::GetTransmitQueueLevel) (AdapterEndpointHandle handle)

Checks transmit queue level. A polled mode endpoint will return kEndpointTransmitBufferFull when its transmit queue is full while awaiting acknowledgements. Non-polled endpoints always return kEndpointTransmitBufferNa.

See also: CdiAdapterGetTransmitQueueLevel

◆ Open

CdiReturnStatus(* AdapterVirtualFunctionPtrTable::Open) (AdapterEndpointHandle handle, const char *remote_address_str, int port_number, const char *bind_ip_addr_str)

Opens a new endpoint. For send type (transmit) endpoints, a pointer to the remote_address_str must be provided, otherwise the value must be NULL. etc.).