程序包 org.apache.bookkeeper.mledger.impl

类 ManagedCursorImpl

java.lang.Object

org.apache.bookkeeper.mledger.impl.ManagedCursorImpl

所有已实现的接口:

ManagedCursor

直接已知子类:

NonDurableCursorImpl, ReadOnlyCursorImpl

public class ManagedCursorImpl
extends Object
implements ManagedCursor

嵌套类概要

嵌套类

修饰符和类型	类	说明
static enum	ManagedCursorImpl.State
static interface	ManagedCursorImpl.VoidCallback

从接口继承的嵌套类/接口 org.apache.bookkeeper.mledger.ManagedCursor

ManagedCursor.FindPositionConstraint, ManagedCursor.IndividualDeletedEntries

字段概要

字段

修饰符和类型	字段	说明
protected final org.apache.bookkeeper.client.BookKeeper	bookkeeper
protected final ManagedLedgerConfig	config
static final int	FALSE
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

方法概要

修饰符和类型	方法	说明
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, com.google.common.base.Predicate<Entry> condition, AsyncCallbacks.FindEntryCallback callback, Object ctx)	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.
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
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.
Position	findNewestMatching(com.google.common.base.Predicate<Entry> condition)	Find the newest entry that matches the given predicate.
Position	findNewestMatching(ManagedCursor.FindPositionConstraint constraint, com.google.common.base.Predicate<Entry> condition)	Find the newest entry that matches the given predicate.
long[]	getBatchPositionAckSet(Position position)
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()
org.apache.pulsar.common.util.collections.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	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).
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)
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	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.
CompletableFuture<Void>	setCursorProperties(Map<String,String> cursorProperties)	Updates the properties.
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.
String	toString()
void	trimDeletedEntries(List<Entry> entries)	Trim delete entries for the given entries.
void	updateLastActive()	Update the last active time of the cursor.

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.bookkeeper.mledger.ManagedCursor

seek

字段详细资料

bookkeeper

protected final org.apache.bookkeeper.client.BookKeeper bookkeeper

config

protected final ManagedLedgerConfig config

ledger

protected final ManagedLedgerImpl ledger

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

另请参阅:

• 常量字段值

TRUE

public static final int TRUE

另请参阅:

• 常量字段值

messagesConsumedCounter

protected volatile long messagesConsumedCounter

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

方法详细资料

getProperties

public Map<String,Long> getProperties()

从接口复制的说明: ManagedCursor

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

指定者:

getProperties 在接口中 ManagedCursor

getCursorProperties

public Map<String,String> getCursorProperties()

从接口复制的说明: ManagedCursor

Return any properties that were associated with the cursor.

指定者:

getCursorProperties 在接口中 ManagedCursor

setCursorProperties

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

从接口复制的说明: ManagedCursor

Updates the properties.

指定者:

setCursorProperties 在接口中 ManagedCursor

返回:

a handle to the result of the operation

putProperty

public boolean putProperty(String key,
 Long value)

从接口复制的说明: ManagedCursor

Add a property associated with the last stored position.

指定者:

putProperty 在接口中 ManagedCursor

removeProperty

public boolean removeProperty(String key)

从接口复制的说明: ManagedCursor

Remove a property associated with the last stored position.

指定者:

removeProperty 在接口中 ManagedCursor

recoverFromLedger

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

readEntries

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

从接口复制的说明: ManagedCursor

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

指定者:

readEntries 在接口中 ManagedCursor

参数:

numberOfEntriesToRead - maximum number of entries to return

返回:

the list of entries

抛出:

ManagedLedgerException

InterruptedException

asyncReadEntries

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

从接口复制的说明: ManagedCursor

Asynchronously read entries from the ManagedLedger.

指定者:

asyncReadEntries 在接口中 ManagedCursor

参数:

numberOfEntriesToRead - maximum number of entries to return

callback - callback object

ctx - opaque context

maxPosition - max position can read

另请参阅:

• ManagedCursor.readEntries(int)

asyncReadEntries

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

从接口复制的说明: ManagedCursor

Asynchronously read entries from the ManagedLedger.

指定者:

asyncReadEntries 在接口中 ManagedCursor

参数:

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

getNthEntry

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

从接口复制的说明: ManagedCursor

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

指定者:

getNthEntry 在接口中 ManagedCursor

参数:

n - entry position

deletedEntries - skip individual deleted entries

返回:

the entry

抛出:

InterruptedException

ManagedLedgerException

asyncGetNthEntry

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

从接口复制的说明: ManagedCursor

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

指定者:

