Proud::IDbCacheClientDelegate2 Class Reference

Classes
class	CCallbackArgs

Public Member Functions
virtual void	OnJoinDbCacheServerComplete (ErrorInfo *info)=0
virtual void	OnLeaveDbCacheServer (ErrorType reason)=0
virtual void	OnDbmsWriteDone (DbmsWritePropNodePendType type, Guid loadedDataGuid)=0
virtual void	OnExclusiveLoadDataComplete (CCallbackArgs &args)=0
virtual void	OnDataUnloadRequested (CCallbackArgs &args)=0
virtual void	OnDataForceUnloaded (CCallbackArgs &args)=0
virtual void	OnIsolateDataSuccess (CCallbackArgs &args)=0
virtual void	OnIsolateDataFailed (CCallbackArgs &args)=0
virtual void	OnDeisolateDataSuccess (CCallbackArgs &args)=0
virtual void	OnDeisolateDataFailed (CCallbackArgs &args)=0
virtual void	OnAddDataFailed (CCallbackArgs &args)=0
virtual void	OnAddDataSuccess (CCallbackArgs &args)=0
virtual void	OnUpdateDataFailed (CCallbackArgs &args)=0
virtual void	OnUpdateDataSuccess (CCallbackArgs &args)=0
virtual void	OnRemoveDataFailed (CCallbackArgs &args)=0
virtual void	OnRemoveDataSuccess (CCallbackArgs &args)=0
virtual void	OnNonExclusiveSnapshotDataComplete (CCallbackArgs &args)
virtual void	OnNonExclusiveAddDataAck (CCallbackArgs &args)
virtual void	OnNonExclusiveRemoveDataAck (CCallbackArgs &args)
virtual void	OnNonExclusiveModifyValueSuccess (CCallbackArgs &args)
virtual void	OnNonExclusiveModifyValueFailed (CCallbackArgs &args)
virtual void	OnNonExclusiveSetValueIfSuccess (CCallbackArgs &args)
virtual void	OnNonExclusiveSetValueIfFailed (CCallbackArgs &args)
virtual void	OnSomeoneAddData (CCallbackArgs &args)
virtual void	OnSomeoneRemoveData (CCallbackArgs &args)
virtual void	OnSomeoneModifyValue (CCallbackArgs &args)
virtual void	OnSomeoneSetValue (CCallbackArgs &args)
virtual void	OnAccessError (CCallbackArgs &args)=0
virtual void	OnError (ErrorInfo *errorInfo)=0
virtual void	OnWarning (ErrorInfo *errorInfo)=0
virtual void	OnException (const Exception &e)=0

Detailed Description

Delegate object to receive event callback from DB cache client

Member Function Documentation

virtual void Proud::IDbCacheClientDelegate2::OnAccessError ( CCallbackArgs &  args )

pure virtual

Data Access error

• Example of callback : This event will call some situation such as one-sided method is called while requested method is running, could not find update data or could not find data that need to delete.

  Parameters

  args	Event argument object of IDbCacheClientDelegate2

virtual void Proud::IDbCacheClientDelegate2::OnAddDataFailed ( CCallbackArgs &  args )

pure virtual

This event will arrive when it failed in CDbCacheClient2.RequestAddData or CDbCacheClient2.BlockedAddData

• Value will write to args.m_loadResults[index].m_reason, args.m_loadResults[index].m_comment

  Parameters

  args	Event argument object of IDbCacheClientDelegate2

virtual void Proud::IDbCacheClientDelegate2::OnAddDataSuccess ( CCallbackArgs &  args )

pure virtual

This event will arrive when it succeed in CDbCacheClient2.RequestAddData or CDbCacheClient2.BlockedAddData

• Value will write to args.m_loadResults[index].m_reason,args.m_loadResults[index].m_comment

  Parameters

  args	Event argument object of IDbCacheClientDelegate2

virtual void Proud::IDbCacheClientDelegate2::OnDataForceUnloaded ( CCallbackArgs &  args )

pure virtual

This is the event when particular data is forcibly unloaded from the server. If another exclusivity request is received by the data exclusively loaded currently, OnDataUnloadRequested() is called back, but If DB directly has access to data that DB cache deals with. is attempted, inevitably this function is called back.

virtual void Proud::IDbCacheClientDelegate2::OnDataUnloadRequested ( CCallbackArgs &  args )

pure virtual

This is event that decide losing exclusive loading or not because other DB cahce client2 tried Exclusive Load

• Value will write to args.m_loadResults[index].m_loadedData
• It can choose passing exclusive rights with calling DenyUnloadData or UnloadDataBySessionGuid in DbCacheClient

  Parameters

  args	Event argument object of IDbCacheClientDelegate2

virtual void Proud::IDbCacheClientDelegate2::OnDbmsWriteDone ( DbmsWritePropNodePendType  type, Guid  loadedDataGuid  )

pure virtual

Receiving event when writting process to DBMS on DB cache server.

Parameters

type	Type for what process has done.
loadedDataGuid	Guid of finished work data

virtual void Proud::IDbCacheClientDelegate2::OnDeisolateDataFailed ( CCallbackArgs &  args )

