Package org.apache.bookkeeper.mledger.impl

Class ManagedCursorImpl

java.lang.Object

org.apache.bookkeeper.mledger.impl.ManagedCursorImpl

All Implemented Interfaces:

ManagedCursor

Direct Known Subclasses:

NonDurableCursorImpl, ReadOnlyCursorImpl

public class ManagedCursorImpl
extends Object
implements ManagedCursor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ManagedCursorImpl.State
static interface	ManagedCursorImpl.VoidCallback

Nested classes/interfaces inherited from interface org.apache.bookkeeper.mledger.ManagedCursor

ManagedCursor.FindPositionConstraint, ManagedCursor.IndividualDeletedEntries

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConcurrentSkipListMap<PositionImpl,BitSetRecyclable>	batchDeletedIndexes
protected final BookKeeper	bookkeeper
protected final ManagedLedgerConfig	config
static final String	CURSOR_INTERNAL_PROPERTY_PREFIX
static final int	FALSE
protected final RangeSetWrapper<PositionImpl>	individualDeletedMessages
protected static final AtomicReferenceFieldUpdater<ManagedCursorImpl,PositionImpl>	INPROGRESS_MARKDELETE_PERSIST_POSITION_UPDATER
protected PositionImpl	inProgressMarkDeletePersistPosition
protected static final AtomicReferenceFieldUpdater<ManagedCursorImpl,org.apache.bookkeeper.mledger.impl.ManagedCursorImpl.MarkDeleteEntry>	LAST_MARK_DELETE_ENTRY_UPDATER
protected org.apache.bookkeeper.mledger.impl.ManagedCursorImpl.MarkDeleteEntry	lastMarkDeleteEntry
protected final ManagedLedgerImpl	ledger
protected PositionImpl	markDeletePosition
protected final ManagedCursorMXBean	mbean
protected long	messagesConsumedCounter
protected final ArrayDeque<org.apache.bookkeeper.mledger.impl.ManagedCursorImpl.MarkDeleteEntry>	pendingMarkDeleteOps
protected PositionImpl	persistentMarkDeletePosition
protected static final AtomicReferenceFieldUpdater<ManagedCursorImpl,PositionImpl>	READ_POSITION_UPDATER
protected PositionImpl	readPosition
protected ManagedCursorImpl.State	state
protected static final AtomicReferenceFieldUpdater<ManagedCursorImpl,ManagedCursorImpl.State>	STATE_UPDATER
protected PositionImpl	statsLastReadPosition
static final int	TRUE
protected static final AtomicReferenceFieldUpdater<ManagedCursorImpl,org.apache.bookkeeper.mledger.impl.OpReadEntry>	WAITING_READ_OP_UPDATER

Method Summary

