class ViewClient

Defined at line 44 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/ViewClient.h

Protected Members

 mCurrentMode
Binding * mBinding
void * mAppState
EventCallback mEventCallback
bool mPrevIsPartialChange
TraitDataHandle mPrevTraitDataHandle
nl::Weave::ExchangeContext * mEC
 

Public Methods

void ViewClient ()

Do nothing

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

AddRef to Binding

store pointers to binding and delegate

null out EC

WEAVE_ERROR SendRequest (const AppendToPathList aAppendToPathList, const HandleDataElement aHandleDataElement)

acquire EC from binding, kick off send message

WEAVE_ERROR SendRequest (TraitCatalogBase<TraitDataSink> * apCatalog, const TraitPath[] aPathList, const size_t aPathListSize)
WEAVE_ERROR Cancel ()

InternalCancel(false)

Protected Methods

void DataSinkOperation_NoMoreData (void *const apOpState, TraitDataSink *const apDataSink)
void OnSendError (ExchangeContext * aEC, WEAVE_ERROR aErrorCode, void * aMsgSpecificContext)
void OnResponseTimeout (nl::Weave::ExchangeContext * aEC)
void OnMessageReceived (nl::Weave::ExchangeContext * aEC, const nl::Inet::IPPacketInfo * aPktInfo, const nl::Weave::WeaveMessageInfo * aMsgInfo, uint32_t aProfileId, uint8_t aMsgType, PacketBuffer * aPayload)

Enumerations

enum EventID
Name Value Comments
kEvent_RequestFailed 1

Cancel is already called when this callback happens
Could be any reason the request failed, (WRM ACK missing, EC allocation failure, response timeout,...)
Check error code, mEC may be valid or NULL
WEAVE_ERROR_INVALID_MESSAGE_TYPE if some unrecognized message is received
WEAVE_ERROR_TIME_OUT if

kEvent_AboutToSendRequest 2

Last chance to adjust EC, mEC is valid and can be tuned for timeout settings

kEvent_ViewResponseReceived 3

Response just arrived, mEC is valid

kEvent_ViewResponseConsumed 4

Cancel is already called when this callback happens
Response processing has been completed, InternalCancel will be called upon return

kEvent_StatusReportReceived 5

Cancel is already called when this callback happens
Status Report as response just arrived, mEC is valid, InternalCancel will be called upon return

Defined at line 47 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/ViewClient.h

enum (unnamed)
Name Value
kMode_Canceled 1
kMode_Initialized 2
kMode_DataSink 3
kMode_WithoutDataSink 4

Defined at line 133 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/ViewClient.h

Records