Inheritance diagram for AMPS.Client.RingBookmarkStore:

Public Member Functions
	RingBookmarkStore (string path)
	Initializes a new instance of the RingBookmarkStore class with the specified path. More...

	RingBookmarkStore (string path, int targetNumberOfSubscriptions)
	Initializes a new instance of the RingBookmarkStore class with the specified path and target number of subscriptions. More...

long	log (Message message)
	Logs a message and returns the bookmark sequence number. More...

void	discard (Field subId, long bookmarkSeqNo)
	Discards a message with the specified subId and bookmark sequence number. More...

void	discard (Message message)
	Discards the message. More...

Field	getMostRecent (Field subId, bool useList=true)
	Retrieves the most recent message for the specified subId. More...

bool	isDiscarded (Message message)
	Checks if the message is discarded. More...

void	persisted (Field subId, BookmarkField bookmark)
	Marks the specified bookmark as persisted. More...

void	persisted (Field subId, long bookmark)
	Marks the specified bookmark as persisted. More...

long	getOldestBookmarkSeq (Field subId)
	Retrieves the oldest bookmark sequence number for the specified subscription ID. More...

void	setResizeHandler (BookmarkStoreResizeHandler handler)
	Sets the resize handler for the bookmark store. More...

void	purge ()
	Purges the bookmark store. More...

void	purge (Field subId_)
	Purges the specified subscription from the bookmark store. More...

void	Dispose ()
	Disposes of the resources used by the RingBookmarkStore. More...

void	setServerVersion (int version)
	Sets the server version for the bookmark store. More...

Constructor & Destructor Documentation

◆ RingBookmarkStore() [1/2]

AMPS.Client.RingBookmarkStore.RingBookmarkStore ( string path )

inline

Initializes a new instance of the RingBookmarkStore class with the specified path.

Parameters

path	The path to the file.

◆ RingBookmarkStore() [2/2]

AMPS.Client.RingBookmarkStore.RingBookmarkStore	(	string	path,
		int	targetNumberOfSubscriptions
	)

inline

Initializes a new instance of the RingBookmarkStore class with the specified path and target number of subscriptions.

Parameters

path	The path to the file.
targetNumberOfSubscriptions	The target number of subscriptions.

Member Function Documentation

◆ discard() [1/2]

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

inline

Discards a message with the specified subId and bookmark sequence number.

Parameters

subId	The subscription ID.
bookmarkSeqNo	The bookmark sequence number.

Implements AMPS.Client.BookmarkStore.

◆ discard() [2/2]

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

inline

Discards the message.

Parameters

message The message to discard.

Implements AMPS.Client.BookmarkStore.

◆ Dispose()

void AMPS.Client.RingBookmarkStore.Dispose ( )

inline

Disposes of the resources used by the RingBookmarkStore.

◆ getMostRecent()

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

inline

Retrieves the most recent message for the specified subId.

Parameters

subId	The subscription ID.
useList	Flag indicating whether to use list.

Returns: The most recent message.

Implements AMPS.Client.BookmarkStore.

◆ getOldestBookmarkSeq()

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

inline

Retrieves the oldest bookmark sequence number for the specified subscription ID.

Parameters

subId The subscription ID.

Returns: The oldest bookmark sequence number.

Implements AMPS.Client.BookmarkStore.

◆ isDiscarded()

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

inline

Checks if the message is discarded.

Parameters

message The message to check.

Returns: True if the message is discarded; otherwise, false.

Implements AMPS.Client.BookmarkStore.

◆ log()

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

inline

Logs a message and returns the bookmark sequence number.

Parameters

message The message to log.

Returns: The bookmark sequence number.

Implements AMPS.Client.BookmarkStore.

◆ persisted() [1/2]

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

inline

Marks the specified bookmark as persisted.

Parameters

subId	The subscription ID.
bookmark	The bookmark to mark as persisted.

Implements AMPS.Client.BookmarkStore.

◆ persisted() [2/2]

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

inline

Marks the specified bookmark as persisted.

Parameters

subId	The subscription ID.
bookmark	The bookmark to mark as persisted.

Implements AMPS.Client.BookmarkStore.

◆ purge() [1/2]

void AMPS.Client.RingBookmarkStore.purge ( )

inline

Purges the bookmark store.

Implements AMPS.Client.BookmarkStore.

◆ purge() [2/2]

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

inline

Purges the specified subscription from the bookmark store.

Parameters

subId_ The subscription ID to purge.

Implements AMPS.Client.BookmarkStore.

◆ setResizeHandler()

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

inline

Sets the resize handler for the bookmark store.

Parameters

handler The resize handler to set.

Implements AMPS.Client.BookmarkStore.

◆ setServerVersion()

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

inline

Sets the server version for the bookmark store.

Parameters

version The server version to set.

Implements AMPS.Client.BookmarkStore.

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

AMPS.Client/RingBookmarkStore.cs

Public Member Functions

Constructor & Destructor Documentation

◆ RingBookmarkStore() [1/2]

◆ RingBookmarkStore() [2/2]

Member Function Documentation

◆ discard() [1/2]

◆ discard() [2/2]

◆ Dispose()

◆ getMostRecent()

◆ getOldestBookmarkSeq()

◆ isDiscarded()

◆ log()

◆ persisted() [1/2]

◆ persisted() [2/2]

◆ purge() [1/2]

◆ purge() [2/2]

◆ setResizeHandler()

◆ setServerVersion()