adapter_efa_probe.c File Reference

This file contains internal definitions and implementation used within the SDK to support functionality that is not part of the API. More...

#include "adapter_efa.h"
#include "adapter_efa_probe.h"
#include "adapter_api.h"
#include "adapter_efa_probe_control.h"
#include "adapter_efa_probe_rx.h"
#include "adapter_efa_probe_tx.h"
#include "internal.h"
#include "cdi_os_api.h"

Functions
CdiReturnStatus	ProbeEndpointCreate (AdapterEndpointHandle app_adapter_endpoint_handle, CdiLogHandle log_handle, ProbeEndpointHandle *ret_handle_ptr)
CdiReturnStatus	ProbeEndpointError (ProbeEndpointHandle handle)
CdiReturnStatus	ProbeEndpointResetDone (ProbeEndpointHandle handle)
CdiReturnStatus	ProbeEndpointStart (ProbeEndpointHandle handle)
void	ProbeEndpointReset (ProbeEndpointHandle handle)
void	ProbeEndpointStop (ProbeEndpointHandle handle)
void	ProbeEndpointDestroy (ProbeEndpointHandle handle)

Detailed Description

This file contains internal definitions and implementation used within the SDK to support functionality that is not part of the API.

Function Documentation

ProbeEndpointCreate()

CdiReturnStatus ProbeEndpointCreate	(	AdapterEndpointHandle	app_adapter_endpoint_handle,
		CdiLogHandle	log_handle,
		ProbeEndpointHandle *	ret_handle_ptr )

Create an instance of a new probe for the specifiec endpoint.

Parameters

app_adapter_endpoint_handle	Application adapter endpoint handle.
log_handle	Handle of log related to the specified endpoint.
ret_handle_ptr	Pointer to returned probe endpoint handle.

Returns

CdiReturnStatus kCdiStatusOk if the operation was successful or a value that indicates the nature of the failure.

ProbeEndpointDestroy()

void ProbeEndpointDestroy

(

ProbeEndpointHandle

handle

)

Destroy a probe endpoint.

Parameters

handle

Handle of the probe endpoint to destroy.

ProbeEndpointError()

CdiReturnStatus ProbeEndpointError

(

ProbeEndpointHandle

handle

)

Disables the EFA endpoint and puts the probe into connection reset state. The probe will then attempt to reset the remote connection and re-establish the connection. Once the connection has been re-established, the user-registered connection callback function will be invoked.

Parameters

handle

Handle of probe related to the endpoint error.

Returns

CdiReturnStatus kCdiStatusOk if the operation was successful or a value that indicates the nature of the failure.

ProbeEndpointReset()

void ProbeEndpointReset

(

ProbeEndpointHandle

handle

)

Reset a probe endpoint.

Parameters

handle

Handle of probe related to the endpoint.

ProbeEndpointResetDone()

CdiReturnStatus ProbeEndpointResetDone

(

ProbeEndpointHandle

handle

)

The Endpoint Manager is in the final process of completing a reset of the endpoint by calling CdiAdapterResetEndpoint(), which uses this function to notify probe that the endpoint reset is done.

Parameters

handle

Handle of probe related to the endpoint.

Returns

CdiReturnStatus kCdiStatusOk if the operation was successful or a value that indicates the nature of the failure.

ProbeEndpointStart()

CdiReturnStatus ProbeEndpointStart

(

ProbeEndpointHandle

handle

)

The Endpoint Manager is in the final process of starting an endpoint by calling CdiAdapterStartEndpoint(), which uses this function to notify probe that the endpoint can be started.

Parameters

handle

Handle of probe related to the endpoint.

Returns

CdiReturnStatus kCdiStatusOk if the operation was successful or a value that indicates the nature of the failure.

ProbeEndpointStop()

void ProbeEndpointStop

(

ProbeEndpointHandle

handle

)

Stop a probe endpoint and wait for its thread to exit.

Parameters

handle

Handle of the probe endpoint to stop.