AMPS.Client.SOWRecoveryPointAdapter Class Reference

Inheritance diagram for AMPS.Client.SOWRecoveryPointAdapter:

Public Member Functions
delegate void	ExceptionListener (Exception e)
	SOWRecoveryPointAdapter (Client client_, string trackedClientName_, bool closeClient_, bool useTimestamp_, bool throwExceptions_, long timeoutMillis_=0, string topic_="/ADMIN/bookmark_store", string clientNameField_="clientName", string subIdField_="subId", string bookmarkField_="bookmark")
	Creates a new SOWRecoveryPointAdapter. More...
	SOWRecoveryPointAdapter (Client client_, string trackedClientName_)
	Creates a new SOWRecoveryPointAdapter with default properties for NOT closing the provided client, using the ExceptionListener, no timeout for sow query of publshFlush, and a SOW topic of /ADMIN/bookmark_store with fields clientName, subId, and bookmark. More...
void	setExceptionListener (ExceptionListener exceptionListener)
	Sets the ExceptionListener instance used for communicating absorbed exceptions. More...
void	update (RecoveryPoint recoveryPoint_)
void	purge ()
void	purge (Field subId_)
void	close ()
IEnumerator< RecoveryPoint >	GetEnumerator ()
bool	MoveNext ()
void	Reset ()

Protected Member Functions
virtual bool	serialize (RecoveryPoint recoveryPoint_)
virtual bool	deserialize (Message m_)
virtual void	initSerialization ()

Properties
RecoveryPoint	Current [get]

Constructor & Destructor Documentation

SOWRecoveryPointAdapter() [1/2]

AMPS.Client.SOWRecoveryPointAdapter.SOWRecoveryPointAdapter ( Client  client_, string  trackedClientName_, bool  closeClient_, bool  useTimestamp_, bool  throwExceptions_, long  timeoutMillis_ = 0, string  topic_ = "/ADMIN/bookmark_store", string  clientNameField_ = "clientName", string  subIdField_ = "subId", string  bookmarkField_ = "bookmark"  )

inline

Creates a new SOWRecoveryPointAdapter.

Parameters

client_

The Client or HAClient connected to the AMPS server containing the SOW where bookmarks are tracked. This client MUST NOT be the same as the client being tracked. Parameters trackedClientName_ The name of the client whose bookmarks are being tracked. Parameters timeoutMillis_ The maximum amount of time in ms to wait for sow query completion to occur during recovery and for publishFlush to complete during Dispose. Use 0 for no timeout. Parameters closeClient_ If true, then client_ will be closed during Dispose. Parameters useTimestamp_ If true, then recovery bookmarks will also include the timestamp when the last update for each subId was stored in the SOW. Parameters throwExceptions_ If true, the exceptions will be thrown out of this class instead of sending them to any set ExceptionListener. Parameters topic_ Sets the name of the bookmark store SOW topic to be used. It defaults to '/ADMIN/bookmark_store' if null. Parameters clientNameField_ Sets the name of the field for the trackedClientName in the bookmark store SOW topic. It defaults to 'clientName' if null. Parameters bookmarkField_ Sets the name of the field for the bookmark in the bookmark store SOW topic. It defaults to 'bookmark' if null.

SOWRecoveryPointAdapter() [2/2]

AMPS.Client.SOWRecoveryPointAdapter.SOWRecoveryPointAdapter ( Client  client_, string  trackedClientName_  )

inline

Creates a new SOWRecoveryPointAdapter with default properties for NOT closing the provided client, using the ExceptionListener, no timeout for sow query of publshFlush, and a SOW topic of /ADMIN/bookmark_store with fields clientName, subId, and bookmark.

Parameters

client_

The Client or HAClient connected to the AMPS server containing the SOW where bookmarks are tracked. This client MUST NOT be the same as the client being tracked. Parameters trackedClientName_ The name of the client whose bookmarks are being tracked.

Member Function Documentation

close()

void AMPS.Client.SOWRecoveryPointAdapter.close ( )

inline

Take any necessary actions to close the underlying storage.

Implements AMPS.Client.RecoveryPointAdapter.

GetEnumerator()

IEnumerator<RecoveryPoint> AMPS.Client.SOWRecoveryPointAdapter.GetEnumerator ( )

inline

Return an enumerator over recovered RecoveryPoints.

MoveNext()

bool AMPS.Client.SOWRecoveryPointAdapter.MoveNext ( )

inline

IEnumerator move to next item.

purge() [1/2]

void AMPS.Client.SOWRecoveryPointAdapter.purge ( )

inline

Remove all recovery point information.

Implements AMPS.Client.RecoveryPointAdapter.

purge() [2/2]

void AMPS.Client.SOWRecoveryPointAdapter.purge ( Field  subId_ )

inline

Remove all recovery point information for a given sub id.

Implements AMPS.Client.RecoveryPointAdapter.

Reset()

void AMPS.Client.SOWRecoveryPointAdapter.Reset ( )

inline

IEnumerator reset - not implemented.

setExceptionListener()

void AMPS.Client.SOWRecoveryPointAdapter.setExceptionListener ( ExceptionListener  exceptionListener )

inline

Sets the ExceptionListener instance used for communicating absorbed exceptions.

Parameters

exceptionListener

The exception listener instance to invoke for exceptions.

update()

void AMPS.Client.SOWRecoveryPointAdapter.update ( RecoveryPoint  recoveryPoint_ )

inline

Process an update to the newest recovery point.

Implements AMPS.Client.RecoveryPointAdapter.

Property Documentation

Current

RecoveryPoint AMPS.Client.SOWRecoveryPointAdapter.Current

get

The current RecoveryPoint from SOW recovery for the client.

---

The documentation for this class was generated from the following file:

• AMPS.Client/SOWRecoveryPointAdapter.cs