openthread_sys

Type Alias otBorderAgentEphemeralKeyCallback

Source
pub type otBorderAgentEphemeralKeyCallback = Option<unsafe extern "C" fn(aContext: *mut c_void)>;
Expand description

Callback function pointer to signal changes related to the Border Agent’s ephemeral key.

This callback is invoked whenever:

  • The Border Agent starts using an ephemeral key.
  • Any parameter related to the ephemeral key, such as the port number, changes.
  • The Border Agent stops using the ephemeral key due to:
    • A direct call to otBorderAgentClearEphemeralKey().
    • The ephemeral key timing out.
    • An external commissioner successfully using the key to connect and then disconnecting.
    • Reaching the maximum number of allowed failed connection attempts.

Any OpenThread API, including otBorderAgent APIs, can be safely called from this callback.

@param[in] aContext A pointer to an arbitrary context (provided when callback is set).

Aliased Type§

enum otBorderAgentEphemeralKeyCallback {
    None,
    Some(unsafe extern "C" fn(_: *mut c_void)),
}

Variants§

§1.0.0

None

No value.

§1.0.0

Some(unsafe extern "C" fn(_: *mut c_void))

Some value of type T.