Modifier and Type	Method	Description
int	applyMaxSizeCap(int maxEntries, long maxSizeBytes)
void	asyncClearBacklog(AsyncCallbacks.ClearBacklogCallback callback, Object ctx)	Clear the cursor backlog.
void	asyncClose(AsyncCallbacks.CloseCallback callback, Object ctx)	Close the cursor asynchronously and release the associated resources.
void	asyncDelete(Iterable<Position> positions, AsyncCallbacks.DeleteCallback callback, Object ctx)	Delete a group of messages asynchronously
void	asyncDelete(Position pos, AsyncCallbacks.DeleteCallback callback, Object ctx)	Delete a single message asynchronously
void	asyncFindNewestMatching(ManagedCursor.FindPositionConstraint constraint, Predicate<Entry> condition, AsyncCallbacks.FindEntryCallback callback, Object ctx)	Find the newest entry that matches the given predicate.
void	asyncFindNewestMatching(ManagedCursor.FindPositionConstraint constraint, Predicate<Entry> condition, AsyncCallbacks.FindEntryCallback callback, Object ctx, boolean isFindFromLedger)	Find the newest entry that matches the given predicate.
void	asyncGetNthEntry(int n, ManagedCursor.IndividualDeletedEntries deletedEntries, AsyncCallbacks.ReadEntryCallback callback, Object ctx)	Asynchronously get 'N'th entry from the mark delete position in the cursor without updating any cursor positions.
void	asyncMarkDelete(Position position, Map<String,Long> properties, AsyncCallbacks.MarkDeleteCallback callback, Object ctx)	Asynchronous mark delete.
void	asyncMarkDelete(Position position, AsyncCallbacks.MarkDeleteCallback callback, Object ctx)	Asynchronous mark delete.
void	asyncReadEntries(int numberOfEntriesToRead, long maxSizeBytes, AsyncCallbacks.ReadEntriesCallback callback, Object ctx, PositionImpl maxPosition)	Asynchronously read entries from the ManagedLedger.
void	asyncReadEntries(int numberOfEntriesToRead, AsyncCallbacks.ReadEntriesCallback callback, Object ctx, PositionImpl maxPosition)	Asynchronously read entries from the ManagedLedger.
void	asyncReadEntriesOrWait(int maxEntries, long maxSizeBytes, AsyncCallbacks.ReadEntriesCallback callback, Object ctx, PositionImpl maxPosition)	Asynchronously read entries from the ManagedLedger, up to the specified number and size.
void	asyncReadEntriesOrWait(int numberOfEntriesToRead, AsyncCallbacks.ReadEntriesCallback callback, Object ctx, PositionImpl maxPosition)	Asynchronously read entries from the ManagedLedger.
void	asyncReadEntriesWithSkip(int numberOfEntriesToRead, long maxSizeBytes, AsyncCallbacks.ReadEntriesCallback callback, Object ctx, PositionImpl maxPosition, Predicate<PositionImpl> skipCondition)	Asynchronously read entries from the ManagedLedger.
void	asyncReadEntriesWithSkipOrWait(int maxEntries, long maxSizeBytes, AsyncCallbacks.ReadEntriesCallback callback, Object ctx, PositionImpl maxPosition, Predicate<PositionImpl> skipCondition)	Asynchronously read entries from the ManagedLedger, up to the specified number and size.
void	asyncReadEntriesWithSkipOrWait(int maxEntries, AsyncCallbacks.ReadEntriesCallback callback, Object ctx, PositionImpl maxPosition, Predicate<PositionImpl> skipCondition)	Asynchronously read entries from the ManagedLedger, up to the specified number and size.
Set<? extends Position>	asyncReplayEntries(Set<? extends Position> positions, AsyncCallbacks.ReadEntriesCallback callback, Object ctx)	Async replays given positions: a.
Set<? extends Position>	asyncReplayEntries(Set<? extends Position> positions, AsyncCallbacks.ReadEntriesCallback callback, Object ctx, boolean sortEntries)	Read the specified set of positions from ManagedLedger.
void	asyncResetCursor(Position newPos, boolean forceReset, AsyncCallbacks.ResetCursorCallback callback)	reset the cursor to specified position to enable replay of messages.
void	asyncSkipEntries(int numEntriesToSkip, ManagedCursor.IndividualDeletedEntries deletedEntries, AsyncCallbacks.SkipEntriesCallback callback, Object ctx)	Skip n entries from the read position of this cursor.
boolean	cancelPendingReadRequest()	Cancel a previously scheduled asyncReadEntriesOrWait operation.
boolean	checkAndUpdateReadPositionChanged()	Checks if read position changed since this method was called last time.
void	clearBacklog()	Clear the cursor backlog.
void	close()	Close the cursor and releases the associated resources.
void	delete(Iterable<Position> positions)	Delete a group of entries.
void	delete(Position position)	Delete a single message.
ManagedCursor	duplicateNonDurableCursor(String nonDurableCursorName)	Create a non-durable cursor and copy the ack stats.
Position	findNewestMatching(Predicate<Entry> condition)	Find the newest entry that matches the given predicate.
Position	findNewestMatching(ManagedCursor.FindPositionConstraint constraint, Predicate<Entry> condition)	Find the newest entry that matches the given predicate.
long[]	getBatchPositionAckSet(Position position)
ManagedLedgerConfig	getConfig()
long	getCursorLedger()
long	getCursorLedgerLastEntry()
Map<String,String>	getCursorProperties()	Return any properties that were associated with the cursor.
long[]	getDeletedBatchIndexesAsLongArray(PositionImpl position)	Get deleted batch indexes list for a batch message.
long	getEstimatedSizeSinceMarkDeletePosition()	Returns the estimated size of the unacknowledged backlog for this cursor.
Position	getFirstPosition()	Get the first position.
String	getIndividuallyDeletedMessages()
LongPairRangeSet<PositionImpl>	getIndividuallyDeletedMessagesSet()
long	getLastActive()	Get the last active time of the cursor.
com.google.common.collect.Range<PositionImpl>	getLastIndividualDeletedRange()	Get last individual deleted range.
long	getLastLedgerSwitchTimestamp()
ManagedLedger	getManagedLedger()	Get ManagedLedger attached with cursor.
Position	getMarkDeletedPosition()	Get the newest mark deleted position on this cursor.
long	getMessagesConsumedCounter()
String	getName()	Get the unique cursor name.
PositionImpl	getNextAvailablePosition(PositionImpl position)	Checks given position is part of deleted-range and returns next position of upper-end as all the messages are deleted up to that point.
Position	getNextLedgerPosition(long currentLedgerId)
int	getNonContiguousDeletedMessagesRangeSerializedSize()	Returns the serialized size of mark-Delete ranges.
Entry	getNthEntry(int n, ManagedCursor.IndividualDeletedEntries deletedEntries)	Get 'N'th entry from the mark delete position in the cursor without updating any cursor positions.
long	getNumberOfEntries()	Return the number of messages that this cursor still has to read.
protected long	getNumberOfEntries(com.google.common.collect.Range<PositionImpl> range)
long	getNumberOfEntriesInBacklog(boolean isPrecise)	Return the number of non-deleted messages on this cursor.
long	getNumberOfEntriesInStorage()
long	getNumberOfEntriesSinceFirstNotAckedMessage()	Returns total number of entries from the first not-acked message to current dispatching position.
int	getPendingReadOpsCount()
Position	getPersistentMarkDeletedPosition()	Get the persistent newest mark deleted position on this cursor.
Map<String,Long>	getProperties()	Return any properties that were associated with the last stored position.
Position	getReadPosition()	Get the read position.
String	getState()
ManagedCursorMXBean	getStats()
double	getThrottleMarkDelete()	Returns cursor throttle mark-delete rate.
int	getTotalNonContiguousDeletedMessagesRange()	Returns number of mark-Delete range.
boolean	hasMoreEntries()	Tells whether this cursor has already consumed all the available entries.
boolean	hasPendingReadRequest()
protected void	internalAsyncMarkDelete(PositionImpl newPosition, Map<String,Long> properties, AsyncCallbacks.MarkDeleteCallback callback, Object ctx)
protected void	internalResetCursor(PositionImpl proposedReadPosition, AsyncCallbacks.ResetCursorCallback resetCursorCallback)
boolean	isActive()	Checks if cursor is active or not.
static boolean	isBkErrorNotRecoverable(int rc)	return BK error codes that are considered not likely to be recoverable.
boolean	isCacheReadEntry()
boolean	isClosed()	Checks if the cursor is closed.
boolean	isDurable()	Tells whether the cursor is durable or just kept in memory.
boolean	isIndividuallyDeletedEntriesEmpty()
boolean	isMessageDeleted(Position position)
void	markDelete(Position position)	This signals that the reader is done with all the entries up to "position" (included).
void	markDelete(Position position, Map<String,Long> properties)	This signals that the reader is done with all the entries up to "position" (included).
CompletableFuture<Void>	putCursorProperty(String key, String value)	Add a property associated with the cursor.
boolean	putProperty(String key, Long value)	Add a property associated with the last stored position.
List<Entry>	readEntries(int numberOfEntriesToRead)	Read entries from the ManagedLedger, up to the specified number.
List<Entry>	readEntriesOrWait(int numberOfEntriesToRead)	Read entries from the ManagedLedger, up to the specified number.
List<Entry>	readEntriesOrWait(int numberOfEntriesToRead, long maxSizeBytes)	Read entries from the ManagedLedger, up to the specified number and size.
protected void	recoverFromLedger(MLDataFormats.ManagedCursorInfo info, ManagedCursorImpl.VoidCallback callback)
CompletableFuture<Void>	removeCursorProperty(String key)	Remove a property associated with the cursor.
boolean	removeProperty(String key)	Remove a property associated with the last stored position.
List<Entry>	replayEntries(Set<? extends Position> positions)	Read the specified set of positions from ManagedLedger.
void	resetCursor(Position newPos)	reset the cursor to specified position to enable replay of messages.
void	rewind()	Rewind the cursor to the mark deleted position to replay all the already read but not yet mark deleted messages.
void	rewind(boolean readCompacted)
CompletableFuture<ScanOutcome>	scan(Optional<Position> position, Predicate<Entry> condition, int batchSize, long maxEntries, long timeOutMs)	Scan the cursor from the current position up to the end.
void	seek(Position newReadPositionInt, boolean force)
void	setActive()	Activate cursor: EntryCacheManager caches entries only for activated-cursors.
void	setAlwaysInactive()	A cursor that is set as always-inactive will never trigger the caching of entries.
void	setCacheReadEntry(boolean cacheReadEntry)
CompletableFuture<Void>	setCursorProperties(Map<String,String> cursorProperties)	Set all properties associated with the cursor, but internal properties(start with '#pulsar_internal.') are still preserved and prohibit setting of internal properties by this method.
void	setInactive()	Deactivate cursor.
void	setState(ManagedCursorImpl.State state)
void	setThrottleMarkDelete(double throttleMarkDelete)	Update throttle mark delete rate.
void	skipEntries(int numEntriesToSkip, ManagedCursor.IndividualDeletedEntries deletedEntries)	Skip n entries from the read position of this cursor.
void	skipNonRecoverableLedger(long ledgerId)	Manually acknowledge all entries in the lost ledger.
String	toString()
void	trimDeletedEntries(List<Entry> entries)	Trim delete entries for the given entries.
void	updateLastActive()	Update the last active time of the cursor.
void	updateReadStats(int readEntriesCount, long readEntriesSize)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.bookkeeper.mledger.ManagedCursor