asyncGetNthEntry 在接口中 ManagedCursor

参数:

n - entry position

deletedEntries - skip individual deleted entries

readEntriesOrWait

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

从接口复制的说明: 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.

指定者:

readEntriesOrWait 在接口中 ManagedCursor

参数:

numberOfEntriesToRead - maximum number of entries to return

返回:

the list of entries

抛出:

ManagedLedgerException

InterruptedException

readEntriesOrWait

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

从接口复制的说明: 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.

指定者:

readEntriesOrWait 在接口中 ManagedCursor

参数:

numberOfEntriesToRead - maximum number of entries to return

maxSizeBytes - max size in bytes of the entries to return

返回:

the list of entries

抛出:

ManagedLedgerException

InterruptedException

asyncReadEntriesOrWait

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

从接口复制的说明: 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

指定者:

asyncReadEntriesOrWait 在接口中 ManagedCursor

参数:

numberOfEntriesToRead - maximum number of entries to return

callback - callback object

ctx - opaque context

maxPosition - max position can read

另请参阅:

• ManagedCursor.readEntriesOrWait(int)

asyncReadEntriesOrWait

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

从接口复制的说明: 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

指定者:

asyncReadEntriesOrWait 在接口中 ManagedCursor

参数:

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

另请参阅:

• ManagedCursor.readEntriesOrWait(int, long)

isClosed

public boolean isClosed()

从接口复制的说明: ManagedCursor

Checks if the cursor is closed.

指定者:

isClosed 在接口中 ManagedCursor

返回:

whether this cursor is closed.

cancelPendingReadRequest

public boolean cancelPendingReadRequest()

从接口复制的说明: ManagedCursor

Cancel a previously scheduled asyncReadEntriesOrWait operation.

指定者:

cancelPendingReadRequest 在接口中 ManagedCursor

返回:

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

另请参阅:

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

hasPendingReadRequest

public boolean hasPendingReadRequest()

hasMoreEntries

public boolean hasMoreEntries()

从接口复制的说明: ManagedCursor

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

This method is not blocking.

指定者:

hasMoreEntries 在接口中 ManagedCursor

返回:

true if there are pending entries to read, false otherwise

getNumberOfEntries

public long getNumberOfEntries()

从接口复制的说明: 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.

指定者:

getNumberOfEntries 在接口中 ManagedCursor

返回:

the number of entries

getNumberOfEntriesSinceFirstNotAckedMessage

public long getNumberOfEntriesSinceFirstNotAckedMessage()

从接口复制的说明: ManagedCursor

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

指定者:

getNumberOfEntriesSinceFirstNotAckedMessage 在接口中 ManagedCursor

返回:

getTotalNonContiguousDeletedMessagesRange

public int getTotalNonContiguousDeletedMessagesRange()

从接口复制的说明: ManagedCursor

Returns number of mark-Delete range.

指定者:

getTotalNonContiguousDeletedMessagesRange 在接口中 ManagedCursor

返回:

getNonContiguousDeletedMessagesRangeSerializedSize

public int getNonContiguousDeletedMessagesRangeSerializedSize()

从接口复制的说明: ManagedCursor

Returns the serialized size of mark-Delete ranges.

指定者:

getNonContiguousDeletedMessagesRangeSerializedSize 在接口中 ManagedCursor

getEstimatedSizeSinceMarkDeletePosition

public long getEstimatedSizeSinceMarkDeletePosition()

从接口复制的说明: ManagedCursor

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

指定者:

getEstimatedSizeSinceMarkDeletePosition 在接口中 ManagedCursor

返回:

the estimated size from the mark delete position of the cursor

getNumberOfEntriesInBacklog

public long getNumberOfEntriesInBacklog(boolean isPrecise)

从接口复制的说明: 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.

指定者:

getNumberOfEntriesInBacklog 在接口中 ManagedCursor

参数:

isPrecise - set to true to get precise backlog count

返回:

the number of entries

getNumberOfEntriesInStorage

public long getNumberOfEntriesInStorage()

findNewestMatching

public Position findNewestMatching(com.google.common.base.Predicate<Entry> condition)
                            throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedCursor

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

指定者:

findNewestMatching 在接口中 ManagedCursor

参数:

condition - predicate that reads an entry an applies a condition

返回:

Position of the newest entry that matches the given predicate

抛出:

InterruptedException

ManagedLedgerException

findNewestMatching

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

从接口复制的说明: ManagedCursor

Find the newest entry that matches the given predicate.

指定者:

findNewestMatching 在接口中 ManagedCursor

参数:

constraint - search only active entries or all entries