pure virtual

DB directly has access to data that DB cache deals with function. Proud.CDbCacheClient2.RequestDeisolateData() inform you of execution failure. m_rootUUID, m_data and m_sessionGuid are included in args.

virtual void Proud::IDbCacheClientDelegate2::OnDeisolateDataSuccess ( CCallbackArgs &  args )

pure virtual

DB directly has access to data that DB cache deals with function. Proud.CDbCacheClient2.RequestDeisolateData() inform you of execution success. m_rootUUID, m_data and m_sessionGuid are included in args.

virtual void Proud::IDbCacheClientDelegate2::OnError ( ErrorInfo *  errorInfo )

pure virtual

It calls when it occurs internal error. Information of

Parameters

errorinfo

error.

virtual void Proud::IDbCacheClientDelegate2::OnException ( const Exception &  e )

pure virtual

Merge to Proud.Exception

• It handle error that occur from user code.
• User realize things that user needed.
• You can use Exceptiontype that obtain Exception object.
• It process _com_error, void*, std::exception, etc. Also there is OnUnhandledException() that handle catch(...)
• void* can obtain exceptional object type by casting. For example, it uses obtaining MFC CException.

virtual void Proud::IDbCacheClientDelegate2::OnExclusiveLoadDataComplete ( CCallbackArgs &  args )

pure virtual

• This is the response for the exclusive load request.
• When requesting, you may receive multiple data trees through args.m_items depending on the input search conditions.
• args.m_items may have successful results and failed results mixed for exclusive load and if the value of CItem.m_reason is ErrorType_Ok, then this is a successful result.
• If successful, the related information is recorded in m_loadedData, m_data, m_sessionGuid, m_rootUUID, m_UUID and m_message among the member variables of the CItem object.
• If failed, the related information is recorded in m_reason, m_comment, m_UUID, m_hResult and m_message among the member variable of the CItem object.
• When the data is already excluded, the message transmitted by the current excluder when it transfers or rejects the exclusivity is recorded in m_message.
• When requesting to args.m_tag, the tag value input randomly by the user is returned as the original value so you can see this is a response to which request.

virtual void Proud::IDbCacheClientDelegate2::OnIsolateDataFailed ( CCallbackArgs &  args )

pure virtual

DB directly has access to data that DB cache deals with function. Proud.CDbCacheClient2.RequestIsolateData() inform you of execution failure. m_rootUUID, m_data and m_sessionGuid are included in args.

virtual void Proud::IDbCacheClientDelegate2::OnIsolateDataSuccess ( CCallbackArgs &  args )

pure virtual

DB directly has access to data that DB cache deals with function. Proud.CDbCacheClient2.RequestIsolateData() inform you of execution success. m_rootUUID, m_data and m_sessionGuid are included in args.

virtual void Proud::IDbCacheClientDelegate2::OnJoinDbCacheServerComplete ( ErrorInfo *  info )

pure virtual

Returns the results of server connection attempts.

Parameters

info	This is failed information. When it succeed, ErrorType_Ok will be in info.m_errorType.

virtual void Proud::IDbCacheClientDelegate2::OnLeaveDbCacheServer ( ErrorType  reason )

pure virtual

Notifies that the connection to DB cache server is finished

• Under the circumstance that this is called, all data in DB cache client is already unloaded.

  Parameters

  reason

  reason to disconnecting

virtual void Proud::IDbCacheClientDelegate2::OnNonExclusiveAddDataAck ( CCallbackArgs &  args )

inlinevirtual

A callback to non monopolistic approach. Please refer to Accessing non-exclusive data.

• Value will write in to args.m_loadResults[index].m_reason, args.m_loadResults[index].m_comment when it succeed.
• Value will write in to args.m_loadResults[index].m_rootUUID, args.m_loadResults[index].m_data when it failed.

  Parameters

  args	Event argument object of IDbCacheClientDelegate2.

virtual void Proud::IDbCacheClientDelegate2::OnNonExclusiveModifyValueFailed ( CCallbackArgs &  args )

inlinevirtual

A callback to non monopolistic approach. Please refer to Accessing non-exclusive data.

• Value will write in to args.m_loadResults[index].m_reason, args.m_loadResults[index].m_comment.

  Parameters

  args	Event argument object of IDbCacheClientDelegate2.

virtual void Proud::IDbCacheClientDelegate2::OnNonExclusiveModifyValueSuccess ( CCallbackArgs &  args )

inlinevirtual

A callback to non monopolistic approach. Please refer to Accessing non-exclusive data.

• Value will write in to args.m_loadResults[index].m_rootUUID, args.m_loadResults[index].m_data.

  Parameters

  args	Event argument object of IDbCacheClientDelegate2.

virtual void Proud::IDbCacheClientDelegate2::OnNonExclusiveRemoveDataAck ( CCallbackArgs &  args )

inlinevirtual

A callback to non monopolistic approach. Please refer to Accessing non-exclusive data.

• Value will write in to args.m_loadResults[index].m_reason, args.m_loadResults[index].m_comment when it succeed.
• Value will write in to args.m_loadResults[index].m_rootUUID, args.m_loadResults[index].m_data when it failed.

  Parameters

  args	Event argument object of IDbCacheClientDelegate2.