seek

Field Details

bookkeeper

protected final BookKeeper bookkeeper

config

protected final ManagedLedgerConfig config

ledger

protected final ManagedLedgerImpl ledger

CURSOR_INTERNAL_PROPERTY_PREFIX

public static final String CURSOR_INTERNAL_PROPERTY_PREFIX

See Also:

• Constant Field Values

markDeletePosition

protected volatile PositionImpl markDeletePosition

persistentMarkDeletePosition

protected volatile PositionImpl persistentMarkDeletePosition

INPROGRESS_MARKDELETE_PERSIST_POSITION_UPDATER

protected static final AtomicReferenceFieldUpdater<ManagedCursorImpl,PositionImpl> INPROGRESS_MARKDELETE_PERSIST_POSITION_UPDATER

inProgressMarkDeletePersistPosition

protected volatile PositionImpl inProgressMarkDeletePersistPosition

READ_POSITION_UPDATER

protected static final AtomicReferenceFieldUpdater<ManagedCursorImpl,PositionImpl> READ_POSITION_UPDATER

readPosition

protected volatile PositionImpl readPosition

statsLastReadPosition

protected volatile PositionImpl statsLastReadPosition

LAST_MARK_DELETE_ENTRY_UPDATER

protected static final AtomicReferenceFieldUpdater<ManagedCursorImpl,org.apache.bookkeeper.mledger.impl.ManagedCursorImpl.MarkDeleteEntry> LAST_MARK_DELETE_ENTRY_UPDATER

lastMarkDeleteEntry

protected volatile org.apache.bookkeeper.mledger.impl.ManagedCursorImpl.MarkDeleteEntry lastMarkDeleteEntry

WAITING_READ_OP_UPDATER

protected static final AtomicReferenceFieldUpdater<ManagedCursorImpl,org.apache.bookkeeper.mledger.impl.OpReadEntry> WAITING_READ_OP_UPDATER

FALSE

public static final int FALSE

See Also:

• Constant Field Values

TRUE

public static final int TRUE

See Also:

• Constant Field Values

messagesConsumedCounter

protected volatile long messagesConsumedCounter

individualDeletedMessages

protected final RangeSetWrapper<PositionImpl> individualDeletedMessages

batchDeletedIndexes

protected final ConcurrentSkipListMap<PositionImpl,BitSetRecyclable> batchDeletedIndexes

pendingMarkDeleteOps

protected final ArrayDeque<org.apache.bookkeeper.mledger.impl.ManagedCursorImpl.MarkDeleteEntry> pendingMarkDeleteOps

STATE_UPDATER

protected static final AtomicReferenceFieldUpdater<ManagedCursorImpl,ManagedCursorImpl.State> STATE_UPDATER

state

protected volatile ManagedCursorImpl.State state

mbean

protected final ManagedCursorMXBean mbean

Method Details

getProperties

public Map<String,Long> getProperties()

Description copied from interface: ManagedCursor

Return any properties that were associated with the last stored position.

Specified by:

getProperties in interface ManagedCursor

getCursorProperties

public Map<String,String> getCursorProperties()

Description copied from interface: ManagedCursor

Return any properties that were associated with the cursor.

Specified by:

getCursorProperties in interface ManagedCursor

setCursorProperties

public CompletableFuture<Void> setCursorProperties(Map<String,String> cursorProperties)

Description copied from interface: ManagedCursor

Set all properties associated with the cursor, but internal properties(start with '#pulsar_internal.') are still preserved and prohibit setting of internal properties by this method. Note: ManagedLedgerException.BadVersionException will be set in this CompletableFuture, if there are concurrent modification and store data has changed.

Specified by:

setCursorProperties in interface ManagedCursor

Returns:

a handle to the result of the operation

putCursorProperty

public CompletableFuture<Void> putCursorProperty(String key,
 String value)

Description copied from interface: ManagedCursor

Add a property associated with the cursor. Note: ManagedLedgerException.BadVersionException will be set in this CompletableFuture, if there are concurrent modification and store data has changed.

Specified by:

