AMPS C/C++ Client Class Reference
AMPS C/C++ Client Version 5.3.4.3
AMPS::MemoryBookmarkStore Class Reference

A BookmarkStoreImpl implementation that stores bookmarks in memory. More...

#include <MemoryBookmarkStore.hpp>

+ Inheritance diagram for AMPS::MemoryBookmarkStore:

Public Member Functions

 MemoryBookmarkStore ()
 Creates a MemoryBookmarkStore.
 
 MemoryBookmarkStore (const RecoveryPointAdapter &adapter_, RecoveryPointFactory factory_=NULL)
 Creates a MemoryBookmarkStore. More...
 
virtual size_t log (Message &message_)
 Log a bookmark to the persistent log and return the corresponding sequence number for this bookmark. More...
 
virtual void discard (const Message &message_)
 Log a discard-bookmark entry to the persistent log based on a bookmark sequence number. More...
 
virtual void discard (const Message::Field &subId_, size_t bookmarkSeqNo_)
 Log a discard-bookmark entry to the persistent log based on a bookmark sequence number. More...
 
virtual Message::Field getMostRecent (const Message::Field &subId_)
 Returns the most recent bookmark from the log that ought to be used for (re-)subscriptions. More...
 
virtual bool isDiscarded (Message &message_)
 Called for each arriving message to determine if the application has already seen this bookmark and should not be reprocessed. More...
 
virtual void purge ()
 Called to purge the contents of this store. More...
 
virtual void purge (const Message::Field &subId_)
 Called to purge the contents of this store for particular subId. More...
 
virtual size_t getOldestBookmarkSeq (const Message::Field &subId_)
 Called to find the oldest bookmark in the store. More...
 
virtual void persisted (const Message::Field &subId_, const Message::Field &bookmark_)
 Mark the bookmark provided as replicated to all sync replication destinations for the given subscription. More...
 
virtual Message::Field persisted (const Message::Field &subId_, size_t bookmark_)
 Mark the bookmark provided as replicated to all sync replication destinations for the given subscription. More...
 
void setServerVersion (const VersionInfo &version_)
 Internally used to set the server version so the store knows how to deal with persisted acks and calls to getMostRecent(). More...
 
void setServerVersion (size_t version_)
 Internally used to set the server version so the store knows how to deal with persisted acks and calls to getMostRecent(). More...
 
- Public Member Functions inherited from AMPS::BookmarkStoreImpl
virtual void setResizeHandler (BookmarkStoreResizeHandler handler_, void *userData_)
 Set a handler on the bookmark store that will get called whenever a resize of the store is required due to the number of stored bookmarks exceeding the currently allocated storage to hold them. More...
 
size_t getMaxSubIdLength () const
 Gets the maximum allowed length for a sub id when recovering a bookmark store from persistent storage. More...
 
void setMaxSubIdLength (size_t maxSubIdLength_)
 Sets the maximum allowed length for a sub id when recovering a bookmark store from persistent storage. More...
 

Detailed Description

A BookmarkStoreImpl implementation that stores bookmarks in memory.

This store protects against connectivity failures. This store does not persist the bookmark store, so this store cannot be used to resume subscriptions after application restart.

Constructor & Destructor Documentation

AMPS::MemoryBookmarkStore::MemoryBookmarkStore ( const RecoveryPointAdapter adapter_,
RecoveryPointFactory  factory_ = NULL 
)
inline

Creates a MemoryBookmarkStore.

Parameters
adapter_The RecoveryPointAdapter to notify about updates.
factory_An optional factory function to use to create the RecoveryPoint objects sent to the recoveryPointAdapter_.

Member Function Documentation

virtual void AMPS::MemoryBookmarkStore::discard ( const Message message_)
inlinevirtual

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

Parameters
message_The Message to discard.

Implements AMPS::BookmarkStoreImpl.

Reimplemented in AMPS::MMapBookmarkStore, AMPS::LoggedBookmarkStore, and AMPS::RingBookmarkStore.

virtual void AMPS::MemoryBookmarkStore::discard ( const Message::Field subId_,
size_t  bookmarkSeqNo_ 
)
inlinevirtual

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

Use the discard(const Message&) function instead when you have the full Message object available..