condition - predicate that reads an entry an applies a condition

返回:

Position of the newest entry that matches the given predicate

抛出:

InterruptedException

ManagedLedgerException

asyncFindNewestMatching

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

从接口复制的说明: ManagedCursor

Find the newest entry that matches the given predicate.

指定者:

asyncFindNewestMatching 在接口中 ManagedCursor

参数:

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

setActive

public void setActive()

从接口复制的说明: ManagedCursor

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

指定者:

setActive 在接口中 ManagedCursor

isActive

public boolean isActive()

从接口复制的说明: ManagedCursor

Checks if cursor is active or not.

指定者:

isActive 在接口中 ManagedCursor

返回:

setInactive

public void setInactive()

从接口复制的说明: ManagedCursor

Deactivate cursor.

指定者:

setInactive 在接口中 ManagedCursor

setAlwaysInactive

public void setAlwaysInactive()

从接口复制的说明: ManagedCursor

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

指定者:

setAlwaysInactive 在接口中 ManagedCursor

getFirstPosition

public Position getFirstPosition()

从接口复制的说明: ManagedCursor

Get the first position.

指定者:

getFirstPosition 在接口中 ManagedCursor

返回:

the first position

internalResetCursor

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

asyncResetCursor

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

从接口复制的说明: ManagedCursor

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

指定者:

asyncResetCursor 在接口中 ManagedCursor

参数:

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

从接口复制的说明: ManagedCursor

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

指定者:

resetCursor 在接口中 ManagedCursor

参数:

newPos - position to move the cursor to

抛出:

ManagedLedgerException

InterruptedException

replayEntries

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

从接口复制的说明: ManagedCursor

Read the specified set of positions from ManagedLedger.

指定者:

replayEntries 在接口中 ManagedCursor

参数:

positions - set of positions to read

返回:

the list of entries

抛出:

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

指定者:

asyncReplayEntries 在接口中 ManagedCursor

参数:

positions - set of positions to read

callback - callback object returning the list of entries

ctx - opaque context

返回:

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)

从接口复制的说明: ManagedCursor

Read the specified set of positions from ManagedLedger.

指定者:

asyncReplayEntries 在接口中 ManagedCursor

参数:

positions - set of positions to read

callback - callback object returning the list of entries

ctx - opaque context

sortEntries - callback with sorted entry list.

返回:

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

从接口复制的说明: 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.

指定者:

markDelete 在接口中 ManagedCursor

参数:

position - the last position that have been successfully consumed

抛出:

ManagedLedgerException

InterruptedException

markDelete

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

从接口复制的说明: 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.

指定者:

markDelete 在接口中 ManagedCursor

参数:

position - the last position that have been successfully consumed

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

抛出:

ManagedLedgerException

InterruptedException

clearBacklog

public void clearBacklog()
                  throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedCursor

Clear the cursor backlog.

Consume all the entries for this cursor.

指定者:

clearBacklog 在接口中 ManagedCursor

抛出:

InterruptedException

ManagedLedgerException

asyncClearBacklog

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

从接口复制的说明: ManagedCursor

Clear the cursor backlog.

Consume all the entries for this cursor.

指定者:

asyncClearBacklog 在接口中 ManagedCursor

参数:

callback - callback object

ctx - opaque context

skipEntries

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

从接口复制的说明: ManagedCursor

Skip n entries from the read position of this cursor.

指定者:

skipEntries 在接口中 ManagedCursor

参数:

numEntriesToSkip - number of entries to skip

deletedEntries - skip individual deleted entries

抛出:

InterruptedException

ManagedLedgerException

asyncSkipEntries

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

从接口复制的说明: ManagedCursor

Skip n entries from the read position of this cursor.

指定者:

asyncSkipEntries 在接口中 ManagedCursor

参数:

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)

从接口复制的说明: ManagedCursor

Asynchronous mark delete.

指定者:

asyncMarkDelete 在接口中 ManagedCursor

参数:

position - the last position that have been successfully consumed

callback - callback object

ctx - opaque context

另请参阅:

• ManagedCursor.markDelete(Position)

asyncMarkDelete

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

从接口复制的说明: ManagedCursor

Asynchronous mark delete.

指定者:

asyncMarkDelete 在接口中 ManagedCursor

参数:

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

另请参阅:

• 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

从接口复制的说明: 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

指定者:

delete 在接口中 ManagedCursor

参数:

position - the position of the message to be deleted

抛出:

InterruptedException

ManagedLedgerException

asyncDelete

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

从接口复制的说明: 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

指定者:

asyncDelete 在接口中 ManagedCursor

参数:

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

从接口复制的说明: 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

指定者:

delete 在接口中 ManagedCursor

参数:

positions - positions of the messages to be deleted

抛出:

InterruptedException

ManagedLedgerException

asyncDelete

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

从接口复制的说明: 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

指定者:

asyncDelete 在接口中 ManagedCursor

参数:

positions - the positions of the messages to be deleted

callback - callback object

ctx - opaque context

toString

public String toString()

覆盖:

toString 在类中 Object

getName

public String getName()

从接口复制的说明: ManagedCursor

Get the unique cursor name.

指定者:

getName 在接口中 ManagedCursor

返回:

the cursor name

getLastActive

public long getLastActive()

从接口复制的说明: ManagedCursor

Get the last active time of the cursor.

指定者:

getLastActive 在接口中 ManagedCursor

返回:

the last active time of the cursor

updateLastActive

public void updateLastActive()

从接口复制的说明: ManagedCursor

Update the last active time of the cursor.

指定者:

updateLastActive 在接口中 ManagedCursor

isDurable

public boolean isDurable()

从接口复制的说明: ManagedCursor

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

指定者:

isDurable 在接口中 ManagedCursor

getReadPosition

public Position getReadPosition()

从接口复制的说明: ManagedCursor

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

指定者:

getReadPosition 在接口中 ManagedCursor

返回:

the read position

getMarkDeletedPosition

public Position getMarkDeletedPosition()

从接口复制的说明: ManagedCursor

Get the newest mark deleted position on this cursor.

指定者:

getMarkDeletedPosition 在接口中 ManagedCursor

返回:

the mark deleted position

getPersistentMarkDeletedPosition

public Position getPersistentMarkDeletedPosition()

从接口复制的说明: ManagedCursor

Get the persistent newest mark deleted position on this cursor.

指定者:

getPersistentMarkDeletedPosition 在接口中 ManagedCursor

返回:

the persistent mark deleted position

rewind

public void rewind()

从接口复制的说明: 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.

指定者:

rewind 在接口中 ManagedCursor

seek

public void seek(Position newReadPositionInt,
 boolean force)

指定者:

seek 在接口中 ManagedCursor

close

public void close()
           throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedCursor

Close the cursor and releases the associated resources.

指定者:

close 在接口中 ManagedCursor

抛出:

InterruptedException

ManagedLedgerException

asyncClose

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

从接口复制的说明: ManagedCursor

Close the cursor asynchronously and release the associated resources.

指定者:

asyncClose 在接口中 ManagedCursor

参数:

callback - callback object

ctx - opaque context

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 org.apache.pulsar.common.util.collections.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.

参数:

position -

返回:

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()

从接口复制的说明: ManagedCursor

Returns cursor throttle mark-delete rate.

指定者:

getThrottleMarkDelete 在接口中 ManagedCursor

返回:

setThrottleMarkDelete

public void setThrottleMarkDelete(double throttleMarkDelete)

从接口复制的说明: ManagedCursor

Update throttle mark delete rate.

指定者:

setThrottleMarkDelete 在接口中 ManagedCursor

getManagedLedger

public ManagedLedger getManagedLedger()

从接口复制的说明: ManagedCursor

Get ManagedLedger attached with cursor.

指定者:

getManagedLedger 在接口中 ManagedCursor

返回:

ManagedLedger

getLastIndividualDeletedRange

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

从接口复制的说明: ManagedCursor

Get last individual deleted range.

指定者:

getLastIndividualDeletedRange 在接口中 ManagedCursor

返回:

range

trimDeletedEntries

public void trimDeletedEntries(List<Entry> entries)

从接口复制的说明: ManagedCursor

Trim delete entries for the given entries.

指定者:

trimDeletedEntries 在接口中 ManagedCursor

getDeletedBatchIndexesAsLongArray

public long[] getDeletedBatchIndexesAsLongArray(PositionImpl position)

从接口复制的说明: ManagedCursor

Get deleted batch indexes list for a batch message.

指定者:

getDeletedBatchIndexesAsLongArray 在接口中 ManagedCursor

getStats

public ManagedCursorMXBean getStats()

指定者:

getStats 在接口中 ManagedCursor

返回:

the managed cursor stats MBean

checkAndUpdateReadPositionChanged

public boolean checkAndUpdateReadPositionChanged()

从接口复制的说明: ManagedCursor

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

指定者:

checkAndUpdateReadPositionChanged 在接口中 ManagedCursor

返回:

if read position changed

setState

public void setState(ManagedCursorImpl.State state)