putCursorProperty in interface ManagedCursor

Returns:

a handle to the result of the operation

removeCursorProperty

public CompletableFuture<Void> removeCursorProperty(String key)

Description copied from interface: ManagedCursor

Remove a property associated with the cursor. Note: ManagedLedgerException.BadVersionException will be set in this CompletableFuture, if there are concurrent modification and store data has changed.

Specified by:

removeCursorProperty in interface ManagedCursor

Returns:

a handle to the result of the operation

putProperty

public boolean putProperty(String key,
 Long value)

Description copied from interface: ManagedCursor

Add a property associated with the last stored position.

Specified by:

putProperty in interface ManagedCursor

removeProperty

public boolean removeProperty(String key)

Description copied from interface: ManagedCursor

Remove a property associated with the last stored position.

Specified by:

removeProperty in interface ManagedCursor

recoverFromLedger

protected void recoverFromLedger(MLDataFormats.ManagedCursorInfo info,
 ManagedCursorImpl.VoidCallback callback)

readEntries

public List<Entry> readEntries(int numberOfEntriesToRead)
                        throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Read entries from the ManagedLedger, up to the specified number. The returned list can be smaller.

Specified by:

readEntries in interface ManagedCursor

Parameters:

numberOfEntriesToRead - maximum number of entries to return

Returns:

the list of entries

Throws:

ManagedLedgerException

InterruptedException

asyncReadEntries

public void asyncReadEntries(int numberOfEntriesToRead,
 AsyncCallbacks.ReadEntriesCallback callback,
 Object ctx,
 PositionImpl maxPosition)

Description copied from interface: ManagedCursor

Asynchronously read entries from the ManagedLedger.

Specified by:

asyncReadEntries in interface ManagedCursor

Parameters:

numberOfEntriesToRead - maximum number of entries to return

callback - callback object

ctx - opaque context

maxPosition - max position can read

See Also:

• ManagedCursor.readEntries(int)

asyncReadEntries

public void asyncReadEntries(int numberOfEntriesToRead,
 long maxSizeBytes,
 AsyncCallbacks.ReadEntriesCallback callback,
 Object ctx,
 PositionImpl maxPosition)

Description copied from interface: ManagedCursor

Asynchronously read entries from the ManagedLedger.

Specified by:

asyncReadEntries in interface ManagedCursor

Parameters:

numberOfEntriesToRead - maximum number of entries to return

maxSizeBytes - max size in bytes of the entries to return

callback - callback object

ctx - opaque context

maxPosition - max position can read

asyncReadEntriesWithSkip

public void asyncReadEntriesWithSkip(int numberOfEntriesToRead,
 long maxSizeBytes,
 AsyncCallbacks.ReadEntriesCallback callback,
 Object ctx,
 PositionImpl maxPosition,
 Predicate<PositionImpl> skipCondition)

Description copied from interface: ManagedCursor

Asynchronously read entries from the ManagedLedger.

Specified by:

asyncReadEntriesWithSkip in interface ManagedCursor

Parameters:

numberOfEntriesToRead - maximum number of entries to return

maxSizeBytes - max size in bytes of the entries to return

callback - callback object

ctx - opaque context

maxPosition - max position can read

skipCondition - predicate of read filter out

getNthEntry

public Entry getNthEntry(int n,
 ManagedCursor.IndividualDeletedEntries deletedEntries)
                  throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Get 'N'th entry from the mark delete position in the cursor without updating any cursor positions.

Specified by:

getNthEntry in interface ManagedCursor

Parameters:

n - entry position

deletedEntries - skip individual deleted entries

Returns:

the entry

Throws:

InterruptedException

ManagedLedgerException

asyncGetNthEntry

public void asyncGetNthEntry(int n,
 ManagedCursor.IndividualDeletedEntries deletedEntries,
 AsyncCallbacks.ReadEntryCallback callback,
 Object ctx)

Description copied from interface: ManagedCursor

Asynchronously get 'N'th entry from the mark delete position in the cursor without updating any cursor positions.

Specified by:

asyncGetNthEntry in interface ManagedCursor

Parameters:

n - entry position

deletedEntries - skip individual deleted entries

readEntriesOrWait

public List<Entry> readEntriesOrWait(int numberOfEntriesToRead)
                              throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Read entries from the ManagedLedger, up to the specified number. The returned list can be smaller.

If no entries are available, the method will block until at least a new message will be persisted.

Specified by:

readEntriesOrWait in interface ManagedCursor

Parameters:

numberOfEntriesToRead - maximum number of entries to return

Returns:

the list of entries

Throws:

ManagedLedgerException

InterruptedException

readEntriesOrWait

public List<Entry> readEntriesOrWait(int numberOfEntriesToRead,
 long maxSizeBytes)
                              throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Read entries from the ManagedLedger, up to the specified number and size.

If no entries are available, the method will block until at least a new message will be persisted.

Specified by:

readEntriesOrWait in interface ManagedCursor

Parameters:

numberOfEntriesToRead - maximum number of entries to return

maxSizeBytes - max size in bytes of the entries to return

Returns:

the list of entries

Throws:

ManagedLedgerException

InterruptedException

asyncReadEntriesOrWait

public void asyncReadEntriesOrWait(int numberOfEntriesToRead,
 AsyncCallbacks.ReadEntriesCallback callback,
 Object ctx,
 PositionImpl maxPosition)

Description copied from interface: ManagedCursor

Asynchronously read entries from the ManagedLedger.

If no entries are available, the callback will not be triggered. Instead it will be registered to wait until a new message will be persisted into the managed ledger

Specified by:

asyncReadEntriesOrWait in interface ManagedCursor

Parameters:

numberOfEntriesToRead - maximum number of entries to return

callback - callback object

ctx - opaque context

maxPosition - max position can read

See Also:

• ManagedCursor.readEntriesOrWait(int)

asyncReadEntriesOrWait

public void asyncReadEntriesOrWait(int maxEntries,
 long maxSizeBytes,
 AsyncCallbacks.ReadEntriesCallback callback,
 Object ctx,
 PositionImpl maxPosition)

Description copied from interface: ManagedCursor

