openthread_sys

Function otTcpListenerInitialize

Source
pub unsafe extern "C" fn otTcpListenerInitialize(
    aInstance: *mut otInstance,
    aListener: *mut otTcpListener,
    aArgs: *const otTcpListenerInitializeArgs,
) -> otError
Expand description

Initializes a TCP listener.

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

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

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