AMPS.Client.RingBookmarkStore Class Reference

Inheritance diagram for AMPS.Client.RingBookmarkStore:

Public Member Functions
	RingBookmarkStore (string path)
	RingBookmarkStore (string path, int targetNumberOfSubscriptions)
long	log (Message message)
void	discard (Field subId, long bookmarkSeqNo)
void	discard (Message message)
Field	getMostRecent (Field subId, bool useList=true)
bool	isDiscarded (Message message)
void	persisted (Field subId, BookmarkField bookmark)
void	persisted (Field subId, long bookmark)
long	getOldestBookmarkSeq (Field subId)
void	setResizeHandler (BookmarkStoreResizeHandler handler)
void	purge ()
void	purge (Field subId_)
void	Dispose ()
void	setServerVersion (int version)

Member Function Documentation

discard() [1/2]

void AMPS.Client.RingBookmarkStore.discard ( Field  subId, long  bookmarkSeqNo  )

inline

Log a discard-bookmark entry to the persistent log based on a bookmark sequence number.

Implements AMPS.Client.BookmarkStore.

discard() [2/2]

void AMPS.Client.RingBookmarkStore.discard ( Message  message )

inline

Log a discard-bookmark entry to the persistent log based on a Message.

Implements AMPS.Client.BookmarkStore.

getMostRecent()

Field AMPS.Client.RingBookmarkStore.getMostRecent ( Field  subId, bool  useList = true  )

inline

Returns the most recent bookmark from the log that ought to be used for (re-)subscriptions.

Implements AMPS.Client.BookmarkStore.

getOldestBookmarkSeq()

long AMPS.Client.RingBookmarkStore.getOldestBookmarkSeq ( Field  subId )

inline

Called to retrieve the sequence number of the oldest bookmark in the store.

Implements AMPS.Client.BookmarkStore.

isDiscarded()

bool AMPS.Client.RingBookmarkStore.isDiscarded ( Message  message )

inline

Called for each arriving message to determine if the application has already seen this bookmark and should not be reprocessed. Returns 'true' if the bookmark is in the log and should not be re-processed, false otherwise.

Implements AMPS.Client.BookmarkStore.

log()

long AMPS.Client.RingBookmarkStore.log ( Message  mesage )

inline

Log a bookmark to the persistent log.

Returns

the corresponding bookmark sequence number for this bookmark

Implements AMPS.Client.BookmarkStore.

persisted() [1/2]

void AMPS.Client.RingBookmarkStore.persisted ( Field  subId, BookmarkField  bookmark  )

inline

Called to mark a message as safely persisted by AMPS to all of its sync replication destination.

Implements AMPS.Client.BookmarkStore.

persisted() [2/2]

void AMPS.Client.RingBookmarkStore.persisted ( Field  subId, long  bookmarkSeqNo  )

inline

Called to mark a message as safely persisted by AMPS to all of its sync replication destination.

Implements AMPS.Client.BookmarkStore.

purge() [1/2]

void AMPS.Client.RingBookmarkStore.purge ( )

inline

Called to purge the contents of this store. Removes any tracking history associated with publishers and received messages, and may delete or truncate on-disk representations as well.

Implements AMPS.Client.BookmarkStore.

purge() [2/2]

void AMPS.Client.RingBookmarkStore.purge ( Field  subId )

inline

Called to purge the contents of this store for a given subId. Removes any tracking history associated with publishers and received messages, and may delete or truncate on-disk representations as well.

Implements AMPS.Client.BookmarkStore.

setResizeHandler()

void AMPS.Client.RingBookmarkStore.setResizeHandler ( BookmarkStoreResizeHandler  handler )

inline

Called to set a resize handler that is invoked when the store needs to resize.

Implements AMPS.Client.BookmarkStore.

setServerVersion()

void AMPS.Client.RingBookmarkStore.setServerVersion ( int  version )

inline

Called to set the version of the server used with this store.

Implements AMPS.Client.BookmarkStore.

---

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

• AMPS.Client/RingBookmarkStore.cs