Asynchronously read entries from the ManagedLedger, up to the specified number and size.

If no entries are available, the callback will not be triggered. Instead it will be registered to wait until a new message will be persisted into the managed ledger

Specified by:

asyncReadEntriesOrWait in interface ManagedCursor

Parameters:

maxEntries - maximum number of entries to return

maxSizeBytes - max size in bytes of the entries to return

callback - callback object

ctx - opaque context

maxPosition - max position can read

See Also:

• ManagedCursor.readEntriesOrWait(int, long)

asyncReadEntriesWithSkipOrWait

public void asyncReadEntriesWithSkipOrWait(int maxEntries,
 AsyncCallbacks.ReadEntriesCallback callback,
 Object ctx,
 PositionImpl maxPosition,
 Predicate<PositionImpl> skipCondition)

Description copied from interface: ManagedCursor

Asynchronously read entries from the ManagedLedger, up to the specified number and size.

If no entries are available, the callback will not be triggered. Instead it will be registered to wait until a new message will be persisted into the managed ledger

Specified by:

asyncReadEntriesWithSkipOrWait in interface ManagedCursor

Parameters:

maxEntries - maximum number of entries to return

callback - callback object

ctx - opaque context

maxPosition - max position can read

skipCondition - predicate of read filter out

See Also:

• ManagedCursor.readEntriesOrWait(int, long)

asyncReadEntriesWithSkipOrWait

public void asyncReadEntriesWithSkipOrWait(int maxEntries,
 long maxSizeBytes,
 AsyncCallbacks.ReadEntriesCallback callback,
 Object ctx,
 PositionImpl maxPosition,
 Predicate<PositionImpl> skipCondition)

Description copied from interface: ManagedCursor

Asynchronously read entries from the ManagedLedger, up to the specified number and size.

If no entries are available, the callback will not be triggered. Instead it will be registered to wait until a new message will be persisted into the managed ledger

Specified by:

asyncReadEntriesWithSkipOrWait in interface ManagedCursor

Parameters:

maxEntries - maximum number of entries to return

maxSizeBytes - max size in bytes of the entries to return

callback - callback object

ctx - opaque context

maxPosition - max position can read

skipCondition - predicate of read filter out

See Also:

• ManagedCursor.readEntriesOrWait(int, long)

isClosed

public boolean isClosed()

Description copied from interface: ManagedCursor

Checks if the cursor is closed.

Specified by:

isClosed in interface ManagedCursor

Returns:

whether this cursor is closed.

cancelPendingReadRequest

public boolean cancelPendingReadRequest()

Description copied from interface: ManagedCursor

Cancel a previously scheduled asyncReadEntriesOrWait operation.

Specified by:

cancelPendingReadRequest in interface ManagedCursor

Returns:

true if the read operation was canceled or false if there was no pending operation

See Also:

• ManagedCursor.asyncReadEntriesOrWait(int, ReadEntriesCallback, Object, PositionImpl)

hasPendingReadRequest

public boolean hasPendingReadRequest()

hasMoreEntries

public boolean hasMoreEntries()

Description copied from interface: ManagedCursor

Tells whether this cursor has already consumed all the available entries.

This method is not blocking.

Specified by:

hasMoreEntries in interface ManagedCursor

Returns:

true if there are pending entries to read, false otherwise

getNumberOfEntries

public long getNumberOfEntries()

Description copied from interface: ManagedCursor

Return the number of messages that this cursor still has to read.

This method has linear time complexity on the number of ledgers included in the managed ledger.

Specified by:

getNumberOfEntries in interface ManagedCursor

Returns:

the number of entries

getNumberOfEntriesSinceFirstNotAckedMessage

public long getNumberOfEntriesSinceFirstNotAckedMessage()

Description copied from interface: ManagedCursor

Returns total number of entries from the first not-acked message to current dispatching position.

Specified by:

getNumberOfEntriesSinceFirstNotAckedMessage in interface ManagedCursor

Returns:

getTotalNonContiguousDeletedMessagesRange

public int getTotalNonContiguousDeletedMessagesRange()

Description copied from interface: ManagedCursor

Returns number of mark-Delete range.

Specified by:

getTotalNonContiguousDeletedMessagesRange in interface ManagedCursor

Returns:

getNonContiguousDeletedMessagesRangeSerializedSize

public int getNonContiguousDeletedMessagesRangeSerializedSize()

Description copied from interface: ManagedCursor

Returns the serialized size of mark-Delete ranges.

Specified by:

getNonContiguousDeletedMessagesRangeSerializedSize in interface ManagedCursor

getEstimatedSizeSinceMarkDeletePosition

public long getEstimatedSizeSinceMarkDeletePosition()

Description copied from interface: ManagedCursor

Returns the estimated size of the unacknowledged backlog for this cursor.

Specified by:

getEstimatedSizeSinceMarkDeletePosition in interface ManagedCursor

Returns:

the estimated size from the mark delete position of the cursor

getNumberOfEntriesInBacklog

public long getNumberOfEntriesInBacklog(boolean isPrecise)

Description copied from interface: ManagedCursor

Return the number of non-deleted messages on this cursor.

This will also include messages that have already been read from the cursor but not deleted or mark-deleted yet.

This method has linear time complexity on the number of ledgers included in the managed ledger.

Specified by:

getNumberOfEntriesInBacklog in interface ManagedCursor

Parameters:

isPrecise - set to true to get precise backlog count

Returns:

the number of entries

getNumberOfEntriesInStorage

public long getNumberOfEntriesInStorage()

findNewestMatching

public Position findNewestMatching(Predicate<Entry> condition)
                            throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Find the newest entry that matches the given predicate. Will only search among active entries

Specified by:

findNewestMatching in interface ManagedCursor

Parameters:

condition - predicate that reads an entry an applies a condition

Returns:

Position of the newest entry that matches the given predicate

Throws:

InterruptedException

ManagedLedgerException

scan

public CompletableFuture<ScanOutcome> scan(Optional<Position> position,
 Predicate<Entry> condition,
 int batchSize,
 long maxEntries,
 long timeOutMs)

Description copied from interface: ManagedCursor