Parameters
subId_The id of the subscription to which the bookmark applies.
bookmarkSeqNo_The bookmark sequence number to discard.

Implements AMPS::BookmarkStoreImpl.

Reimplemented in AMPS::MMapBookmarkStore, AMPS::LoggedBookmarkStore, and AMPS::RingBookmarkStore.

virtual Message::Field AMPS::MemoryBookmarkStore::getMostRecent ( const Message::Field subId_)
inlinevirtual

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

Parameters
subId_The id of the subscription to check.

Implements AMPS::BookmarkStoreImpl.

Reimplemented in AMPS::MMapBookmarkStore, AMPS::LoggedBookmarkStore, and AMPS::RingBookmarkStore.

virtual size_t AMPS::MemoryBookmarkStore::getOldestBookmarkSeq ( const Message::Field subId_)
inlinevirtual

Called to find the oldest bookmark in the store.

Parameters
subId_The subscription ID on which to find the oldest bookmark.
Returns
The bookmark that is oldest in the store for subId_

Implements AMPS::BookmarkStoreImpl.

virtual bool AMPS::MemoryBookmarkStore::isDiscarded ( Message message_)
inlinevirtual

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.

Parameters
message_The Message to check.
Returns
Whether or not the Message has been discarded from this store.

Implements AMPS::BookmarkStoreImpl.

Reimplemented in AMPS::MMapBookmarkStore, and AMPS::LoggedBookmarkStore.

virtual size_t AMPS::MemoryBookmarkStore::log ( Message message_)
inlinevirtual

Log a bookmark to the persistent log and return the corresponding sequence number for this bookmark.

Parameters
message_The Message to log.

Implements AMPS::BookmarkStoreImpl.

Reimplemented in AMPS::MMapBookmarkStore, AMPS::LoggedBookmarkStore, and AMPS::RingBookmarkStore.

virtual void AMPS::MemoryBookmarkStore::persisted ( const Message::Field subId_,
const Message::Field bookmark_ 
)
inlinevirtual

Mark the bookmark provided as replicated to all sync replication destinations for the given subscription.

Parameters
subId_The subscription Id to which the bookmark applies.
bookmark_The most recent replicated bookmark.

Implements AMPS::BookmarkStoreImpl.

Reimplemented in AMPS::RingBookmarkStore.

virtual Message::Field AMPS::MemoryBookmarkStore::persisted ( const Message::Field subId_,
size_t  bookmark_ 
)
inlinevirtual

Mark the bookmark provided as replicated to all sync replication destinations for the given subscription.

Parameters
subId_The subscription Id to which the bookmark applies.
bookmark_The most recent bookmark's sequence number.
Returns
The bookmark field that was just marked persisted.

Implements AMPS::BookmarkStoreImpl.

virtual void AMPS::MemoryBookmarkStore::purge ( )
inlinevirtual

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::BookmarkStoreImpl.

Reimplemented in AMPS::MMapBookmarkStore, AMPS::LoggedBookmarkStore, and AMPS::RingBookmarkStore.

virtual void AMPS::MemoryBookmarkStore::purge ( const Message::Field subId_)
inlinevirtual

Called to purge the contents of this store for particular subId.

Removes any tracking history associated with publishers and received messages, and will remove the subId from the file as well.

Implements AMPS::BookmarkStoreImpl.

Reimplemented in AMPS::LoggedBookmarkStore, AMPS::MMapBookmarkStore, and AMPS::RingBookmarkStore.

void AMPS::MemoryBookmarkStore::setServerVersion ( const VersionInfo &  version_)
inlinevirtual

Internally used to set the server version so the store knows how to deal with persisted acks and calls to getMostRecent().

Parameters
version_The version of the server being used.

Implements AMPS::BookmarkStoreImpl.

Reimplemented in AMPS::MMapBookmarkStore.

void AMPS::MemoryBookmarkStore::setServerVersion ( size_t  version_)
inlinevirtual

Internally used to set the server version so the store knows how to deal with persisted acks and calls to getMostRecent().

Parameters
version_The version of the server being used.

Implements AMPS::BookmarkStoreImpl.

Reimplemented in AMPS::MMapBookmarkStore.


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