Namespaces

• namespace Platform

Enumerations

enum 

enum 

enum 

enum 

Records

• class WarmFabricStateDelegate

Functions

• WEAVE_ERROR Init (WeaveFabricState & inFabricState)

  A WARM API to perform one time module initialization.

  Parameters

  inFabricState [in] A reference to a valid WeaveFabricState.

  Returns

  WEAVE_NO_ERROR on success, error code otherwise.

• void Shutdown (WeaveFabricState & inFabricState)

  A WARM API to perform a clean shutdown.

  Parameters

  inFabricState [in] A reference to a valid WeaveFabricState.

• void InvokeActions ()

  This represents the entry point to perform the actions necessary which will satisfy

  the current System State. If for example the Thread stack transitioned from

  disabled to enabled, then this function would make the necessary platform calls

  to assign the thread host address etc. This function should be called by platform

  code only in response to a Warm call to RequestInvokeActions. Calling InvokeActions

  will result in one or more calls to nl::Warm::Platform API's.

  Developers should therefore implement RequestInvokeActions and the caller of

  InvokeActions() appropriately. It might be appropriate for RequestInvokeActions to post

  an event to the task which would call InvokeActions() for example. Conversely, if the system

  is single threaded, then RequestInvokeActions could be implemented to call InvokeActions()

  directly.

  A WARM API called by a dedicated task to perform various platform API actions.

• void ReportActionComplete (PlatformResult inResult)

  It is assumed that platform action API's may need to perform asynchronous operations.

  If this is true then the platform API will return kPlatformResultInProgress.

  When this happens new Address and Routing Actions will be suspended until the system

  calls ReportActionComplete to announce the completion of the operation.

  A WARM API called to announce the completion of a previous asynchronous platform API call.

  Parameters

  inResult [in] The result of the pending action. must be one of: {kPlatformResultSuccess | kPlatformResultFailure}

• void WiFiInterfaceStateChange (InterfaceState inState)

  A WARM API called to announce a State change for the WiFi interface.

  Parameters

  inState [in] kInterfaceStateUp if the WiFi interface is up, kInterfaceStateDown otherwise.

• void ThreadInterfaceStateChange (InterfaceState inState)

  A WARM API called to announce a State change for the Thread interface.

  Parameters

  inState [in] kInterfaceStateUp if the Thread interface is up, kInterfaceStateDown otherwise.

• void CellularInterfaceStateChange (InterfaceState inState)

  A WARM API called to announce a State change for the Cellular interface.

  Parameters

  inState [in] kInterfaceStateUp if the Cellular interface is up, kInterfaceStateDown otherwise.

• void ThreadRoutingStateChange (InterfaceState inState)

  A WARM API called to announce a State change for the Thread Routing feature.

  Parameters

  inState [in] kInterfaceStateUp if the Thread routing feature is up, kInterfaceStateDown otherwise.

• void BorderRouterStateChange (InterfaceState inState)

  A WARM API called to announce a State change for the Border router feature.

  Parameters

  inState [in] kInterfaceStateUp if the Border router feature is up, kInterfaceStateDown otherwise.

• WEAVE_ERROR GetULA (InterfaceType inInterfaceType, Inet::IPAddress & outAddress)

  A WARM API to acquire a ULA for a specified interface type.

  Parameters

  inInterfaceType [in] The type of interface for which a ULA is desired.

  outAddress [out] An address object used to hold the resulting ULA.

• WEAVE_ERROR GetFabricState (const WeaveFabricState *& outFabricState)

  A WARM API to acquire the FabricState object that was provided to Warm during Init.

  Parameters

  outFabricState [out] A pointer reference to a fabricState object.