Inheritance diagram for AMPS.Client.BookmarkStore:
Public Member Functions | |
| long | log (Message mesage) |
| void | discard (Field subId, long bookmarkSeqNo) |
| void | discard (Message message) |
| Field | getMostRecent (Field subId, bool useList=true) |
| bool | isDiscarded (Message message) |
| void | purge (Field subId) |
| void | purge () |
| void | setResizeHandler (BookmarkStoreResizeHandler handler) |
| long | getOldestBookmarkSeq (Field subId) |
| void | persisted (Field subId, BookmarkField bookmark) |
| void | persisted (Field subId, long bookmarkSeqNo) |
| void | setServerVersion (int version) |
Member Function Documentation
◆ discard() [1/2]
| void AMPS.Client.BookmarkStore.discard | ( | Field | subId, |
| long | bookmarkSeqNo | ||
| ) |
Log a discard-bookmark entry to the persistent log based on a bookmark sequence number.
Implemented in AMPS.Client.DefaultBookmarkStore, AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, and AMPS.Client.LoggedBookmarkStore.
◆ discard() [2/2]
| void AMPS.Client.BookmarkStore.discard | ( | Message | message | ) |
Log a discard-bookmark entry to the persistent log based on a Message.
Implemented in AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, AMPS.Client.LoggedBookmarkStore, and AMPS.Client.DefaultBookmarkStore.
◆ getMostRecent()
Returns the most recent bookmark from the log that ought to be used for (re-)subscriptions.
Implemented in AMPS.Client.DefaultBookmarkStore, AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, and AMPS.Client.LoggedBookmarkStore.
◆ getOldestBookmarkSeq()
| long AMPS.Client.BookmarkStore.getOldestBookmarkSeq | ( | Field | subId | ) |
Called to retrieve the sequence number of the oldest bookmark in the store.
Implemented in AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, AMPS.Client.LoggedBookmarkStore, and AMPS.Client.DefaultBookmarkStore.
◆ isDiscarded()
| bool AMPS.Client.BookmarkStore.isDiscarded | ( | Message | message | ) |
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.
Implemented in AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, AMPS.Client.LoggedBookmarkStore, and AMPS.Client.DefaultBookmarkStore.
◆ log()
| long AMPS.Client.BookmarkStore.log | ( | Message | mesage | ) |
Log a bookmark to the persistent log.
- Returns
- the corresponding bookmark sequence number for this bookmark
Implemented in AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, AMPS.Client.LoggedBookmarkStore, and AMPS.Client.DefaultBookmarkStore.
◆ persisted() [1/2]
| void AMPS.Client.BookmarkStore.persisted | ( | Field | subId, |
| BookmarkField | bookmark | ||
| ) |
Called to mark a message as safely persisted by AMPS to all of its sync replication destination.
Implemented in AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, AMPS.Client.LoggedBookmarkStore, and AMPS.Client.DefaultBookmarkStore.
◆ persisted() [2/2]
| void AMPS.Client.BookmarkStore.persisted | ( | Field | subId, |
| long | bookmarkSeqNo | ||
| ) |
Called to mark a message as safely persisted by AMPS to all of its sync replication destination.
Implemented in AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, AMPS.Client.LoggedBookmarkStore, and AMPS.Client.DefaultBookmarkStore.
◆ purge() [1/2]
| void AMPS.Client.BookmarkStore.purge | ( | ) |
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.
Implemented in AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, AMPS.Client.LoggedBookmarkStore, and AMPS.Client.DefaultBookmarkStore.
◆ purge() [2/2]
| void AMPS.Client.BookmarkStore.purge | ( | Field | subId | ) |
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.
Implemented in AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, AMPS.Client.LoggedBookmarkStore, and AMPS.Client.DefaultBookmarkStore.
◆ setResizeHandler()
| void AMPS.Client.BookmarkStore.setResizeHandler | ( | BookmarkStoreResizeHandler | handler | ) |
Called to set a resize handler that is invoked when the store needs to resize.
Implemented in AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, AMPS.Client.LoggedBookmarkStore, and AMPS.Client.DefaultBookmarkStore.
◆ setServerVersion()
| void AMPS.Client.BookmarkStore.setServerVersion | ( | int | version | ) |
Called to set the version of the server used with this store.
Implemented in AMPS.Client.RingBookmarkStore, AMPS.Client.MemoryBookmarkStore, AMPS.Client.LoggedBookmarkStore, and AMPS.Client.DefaultBookmarkStore.
The documentation for this interface was generated from the following file:
- AMPS.Client/BookmarkStore.cs