virtual void Proud::IDbCacheClientDelegate2::OnNonExclusiveSetValueIfFailed ( CCallbackArgs &  args )

inlinevirtual

A callback to non monopolistic approach. Please refer to Accessing non-exclusive data.

• Value will write in to args.m_loadResults[index].m_reason, args.m_loadResults[index].m_comment.

  Parameters

  args	Event argument object of IDbCacheClientDelegate2.

virtual void Proud::IDbCacheClientDelegate2::OnNonExclusiveSetValueIfSuccess ( CCallbackArgs &  args )

inlinevirtual

A callback to non monopolistic approach. Please refer to Accessing non-exclusive data.

• Value will write in to args.m_loadResults[index].m_rootUUID, args.m_loadResults[index].m_data.

  Parameters

  args	Event argument object of IDbCacheClientDelegate2.

virtual void Proud::IDbCacheClientDelegate2::OnNonExclusiveSnapshotDataComplete ( CCallbackArgs &  args )

inlinevirtual

• This is the request for the nonexclusive search request.
• When requesting, you may receive multiple data trees through args.m_items depending on the input search conditions
• args.m_items may have successful results and failed results mixed for search success and if the value of CItem.m_reason is ErrorType_Ok, then this is a successful result.
• If successful, the related information is recorded in m_loadedData, m_data, m_sessionGuid, m_rootUUID and m_UUID among the member variables of the CItem object.
• If failed, the related information is recorded in m_reason, m_comment, m_UUID and m_hResult among the member variable of the CItem object.
• When requesting to args.m_tag, the tag value input randomly by the user is returned as the original value so you can see this is a response to which request.

virtual void Proud::IDbCacheClientDelegate2::OnRemoveDataFailed ( CCallbackArgs &  args )

pure virtual

Refer to OnAddDataFailed

• Value will write to args.m_loadResults[index].m_reason,args.m_loadResults[index].m_comment

  Parameters

  args	Event argument object of IDbCacheClientDelegate2

virtual void Proud::IDbCacheClientDelegate2::OnRemoveDataSuccess ( CCallbackArgs &  args )

pure virtual

Refer to OnAddDataFailed

• Value will write to args.m_loadResults[index].m_reason,args.m_loadResults[index].m_comment

  Parameters

  args	Event argument object of IDbCacheClientDelegate2

virtual void Proud::IDbCacheClientDelegate2::OnSomeoneAddData ( CCallbackArgs &  args )

inlinevirtual

A callback to non monopolistic approach. Please refer to Accessing non-exclusive data.

• Value will write in to args.m_loadResults[index].m_loadedData and args.m_loadResults[index].m_data, args.m_loadResults[index].m_message.

  Parameters

  args	Event argument object of IDbCacheClientDelegate2.

virtual void Proud::IDbCacheClientDelegate2::OnSomeoneModifyValue ( CCallbackArgs &  args )

inlinevirtual

A callback to non monopolistic approach. Please refer to Accessing non-exclusive data.

• Value will write in to args.m_loadResults[index].m_loadedData and args.m_loadResults[index].m_data, args.m_loadResults[index].m_message.

  Parameters

  args	Event argument object of IDbCacheClientDelegate2.

virtual void Proud::IDbCacheClientDelegate2::OnSomeoneRemoveData ( CCallbackArgs &  args )

inlinevirtual

A callback to non monopolistic approach. Please refer to Accessing non-exclusive data.

• Value will write in to args.m_loadResults[index].m_loadedData and args.m_loadResults[index].m_data, args.m_loadResults[index].m_message.

  Parameters

  args	Event argument object of IDbCacheClientDelegate2.

virtual void Proud::IDbCacheClientDelegate2::OnSomeoneSetValue ( CCallbackArgs &  args )

inlinevirtual

A callback to non monopolistic approach. Please refer to Accessing non-exclusive data.

• Value will write in to args.m_loadResults[index].m_loadedData and args.m_loadResults[index].m_data, args.m_loadResults[index].m_message.

  Parameters

  args	Event argument object of IDbCacheClientDelegate2.

virtual void Proud::IDbCacheClientDelegate2::OnUpdateDataFailed ( CCallbackArgs &  args )

pure virtual

Refer to OnAddDataFailed

• Value will write to args.m_loadResults[index].m_reason,args.m_loadResults[index].m_comment

  Parameters

  args	Event argument object of IDbCacheClientDelegate2

virtual void Proud::IDbCacheClientDelegate2::OnUpdateDataSuccess ( CCallbackArgs &  args )

pure virtual

Refer to OnAddDataSuccess

• Value will write to args.m_loadResults[index].m_loadedData,args.m_loadResults[index].m_data

  Parameters

  args	Event argument object of IDbCacheClientDelegate2

virtual void Proud::IDbCacheClientDelegate2::OnWarning ( ErrorInfo *  errorInfo )

pure virtual

It calls when it occurs internal warning. It reports problem that not serious than error. Information of

Parameters

errorinfo

error.