nl::Weave::Profiles::DataManagement_Current::UpdateClient

Summary

Constructors and Destructors
UpdateClient(void)

Public types
EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventType enum
UpdateClientState{
  kState_Uninitialized = 0,
  kState_Initialized,
  kState_AwaitingResponse
} 		enum

Public attributes
mpAppState
void *
mpBinding

Public static functions
DefaultEventHandler(void *apAppState, EventType aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void

Public functions
CancelUpdate(void)
void
Reset update client to initialized status.
CloseUpdate(bool aAbort)
void
Init(Binding *const apBinding, void *const apAppState, EventCallback const aEventCallback)
AddRef to Binding store pointers to binding and delegate.
SendUpdate(bool aIsPartialUpdate, PacketBuffer *aPBuf, bool aIsFirstPayload)
acquire EC from binding, kick off send message
Shutdown(void)
Release binding for the update.

Structs
nl::Weave::Profiles::DataManagement_Current::UpdateClient::InEventParam
nl::Weave::Profiles::DataManagement_Current::UpdateClient::OutEventParam

Public types

EventCallback

void(* EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

EventType

 EventType

UpdateClientState

 UpdateClientState
Properties
kState_AwaitingResponse

The update client has sent the update request, and pending for response.

kState_Initialized

The update client has been initialized and is ready.

kState_Uninitialized

The update client has not been initialized.

Public attributes

mpAppState

void * mpAppState

mpBinding

Binding * mpBinding

Public static functions

DefaultEventHandler

void DefaultEventHandler(
  void *apAppState,
  EventType aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)

Public functions

CancelUpdate

void CancelUpdate(
  void
)

Reset update client to initialized status.

clear the buffer

Details
Return Values
WEAVE_NO_ERROR
On success.

CloseUpdate

void CloseUpdate(
  bool aAbort
)

Init

WEAVE_ERROR Init(
  Binding *const apBinding,
  void *const apAppState,
  EventCallback const aEventCallback
)

AddRef to Binding store pointers to binding and delegate.

Details
Return Values
WEAVE_NO_ERROR
On success.

SendUpdate

WEAVE_ERROR SendUpdate(
  bool aIsPartialUpdate,
  PacketBuffer *aPBuf,
  bool aIsFirstPayload
)

acquire EC from binding, kick off send message

Details
Return Values
WEAVE_NO_ERROR
On success.
other
Unable to send update

Shutdown

WEAVE_ERROR Shutdown(
  void
)

Release binding for the update.

Should only be called once.

Details
Return Values
WEAVE_NO_ERROR
On success.

UpdateClient

 UpdateClient(
  void
)