nrf_rpc_stop()

int nrf_rpc_stop

(

bool

cleanup

)

#include <nrf_rpc.h>

Temporarily suspend all RPC communication.

Calling this function automatically fails all communication until nrf_rpc_resume is called. It also causes all pending commands to fail immediately.

Warning

This function is experimental and subject to change or removal without prior notice.

Parameters

cleanup

set to true to also invoke all the custom cleanup handlers.

Note

If the cleanup parameter is set to true it may be needed to reset the peer before invoking nrf_rpc_resume.

Return values

0	on success.
-NRF_EALREADY	when RPC is already stopped or stopping.
-NRF_ETIMEDOUT	when waiting for in-flight RPC processing to complete times out and assertions are disabled.