openthread_sys

Function otTcpEndpointInitialize

Source 
pub unsafe extern "C" fn otTcpEndpointInitialize(
    aInstance: *mut otInstance,
    aEndpoint: *mut otTcpEndpoint,
    aArgs: *const otTcpEndpointInitializeArgs,
) -> otError
Expand description

Initializes a TCP endpoint.

Calling this function causes OpenThread to keep track of the TCP endpoint and store and retrieve TCP data inside the @p aEndpoint. The application should refrain from directly accessing or modifying the fields in @p aEndpoint. If the application needs to reclaim the memory backing @p aEndpoint, it should call otTcpEndpointDeinitialize().

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aEndpoint A pointer to a TCP endpoint structure. @param[in] aArgs A pointer to a structure of arguments.

@retval OT_ERROR_NONE Successfully opened the TCP endpoint. @retval OT_ERROR_FAILED Failed to open the TCP endpoint.