Scan the cursor from the current position up to the end. Please note that this is an expensive operation

Specified by:

scan in interface ManagedCursor

Parameters:

position - the position to start from, if not provided the scan will start from the lastDeleteMarkPosition

condition - a condition to continue the scan, the condition can access the entry

batchSize - number of entries to process at each read

maxEntries - maximum number of entries to scan

timeOutMs - maximum time to spend on this operation

findNewestMatching

public Position findNewestMatching(ManagedCursor.FindPositionConstraint constraint,
 Predicate<Entry> condition)
                            throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Find the newest entry that matches the given predicate.

Specified by:

findNewestMatching in interface ManagedCursor

Parameters:

constraint - search only active entries or all entries

condition - predicate that reads an entry an applies a condition

Returns:

Position of the newest entry that matches the given predicate

Throws:

InterruptedException

ManagedLedgerException

asyncFindNewestMatching

public void asyncFindNewestMatching(ManagedCursor.FindPositionConstraint constraint,
 Predicate<Entry> condition,
 AsyncCallbacks.FindEntryCallback callback,
 Object ctx)

Description copied from interface: ManagedCursor

Find the newest entry that matches the given predicate.

Specified by:

asyncFindNewestMatching in interface ManagedCursor

Parameters:

constraint - search only active entries or all entries

condition - predicate that reads an entry an applies a condition

callback - callback object returning the resultant position

ctx - opaque context

asyncFindNewestMatching

public void asyncFindNewestMatching(ManagedCursor.FindPositionConstraint constraint,
 Predicate<Entry> condition,
 AsyncCallbacks.FindEntryCallback callback,
 Object ctx,
 boolean isFindFromLedger)

Description copied from interface: ManagedCursor

Find the newest entry that matches the given predicate.

Specified by:

asyncFindNewestMatching in interface ManagedCursor

Parameters:

constraint - search only active entries or all entries

condition - predicate that reads an entry an applies a condition

callback - callback object returning the resultant position

ctx - opaque context

isFindFromLedger - find the newest entry from ledger

setActive

public void setActive()

Description copied from interface: ManagedCursor

Activate cursor: EntryCacheManager caches entries only for activated-cursors.

Specified by:

setActive in interface ManagedCursor

isActive

public boolean isActive()

Description copied from interface: ManagedCursor

Checks if cursor is active or not.

Specified by:

isActive in interface ManagedCursor

Returns:

setInactive

public void setInactive()

Description copied from interface: ManagedCursor

Deactivate cursor.

Specified by:

setInactive in interface ManagedCursor

setAlwaysInactive

public void setAlwaysInactive()

Description copied from interface: ManagedCursor

A cursor that is set as always-inactive will never trigger the caching of entries.

Specified by:

setAlwaysInactive in interface ManagedCursor

getFirstPosition

public Position getFirstPosition()

Description copied from interface: ManagedCursor

Get the first position.

Specified by:

getFirstPosition in interface ManagedCursor

Returns:

the first position

internalResetCursor

protected void internalResetCursor(PositionImpl proposedReadPosition,
 AsyncCallbacks.ResetCursorCallback resetCursorCallback)

asyncResetCursor

public void asyncResetCursor(Position newPos,
 boolean forceReset,
 AsyncCallbacks.ResetCursorCallback callback)

Description copied from interface: ManagedCursor

reset the cursor to specified position to enable replay of messages.

Specified by:

asyncResetCursor in interface ManagedCursor

Parameters:

newPos - position to move the cursor to

forceReset - whether to force reset the position even if the position is no longer in the managed ledger, this is used by compacted topic which has data in the compacted ledger, to ensure the cursor can read data from the compacted ledger.

callback - callback object

resetCursor

public void resetCursor(Position newPos)
                 throws ManagedLedgerException,
InterruptedException

Description copied from interface: ManagedCursor

reset the cursor to specified position to enable replay of messages.

Specified by:

resetCursor in interface ManagedCursor

Parameters:

newPos - position to move the cursor to

Throws:

ManagedLedgerException

InterruptedException

replayEntries

public List<Entry> replayEntries(Set<? extends Position> positions)
                          throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Read the specified set of positions from ManagedLedger.

Specified by:

replayEntries in interface ManagedCursor

Parameters:

positions - set of positions to read

Returns:

the list of entries

Throws:

InterruptedException

ManagedLedgerException

asyncReplayEntries

public Set<? extends Position> asyncReplayEntries(Set<? extends Position> positions,
 AsyncCallbacks.ReadEntriesCallback callback,
 Object ctx)

Async replays given positions: a. before reading it filters out already-acked messages b. reads remaining entries async and gives it to given ReadEntriesCallback c. returns all already-acked messages which are not replayed so, those messages can be removed by caller(Dispatcher)'s replay-list and it won't try to replay it again

Specified by:

asyncReplayEntries in interface ManagedCursor

Parameters:

positions - set of positions to read

callback - callback object returning the list of entries

ctx - opaque context

Returns:

skipped positions set of positions which are already deleted/acknowledged and skipped while replaying them

asyncReplayEntries

public Set<? extends Position> asyncReplayEntries(Set<? extends Position> positions,
 AsyncCallbacks.ReadEntriesCallback callback,
 Object ctx,
 boolean sortEntries)

Description copied from interface: ManagedCursor

Read the specified set of positions from ManagedLedger.

Specified by:

asyncReplayEntries in interface ManagedCursor

Parameters:

positions - set of positions to read

callback - callback object returning the list of entries

ctx - opaque context

sortEntries - callback with sorted entry list.

Returns:

skipped positions set of positions which are already deleted/acknowledged and skipped while replaying them

getNumberOfEntries

protected long getNumberOfEntries(com.google.common.collect.Range<PositionImpl> range)

markDelete

public void markDelete(Position position)
                throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

This signals that the reader is done with all the entries up to "position" (included). This can potentially trigger a ledger deletion, if all the other cursors are done too with the underlying ledger.

Specified by:

markDelete in interface ManagedCursor

Parameters:

position - the last position that have been successfully consumed

Throws:

ManagedLedgerException

InterruptedException

markDelete

public void markDelete(Position position,
 Map<String,Long> properties)
                throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

This signals that the reader is done with all the entries up to "position" (included). This can potentially trigger a ledger deletion, if all the other cursors are done too with the underlying ledger.

Specified by:

markDelete in interface ManagedCursor

Parameters:

position - the last position that have been successfully consumed

properties - additional user-defined properties that can be associated with a particular cursor position

Throws:

ManagedLedgerException

InterruptedException

clearBacklog

public void clearBacklog()
                  throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Clear the cursor backlog.

Consume all the entries for this cursor.

Specified by:

clearBacklog in interface ManagedCursor

Throws:

InterruptedException

ManagedLedgerException

asyncClearBacklog

public void asyncClearBacklog(AsyncCallbacks.ClearBacklogCallback callback,
 Object ctx)

Description copied from interface: ManagedCursor

Clear the cursor backlog.

Consume all the entries for this cursor.

Specified by:

asyncClearBacklog in interface ManagedCursor

Parameters:

callback - callback object

ctx - opaque context

skipEntries

public void skipEntries(int numEntriesToSkip,
 ManagedCursor.IndividualDeletedEntries deletedEntries)
                 throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Skip n entries from the read position of this cursor.

Specified by:

skipEntries in interface ManagedCursor

Parameters:

numEntriesToSkip - number of entries to skip

deletedEntries - skip individual deleted entries

Throws:

InterruptedException

ManagedLedgerException

asyncSkipEntries

public void asyncSkipEntries(int numEntriesToSkip,
 ManagedCursor.IndividualDeletedEntries deletedEntries,
 AsyncCallbacks.SkipEntriesCallback callback,
 Object ctx)

Description copied from interface: ManagedCursor

Skip n entries from the read position of this cursor.

Specified by:

asyncSkipEntries in interface ManagedCursor

Parameters:

numEntriesToSkip - number of entries to skip

deletedEntries - skip individual deleted entries

callback - callback object

ctx - opaque context

asyncMarkDelete

public void asyncMarkDelete(Position position,
 AsyncCallbacks.MarkDeleteCallback callback,
 Object ctx)

Description copied from interface: ManagedCursor

Asynchronous mark delete.

Specified by:

asyncMarkDelete in interface ManagedCursor

Parameters:

position - the last position that have been successfully consumed

callback - callback object

ctx - opaque context

See Also:

• ManagedCursor.markDelete(Position)

asyncMarkDelete

public void asyncMarkDelete(Position position,
 Map<String,Long> properties,
 AsyncCallbacks.MarkDeleteCallback callback,
 Object ctx)

Description copied from interface: ManagedCursor

Asynchronous mark delete.

Specified by:

asyncMarkDelete in interface ManagedCursor

Parameters:

position - the last position that have been successfully consumed

properties - additional user-defined properties that can be associated with a particular cursor position

callback - callback object

ctx - opaque context

See Also:

• ManagedCursor.markDelete(Position)

internalAsyncMarkDelete

protected void internalAsyncMarkDelete(PositionImpl newPosition,
 Map<String,Long> properties,
 AsyncCallbacks.MarkDeleteCallback callback,
 Object ctx)

delete

public void delete(Position position)
            throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Delete a single message.

Mark a single message for deletion. When all the previous messages are all deleted, then markDelete() will be called internally to advance the persistent acknowledged position.

The deletion of the message is not persisted into the durable storage and cannot be recovered upon the reopening of the ManagedLedger

Specified by:

delete in interface ManagedCursor

Parameters:

position - the position of the message to be deleted

Throws:

InterruptedException

ManagedLedgerException

asyncDelete

public void asyncDelete(Position pos,
 AsyncCallbacks.DeleteCallback callback,
 Object ctx)

Description copied from interface: ManagedCursor

Delete a single message asynchronously

Mark a single message for deletion. When all the previous messages are all deleted, then markDelete() will be called internally to advance the persistent acknowledged position.

The deletion of the message is not persisted into the durable storage and cannot be recovered upon the reopening of the ManagedLedger

Specified by:

asyncDelete in interface ManagedCursor

Parameters:

pos - the position of the message to be deleted

callback - callback object

ctx - opaque context

delete

public void delete(Iterable<Position> positions)
            throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Delete a group of entries.

Mark multiple single messages for deletion. When all the previous messages are all deleted, then markDelete() will be called internally to advance the persistent acknowledged position.

The deletion of the message is not persisted into the durable storage and cannot be recovered upon the reopening of the ManagedLedger

Specified by:

delete in interface ManagedCursor

Parameters:

positions - positions of the messages to be deleted

Throws:

InterruptedException

ManagedLedgerException

asyncDelete

public void asyncDelete(Iterable<Position> positions,
 AsyncCallbacks.DeleteCallback callback,
 Object ctx)

Description copied from interface: ManagedCursor

Delete a group of messages asynchronously

Mark a group of messages for deletion. When all the previous messages are all deleted, then markDelete() will be called internally to advance the persistent acknowledged position.

The deletion of the messages is not persisted into the durable storage and cannot be recovered upon the reopening of the ManagedLedger

Specified by:

asyncDelete in interface ManagedCursor

Parameters:

positions - the positions of the messages to be deleted

callback - callback object

ctx - opaque context

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Description copied from interface: ManagedCursor

Get the unique cursor name.

Specified by:

getName in interface ManagedCursor

Returns:

the cursor name

getLastActive

public long getLastActive()

Description copied from interface: ManagedCursor

Get the last active time of the cursor.

Specified by:

getLastActive in interface ManagedCursor

Returns:

the last active time of the cursor

updateLastActive

public void updateLastActive()

Description copied from interface: ManagedCursor

Update the last active time of the cursor.

Specified by:

updateLastActive in interface ManagedCursor

isDurable

public boolean isDurable()

Description copied from interface: ManagedCursor

Tells whether the cursor is durable or just kept in memory.

Specified by:

isDurable in interface ManagedCursor

getReadPosition

public Position getReadPosition()

Description copied from interface: ManagedCursor

Get the read position. This points to the next message to be read from the cursor.

Specified by:

getReadPosition in interface ManagedCursor

Returns:

the read position

getMarkDeletedPosition

public Position getMarkDeletedPosition()

Description copied from interface: ManagedCursor

Get the newest mark deleted position on this cursor.

Specified by:

getMarkDeletedPosition in interface ManagedCursor

Returns:

the mark deleted position

getPersistentMarkDeletedPosition

public Position getPersistentMarkDeletedPosition()

Description copied from interface: ManagedCursor

Get the persistent newest mark deleted position on this cursor.

Specified by:

getPersistentMarkDeletedPosition in interface ManagedCursor

Returns:

the persistent mark deleted position

rewind

public void rewind()

Description copied from interface: ManagedCursor

Rewind the cursor to the mark deleted position to replay all the already read but not yet mark deleted messages.

The next message to be read is the one after the current mark deleted message.

Specified by:

rewind in interface ManagedCursor

rewind

public void rewind(boolean readCompacted)

Specified by:

rewind in interface ManagedCursor

seek

public void seek(Position newReadPositionInt,
 boolean force)

Specified by:

seek in interface ManagedCursor

close

public void close()
           throws InterruptedException,
ManagedLedgerException

Description copied from interface: ManagedCursor

Close the cursor and releases the associated resources.

Specified by:

close in interface ManagedCursor

Throws:

InterruptedException

ManagedLedgerException

asyncClose

public void asyncClose(AsyncCallbacks.CloseCallback callback,
 Object ctx)

Description copied from interface: ManagedCursor

Close the cursor asynchronously and release the associated resources.

Specified by:

asyncClose in interface ManagedCursor

Parameters:

callback - callback object

ctx - opaque context

skipNonRecoverableLedger

public void skipNonRecoverableLedger(long ledgerId)

Manually acknowledge all entries in the lost ledger. - Since this is an uncommon event, we focus on maintainability. So we do not modify individualDeletedMessages and batchDeletedIndexes, but call asyncDelete(Position, AsyncCallbacks.DeleteCallback, Object). - This method is valid regardless of the consumer ACK type. - If there is a consumer ack request after this event, it will also work.

Specified by:

skipNonRecoverableLedger in interface ManagedCursor

isBkErrorNotRecoverable

public static boolean isBkErrorNotRecoverable(int rc)

return BK error codes that are considered not likely to be recoverable.

getPendingReadOpsCount

public int getPendingReadOpsCount()

getMessagesConsumedCounter

public long getMessagesConsumedCounter()

getCursorLedger

public long getCursorLedger()

getCursorLedgerLastEntry

public long getCursorLedgerLastEntry()

getIndividuallyDeletedMessages

public String getIndividuallyDeletedMessages()

getIndividuallyDeletedMessagesSet

public LongPairRangeSet<PositionImpl> getIndividuallyDeletedMessagesSet()

isMessageDeleted

public boolean isMessageDeleted(Position position)

getBatchPositionAckSet

public long[] getBatchPositionAckSet(Position position)

getNextAvailablePosition

public PositionImpl getNextAvailablePosition(PositionImpl position)

Checks given position is part of deleted-range and returns next position of upper-end as all the messages are deleted up to that point.

Parameters:

position -

Returns:

next available position

getNextLedgerPosition

public Position getNextLedgerPosition(long currentLedgerId)

isIndividuallyDeletedEntriesEmpty

public boolean isIndividuallyDeletedEntriesEmpty()

getLastLedgerSwitchTimestamp

public long getLastLedgerSwitchTimestamp()

getState

public String getState()

getThrottleMarkDelete

public double getThrottleMarkDelete()

Description copied from interface: ManagedCursor

Returns cursor throttle mark-delete rate.

Specified by:

getThrottleMarkDelete in interface ManagedCursor

Returns:

setThrottleMarkDelete

public void setThrottleMarkDelete(double throttleMarkDelete)

Description copied from interface: ManagedCursor

Update throttle mark delete rate.

Specified by:

setThrottleMarkDelete in interface ManagedCursor

getManagedLedger

public ManagedLedger getManagedLedger()

Description copied from interface: ManagedCursor

Get ManagedLedger attached with cursor.

Specified by:

getManagedLedger in interface ManagedCursor

Returns:

ManagedLedger

getLastIndividualDeletedRange

public com.google.common.collect.Range<PositionImpl> getLastIndividualDeletedRange()

Description copied from interface: ManagedCursor

Get last individual deleted range.

Specified by:

getLastIndividualDeletedRange in interface ManagedCursor

Returns:

range

trimDeletedEntries

public void trimDeletedEntries(List<Entry> entries)

Description copied from interface: ManagedCursor

Trim delete entries for the given entries.

Specified by:

trimDeletedEntries in interface ManagedCursor

getDeletedBatchIndexesAsLongArray

public long[] getDeletedBatchIndexesAsLongArray(PositionImpl position)

Description copied from interface: ManagedCursor

Get deleted batch indexes list for a batch message.

Specified by:

getDeletedBatchIndexesAsLongArray in interface ManagedCursor

getStats

public ManagedCursorMXBean getStats()

Specified by:

getStats in interface ManagedCursor

Returns:

the managed cursor stats MBean

updateReadStats

public void updateReadStats(int readEntriesCount,
 long readEntriesSize)

applyMaxSizeCap

public int applyMaxSizeCap(int maxEntries,
 long maxSizeBytes)

checkAndUpdateReadPositionChanged

public boolean checkAndUpdateReadPositionChanged()

Description copied from interface: ManagedCursor

Checks if read position changed since this method was called last time.

Specified by:

checkAndUpdateReadPositionChanged in interface ManagedCursor

Returns:

if read position changed

setState

public void setState(ManagedCursorImpl.State state)

setCacheReadEntry

public void setCacheReadEntry(boolean cacheReadEntry)

isCacheReadEntry

public boolean isCacheReadEntry()

getConfig

public ManagedLedgerConfig getConfig()

duplicateNonDurableCursor

public ManagedCursor duplicateNonDurableCursor(String nonDurableCursorName)
                                        throws ManagedLedgerException

Create a non-durable cursor and copy the ack stats.

Throws:

ManagedLedgerException