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

类 ManagedLedgerImpl

java.lang.Object

org.apache.bookkeeper.mledger.impl.ManagedLedgerImpl

所有已实现的接口:

org.apache.bookkeeper.client.AsyncCallback.CreateCallback, ManagedLedger

直接已知子类:

ReadOnlyManagedLedgerImpl

public class ManagedLedgerImpl
extends Object
implements ManagedLedger, org.apache.bookkeeper.client.AsyncCallback.CreateCallback

嵌套类概要

嵌套类

修饰符和类型	类	说明
static enum	ManagedLedgerImpl.PositionBound
static enum	ManagedLedgerImpl.State

字段概要

字段

修饰符和类型	字段	说明
protected static final AtomicLongFieldUpdater<ManagedLedgerImpl>	ADD_OP_COUNT_UPDATER
protected static final int	AsyncOperationTimeoutSeconds
protected final org.apache.bookkeeper.client.BookKeeper	bookKeeper
protected final Clock	clock
protected ManagedLedgerConfig	config
protected org.apache.bookkeeper.client.LedgerHandle	currentLedger
protected long	currentLedgerSize
protected static final int	DEFAULT_LEDGER_DELETE_BACKOFF_TIME_SEC
protected static final int	DEFAULT_LEDGER_DELETE_RETRIES
protected final org.apache.bookkeeper.client.BookKeeper.DigestType	digestType
protected final NavigableMap<Long,MLDataFormats.ManagedLedgerInfo.LedgerInfo>	ledgers
protected final ManagedLedgerMBeanImpl	mbean
protected final Supplier<Boolean>	mlOwnershipChecker
protected final String	name
protected Map<String,String>	propertiesMap
protected ManagedLedgerImpl.State	state
protected final MetaStore	store

构造器概要

构造器

构造器	说明
ManagedLedgerImpl(ManagedLedgerFactoryImpl factory, org.apache.bookkeeper.client.BookKeeper bookKeeper, MetaStore store, ManagedLedgerConfig config, org.apache.bookkeeper.common.util.OrderedScheduler scheduledExecutor, String name)
ManagedLedgerImpl(ManagedLedgerFactoryImpl factory, org.apache.bookkeeper.client.BookKeeper bookKeeper, MetaStore store, ManagedLedgerConfig config, org.apache.bookkeeper.common.util.OrderedScheduler scheduledExecutor, String name, Supplier<Boolean> mlOwnershipChecker)

方法概要

修饰符和类型	方法	说明
void	activateCursor(ManagedCursor cursor)
Position	addEntry(byte[] data)	Append a new entry to the end of a managed ledger.
Position	addEntry(byte[] data, int numberOfMessages)	Append a new entry to the end of a managed ledger.
Position	addEntry(byte[] data, int offset, int length)	Append a new entry to the end of a managed ledger.
Position	addEntry(byte[] data, int numberOfMessages, int offset, int length)	Append a new entry to the end of a managed ledger.
void	addWaitingEntryCallBack(WaitingEntryCallBack cb)
protected void	afterFailedAddEntry(int numOfMessages)
void	asyncAddEntry(byte[] data, int numberOfMessages, int offset, int length, AsyncCallbacks.AddEntryCallback callback, Object ctx)	Append a new entry asynchronously.
void	asyncAddEntry(byte[] data, int offset, int length, AsyncCallbacks.AddEntryCallback callback, Object ctx)	Append a new entry asynchronously.
void	asyncAddEntry(byte[] data, AsyncCallbacks.AddEntryCallback callback, Object ctx)	Append a new entry asynchronously.
void	asyncAddEntry(io.netty.buffer.ByteBuf buffer, int numberOfMessages, AsyncCallbacks.AddEntryCallback callback, Object ctx)	Append a new entry asynchronously.
void	asyncAddEntry(io.netty.buffer.ByteBuf buffer, AsyncCallbacks.AddEntryCallback callback, Object ctx)	Append a new entry asynchronously.
void	asyncClose(AsyncCallbacks.CloseCallback callback, Object ctx)	Close the ManagedLedger asynchronously.
protected void	asyncCreateLedger(org.apache.bookkeeper.client.BookKeeper bookKeeper, ManagedLedgerConfig config, org.apache.bookkeeper.client.BookKeeper.DigestType digestType, org.apache.bookkeeper.client.AsyncCallback.CreateCallback cb, Map<String,byte[]> metadata)	Create ledger async and schedule a timeout task to check ledger-creation is complete else it fails the callback with TimeoutException.
void	asyncDelete(AsyncCallbacks.DeleteLedgerCallback callback, Object ctx)	Async delete a ledger.
void	asyncDeleteCursor(String consumerName, AsyncCallbacks.DeleteCursorCallback callback, Object ctx)	Delete a ManagedCursor asynchronously.
void	asyncDeleteProperty(String key, AsyncCallbacks.UpdatePropertiesCallback callback, Object ctx)	Async delete the property by key.
CompletableFuture<Position>	asyncFindPosition(com.google.common.base.Predicate<Entry> predicate)	Find position by sequenceId.
void	asyncOffloadPrefix(Position pos, AsyncCallbacks.OffloadCallback callback, Object ctx)	Offload as many entries before position as possible to longterm storage.
void	asyncOpenCursor(String cursorName, AsyncCallbacks.OpenCursorCallback callback, Object ctx)	Open a ManagedCursor asynchronously.
void	asyncOpenCursor(String cursorName, org.apache.pulsar.common.api.proto.CommandSubscribe.InitialPosition initialPosition, Map<String,Long> properties, Map<String,String> cursorProperties, AsyncCallbacks.OpenCursorCallback callback, Object ctx)	Open a ManagedCursor asynchronously.
void	asyncOpenCursor(String cursorName, org.apache.pulsar.common.api.proto.CommandSubscribe.InitialPosition initialPosition, AsyncCallbacks.OpenCursorCallback callback, Object ctx)	Open a ManagedCursor asynchronously.
protected void	asyncReadEntry(org.apache.bookkeeper.client.api.ReadHandle ledger, long firstEntry, long lastEntry, boolean isSlowestReader, org.apache.bookkeeper.mledger.impl.OpReadEntry opReadEntry, Object ctx)
protected void	asyncReadEntry(org.apache.bookkeeper.client.api.ReadHandle ledger, PositionImpl position, AsyncCallbacks.ReadEntryCallback callback, Object ctx)
void	asyncReadEntry(PositionImpl position, AsyncCallbacks.ReadEntryCallback callback, Object ctx)
void	asyncSetProperties(Map<String,String> properties, AsyncCallbacks.UpdatePropertiesCallback callback, Object ctx)	Async update managed-ledger's properties.
void	asyncSetProperty(String key, String value, AsyncCallbacks.UpdatePropertiesCallback callback, Object ctx)	Async add key-value to propertiesMap.
void	asyncTerminate(AsyncCallbacks.TerminateCallback callback, Object ctx)
CompletableFuture<Void>	asyncTruncate()	Truncate ledgers The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers.
protected boolean	checkAndCompleteLedgerOpTask(int rc, org.apache.bookkeeper.client.LedgerHandle lh, Object ctx)	check if ledger-op task is already completed by timeout-task.
void	checkInactiveLedgerAndRollOver()	Check current inactive ledger (based on ManagedLedgerConfig.getInactiveLedgerRollOverTimeMs() and roll over that ledger if inactive.
void	close()	Close the ManagedLedger.
void	createComplete(int rc, org.apache.bookkeeper.client.LedgerHandle lh, Object ctx)
static ManagedLedgerException	createManagedLedgerException(int bkErrorCode)
static ManagedLedgerException	createManagedLedgerException(Throwable t)
void	deactivateCursor(ManagedCursor cursor)
void	delete()	Delete this ManagedLedger completely from the system.
void	deleteCursor(String name)	Remove a ManagedCursor from this ManagedLedger.
void	deleteProperty(String key)	Delete the property by key.
ManagedCursorContainer	getActiveCursors()	Get a list of all the active cursors reading from this ManagedLedger.
long	getCacheSize()
Clock	getClock()
ManagedLedgerConfig	getConfig()	Returns managed-ledger config.
long	getCurrentLedgerEntries()
long	getCurrentLedgerSize()
ManagedCursorContainer	getCursors()	Get a list of all the cursors reading from this ManagedLedger.
CompletableFuture<Long>	getEarliestMessagePublishTimeInBacklog()	Get the publishing time of the oldest message in the backlog.
CompletableFuture<Long>	getEarliestMessagePublishTimeOfPos(PositionImpl pos)
CompletableFuture<Set<org.apache.bookkeeper.net.BookieId>>	getEnsemblesAsync(long ledgerId)
long	getEntriesAddedCounter()
long	getEstimatedBacklogSize()	Get estimated total unconsumed or backlog size in bytes for the managed ledger, without accounting for replicas.
long	getEstimatedBacklogSize(PositionImpl pos)	Get estimated backlog size from a specific position.
PositionImpl	getFirstPosition()
Position	getLastConfirmedEntry()	Gets last confirmed entry of the managed ledger.
long	getLastLedgerCreatedTimestamp()
long	getLastLedgerCreationFailureTimestamp()
long	getLastOffloadedFailureTimestamp()	Get last failed offloaded timestamp.
long	getLastOffloadedLedgerId()	Get last offloaded ledgerId.
long	getLastOffloadedSuccessTimestamp()	Get last suceessful offloaded timestamp.
CompletableFuture<MLDataFormats.ManagedLedgerInfo.LedgerInfo>	getLedgerInfo(long ledgerId)	Get basic ledger summary.
CompletableFuture<String>	getLedgerMetadata(long ledgerId)
NavigableMap<Long,MLDataFormats.ManagedLedgerInfo.LedgerInfo>	getLedgersInfo()
List<MLDataFormats.ManagedLedgerInfo.LedgerInfo>	getLedgersInfoAsList()
ManagedLedgerInterceptor	getManagedLedgerInterceptor()	Get the ManagedLedgerInterceptor for ManagedLedger.
CompletableFuture<org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats>	getManagedLedgerInternalStats(boolean includeLedgerMetadata)	Get managed ledger internal stats.
String	getName()
Long	getNextValidLedger(long ledgerId)
PositionImpl	getNextValidPosition(PositionImpl position)
PositionImpl	getNextValidPositionInternal(PositionImpl position)
long	getNumberOfActiveEntries()	Get the total number of active entries for this managed ledger.
long	getNumberOfEntries()	Get the total number of entries for this managed ledger.
long	getOffloadedSize()	Return the size of all ledgers offloaded to 2nd tier storage.
Optional<MLDataFormats.ManagedLedgerInfo.LedgerInfo>	getOptionalLedgerInfo(long ledgerId)	Get basic ledger summary.
int	getPendingAddEntriesCount()
PositionImpl	getPositionAfterN(PositionImpl startPosition, long n, ManagedLedgerImpl.PositionBound startRange)	Get the entry position at a given distance from a given position.
PositionImpl	getPreviousPosition(PositionImpl position)	Get the entry position that come before the specified position in the message stream, using information from the ledger list and each ledger entries count.
Map<String,String>	getProperties()	Returns managed-ledger's properties.
ManagedCursor	getSlowestConsumer()	Get the slowest consumer.
ManagedLedgerImpl.State	getState()
ManagedLedgerMXBean	getStats()
Position	getTheSlowestNonDurationReadPosition()
long	getTotalSize()	Get the total sizes in bytes of the managed ledger, without accounting for replicas.
int	getWaitingCursorsCount()
boolean	hasActiveCursors()	Tells whether the managed ledger has any active-cursor registered.
boolean	hasMoreEntries(PositionImpl position)
void	invalidateLedgerHandle(org.apache.bookkeeper.client.api.ReadHandle ledgerHandle)
boolean	isCursorActive(ManagedCursor cursor)
protected boolean	isReadOnly()
boolean	isTerminated()	Returns whether the managed ledger was terminated.
boolean	isValidPosition(PositionImpl position)	Validate whether a specified position is valid for the current managed ledger.
boolean	ledgerExists(long ledgerId)
void	maybeUpdateCursorBeforeTrimmingConsumedLedger()
ManagedCursor	newNonDurableCursor(Position startCursorPosition)	Creates a new cursor whose metadata is not backed by durable storage.
ManagedCursor	newNonDurableCursor(Position startPosition, String subscriptionName)
ManagedCursor	newNonDurableCursor(Position startCursorPosition, String cursorName, org.apache.pulsar.common.api.proto.CommandSubscribe.InitialPosition initialPosition, boolean isReadCompacted)
Position	offloadPrefix(Position pos)	Offload as many entries before position as possible to longterm storage.
void	onCursorReadPositionUpdated(ManagedCursorImpl cursor, Position newReadPosition)
ManagedCursor	openCursor(String cursorName)	Open a ManagedCursor in this ManagedLedger.
ManagedCursor	openCursor(String cursorName, org.apache.pulsar.common.api.proto.CommandSubscribe.InitialPosition initialPosition)	Open a ManagedCursor in this ManagedLedger.
ManagedCursor	openCursor(String cursorName, org.apache.pulsar.common.api.proto.CommandSubscribe.InitialPosition initialPosition, Map<String,Long> properties, Map<String,String> cursorProperties)	Open a ManagedCursor in this ManagedLedger.
void	readyToCreateNewLedger()	Signaling managed ledger that we can resume after BK write failure.
void	removeWaitingCursor(ManagedCursor cursor)	Remove a ManagedCursor from this ManagedLedger's waitingCursors.
void	rollCurrentLedgerIfFull()	Roll current ledger if it is full.
void	setConfig(ManagedLedgerConfig config)	Updates managed-ledger config.
void	setEntriesAddedCounter(long count)
void	setProperties(Map<String,String> properties)	Update managed-ledger's properties.
void	setProperty(String key, String value)	Add key-value to propertiesMap.
Position	terminate()	Terminate the managed ledger and return the last committed entry.
void	trimConsumedLedgersInBackground(boolean isTruncate, CompletableFuture<?> promise)
void	trimConsumedLedgersInBackground(CompletableFuture<?> promise)	Trim consumed ledgers in background.
void	updateLedgersIdsComplete(org.apache.bookkeeper.client.LedgerHandle originalCurrentLedger)

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

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

字段详细资料

AsyncOperationTimeoutSeconds

protected static final int AsyncOperationTimeoutSeconds

另请参阅:

• 常量字段值

bookKeeper

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

name

protected final String name

digestType

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

config

protected ManagedLedgerConfig config

propertiesMap

protected Map<String,String> propertiesMap

store

protected final MetaStore store

ledgers

protected final NavigableMap<Long,MLDataFormats.ManagedLedgerInfo.LedgerInfo> ledgers

currentLedger

protected volatile org.apache.bookkeeper.client.LedgerHandle currentLedger

currentLedgerSize

protected long currentLedgerSize

mlOwnershipChecker

protected final Supplier<Boolean> mlOwnershipChecker

DEFAULT_LEDGER_DELETE_RETRIES

protected static final int DEFAULT_LEDGER_DELETE_RETRIES

另请参阅:

• 常量字段值

DEFAULT_LEDGER_DELETE_BACKOFF_TIME_SEC

protected static final int DEFAULT_LEDGER_DELETE_BACKOFF_TIME_SEC

另请参阅:

• 常量字段值

state

protected volatile ManagedLedgerImpl.State state

mbean

protected final ManagedLedgerMBeanImpl mbean

clock

protected final Clock clock

ADD_OP_COUNT_UPDATER

protected static final AtomicLongFieldUpdater<ManagedLedgerImpl> ADD_OP_COUNT_UPDATER

构造器详细资料

ManagedLedgerImpl

public ManagedLedgerImpl(ManagedLedgerFactoryImpl factory,
 org.apache.bookkeeper.client.BookKeeper bookKeeper,
 MetaStore store,
 ManagedLedgerConfig config,
 org.apache.bookkeeper.common.util.OrderedScheduler scheduledExecutor,
 String name)

ManagedLedgerImpl

public ManagedLedgerImpl(ManagedLedgerFactoryImpl factory,
 org.apache.bookkeeper.client.BookKeeper bookKeeper,
 MetaStore store,
 ManagedLedgerConfig config,
 org.apache.bookkeeper.common.util.OrderedScheduler scheduledExecutor,
 String name,
 Supplier<Boolean> mlOwnershipChecker)

方法详细资料

getName

public String getName()

指定者:

getName 在接口中 ManagedLedger

返回:

the unique name of this ManagedLedger

addEntry

public Position addEntry(byte[] data)
                  throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Append a new entry to the end of a managed ledger.

指定者:

addEntry 在接口中 ManagedLedger

参数:

data - data entry to be persisted

返回:

the Position at which the entry has been inserted

抛出:

ManagedLedgerException

InterruptedException

addEntry

public Position addEntry(byte[] data,
 int numberOfMessages)
                  throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Append a new entry to the end of a managed ledger.

指定者:

addEntry 在接口中 ManagedLedger

参数:

data - data entry to be persisted

numberOfMessages - numberOfMessages of entry

返回:

the Position at which the entry has been inserted

抛出:

ManagedLedgerException

InterruptedException

addEntry

public Position addEntry(byte[] data,
 int offset,
 int length)
                  throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Append a new entry to the end of a managed ledger.

指定者:

addEntry 在接口中 ManagedLedger

参数:

data - data entry to be persisted

offset - offset in the data array

length - number of bytes

返回:

the Position at which the entry has been inserted

抛出:

ManagedLedgerException

InterruptedException

addEntry

public Position addEntry(byte[] data,
 int numberOfMessages,
 int offset,
 int length)
                  throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Append a new entry to the end of a managed ledger.

指定者:

addEntry 在接口中 ManagedLedger

参数:

data - data entry to be persisted

numberOfMessages - numberOfMessages of entry

offset - offset in the data array

length - number of bytes

返回:

the Position at which the entry has been inserted

抛出:

ManagedLedgerException

InterruptedException

asyncAddEntry

public void asyncAddEntry(byte[] data,
 AsyncCallbacks.AddEntryCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Append a new entry asynchronously.

指定者:

asyncAddEntry 在接口中 ManagedLedger

参数:

data - data entry to be persisted

callback - callback object

ctx - opaque context

另请参阅:

• ManagedLedger.addEntry(byte[])

asyncAddEntry

public void asyncAddEntry(byte[] data,
 int offset,
 int length,
 AsyncCallbacks.AddEntryCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Append a new entry asynchronously.

指定者:

asyncAddEntry 在接口中 ManagedLedger

参数:

data - data entry to be persisted

offset - offset in the data array

length - number of bytes

callback - callback object

ctx - opaque context

另请参阅:

• ManagedLedger.addEntry(byte[])

asyncAddEntry

public void asyncAddEntry(byte[] data,
 int numberOfMessages,
 int offset,
 int length,
 AsyncCallbacks.AddEntryCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Append a new entry asynchronously.

指定者:

asyncAddEntry 在接口中 ManagedLedger

参数:

data - data entry to be persisted

numberOfMessages - numberOfMessages of entry

offset - offset in the data array

length - number of bytes

callback - callback object

ctx - opaque context

另请参阅:

• ManagedLedger.addEntry(byte[])

asyncAddEntry

public void asyncAddEntry(io.netty.buffer.ByteBuf buffer,
 AsyncCallbacks.AddEntryCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Append a new entry asynchronously.

指定者:

asyncAddEntry 在接口中 ManagedLedger

参数:

buffer - buffer with the data entry

callback - callback object

ctx - opaque context

另请参阅:

• ManagedLedger.addEntry(byte[])

asyncAddEntry

public void asyncAddEntry(io.netty.buffer.ByteBuf buffer,
 int numberOfMessages,
 AsyncCallbacks.AddEntryCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Append a new entry asynchronously.

指定者:

asyncAddEntry 在接口中 ManagedLedger

参数:

buffer - buffer with the data entry

numberOfMessages - numberOfMessages for data entry

callback - callback object

ctx - opaque context

另请参阅:

• ManagedLedger.addEntry(byte[])

afterFailedAddEntry

protected void afterFailedAddEntry(int numOfMessages)

readyToCreateNewLedger

public void readyToCreateNewLedger()

从接口复制的说明: ManagedLedger

Signaling managed ledger that we can resume after BK write failure.

指定者:

readyToCreateNewLedger 在接口中 ManagedLedger

openCursor

public ManagedCursor openCursor(String cursorName)
                         throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Open a ManagedCursor in this ManagedLedger.

If the cursors doesn't exist, a new one will be created and its position will be at the end of the ManagedLedger.

指定者:

openCursor 在接口中 ManagedLedger

参数:

cursorName - the name associated with the ManagedCursor

返回:

the ManagedCursor

抛出:

ManagedLedgerException

InterruptedException

openCursor

public ManagedCursor openCursor(String cursorName,
 org.apache.pulsar.common.api.proto.CommandSubscribe.InitialPosition initialPosition)
                         throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Open a ManagedCursor in this ManagedLedger.

If the cursors doesn't exist, a new one will be created and its position will be at the end of the ManagedLedger.

指定者:

openCursor 在接口中 ManagedLedger

参数:

cursorName - the name associated with the ManagedCursor

initialPosition - if null, the cursor will be set at latest position when first created

返回:

the ManagedCursor

抛出:

ManagedLedgerException

InterruptedException

openCursor

public ManagedCursor openCursor(String cursorName,
 org.apache.pulsar.common.api.proto.CommandSubscribe.InitialPosition initialPosition,
 Map<String,Long> properties,
 Map<String,String> cursorProperties)
                         throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Open a ManagedCursor in this ManagedLedger.

If the cursors doesn't exist, a new one will be created and its position will be at the end of the ManagedLedger.

指定者:

openCursor 在接口中 ManagedLedger

参数:

cursorName - the name associated with the ManagedCursor

initialPosition - if null, the cursor will be set at latest position when first created

properties - user defined properties that will be attached to the first position of the cursor, if the open operation will trigger the creation of the cursor.

cursorProperties - the properties for the Cursor

返回:

the ManagedCursor

抛出:

ManagedLedgerException

InterruptedException

asyncOpenCursor

public void asyncOpenCursor(String cursorName,
 AsyncCallbacks.OpenCursorCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Open a ManagedCursor asynchronously.

指定者:

asyncOpenCursor 在接口中 ManagedLedger

参数:

cursorName - the name associated with the ManagedCursor

callback - callback object

ctx - opaque context

另请参阅:

• ManagedLedger.openCursor(String)

asyncOpenCursor

public void asyncOpenCursor(String cursorName,
 org.apache.pulsar.common.api.proto.CommandSubscribe.InitialPosition initialPosition,
 AsyncCallbacks.OpenCursorCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Open a ManagedCursor asynchronously.

指定者:

asyncOpenCursor 在接口中 ManagedLedger

参数:

cursorName - the name associated with the ManagedCursor

initialPosition - if null, the cursor will be set at latest position when first created

callback - callback object

ctx - opaque context

另请参阅:

• ManagedLedger.openCursor(String)

asyncOpenCursor

public void asyncOpenCursor(String cursorName,
 org.apache.pulsar.common.api.proto.CommandSubscribe.InitialPosition initialPosition,
 Map<String,Long> properties,
 Map<String,String> cursorProperties,
 AsyncCallbacks.OpenCursorCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Open a ManagedCursor asynchronously.

指定者:

asyncOpenCursor 在接口中 ManagedLedger

参数:

cursorName - the name associated with the ManagedCursor

initialPosition - if null, the cursor will be set at latest position when first created

cursorProperties - the properties for the Cursor

callback - callback object

ctx - opaque context

另请参阅:

• ManagedLedger.openCursor(String)

asyncDeleteCursor

public void asyncDeleteCursor(String consumerName,
 AsyncCallbacks.DeleteCursorCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Delete a ManagedCursor asynchronously.

指定者:

asyncDeleteCursor 在接口中 ManagedLedger

参数:

consumerName - the name associated with the ManagedCursor

callback - callback object

ctx - opaque context

另请参阅:

• ManagedLedger.deleteCursor(String)

deleteCursor

public void deleteCursor(String name)
                  throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Remove a ManagedCursor from this ManagedLedger.

If the cursor doesn't exist, the operation will still succeed.

指定者:

deleteCursor 在接口中 ManagedLedger

参数:

name - the name associated with the ManagedCursor

抛出:

InterruptedException

ManagedLedgerException

newNonDurableCursor

public ManagedCursor newNonDurableCursor(Position startCursorPosition)
                                  throws ManagedLedgerException

从接口复制的说明: ManagedLedger

Creates a new cursor whose metadata is not backed by durable storage. A caller can treat the non-durable cursor exactly like a normal cursor, with the only difference in that after restart it will not remember which entries were deleted. Also it does not prevent data from being deleted.

The cursor is anonymous and can be positioned on an arbitrary position.

This method is not-blocking.

指定者:

newNonDurableCursor 在接口中 ManagedLedger

参数:

startCursorPosition - the position where the cursor should be initialized, or null to start from the current latest entry. When starting on a particular cursor position, the first entry to be returned will be the entry next to the specified position

返回:

the new NonDurableCursor

抛出:

ManagedLedgerException

newNonDurableCursor

public ManagedCursor newNonDurableCursor(Position startPosition,
 String subscriptionName)
                                  throws ManagedLedgerException

指定者:

newNonDurableCursor 在接口中 ManagedLedger

抛出:

ManagedLedgerException

newNonDurableCursor

public ManagedCursor newNonDurableCursor(Position startCursorPosition,
 String cursorName,
 org.apache.pulsar.common.api.proto.CommandSubscribe.InitialPosition initialPosition,
 boolean isReadCompacted)
                                  throws ManagedLedgerException

指定者:

newNonDurableCursor 在接口中 ManagedLedger

抛出:

ManagedLedgerException

getCursors

public ManagedCursorContainer getCursors()

从接口复制的说明: ManagedLedger

Get a list of all the cursors reading from this ManagedLedger.

指定者:

getCursors 在接口中 ManagedLedger

返回:

a list of cursors

getActiveCursors

public ManagedCursorContainer getActiveCursors()

从接口复制的说明: ManagedLedger

Get a list of all the active cursors reading from this ManagedLedger.

指定者:

getActiveCursors 在接口中 ManagedLedger

返回:

a list of cursors

hasActiveCursors

public boolean hasActiveCursors()

Tells whether the managed ledger has any active-cursor registered.

返回:

true if at least a cursor exists

getNumberOfEntries

public long getNumberOfEntries()

从接口复制的说明: ManagedLedger

Get the total number of entries for this managed ledger.

This is defined by the number of entries in all the BookKeeper ledgers that are being maintained by this ManagedLedger.

This method is non-blocking.

指定者:

getNumberOfEntries 在接口中 ManagedLedger

返回:

the number of entries

getNumberOfActiveEntries

public long getNumberOfActiveEntries()

从接口复制的说明: ManagedLedger

Get the total number of active entries for this managed ledger.

This is defined by the number of non consumed entries in all the BookKeeper ledgers that are being maintained by this ManagedLedger.

This method is non-blocking.

指定者:

getNumberOfActiveEntries 在接口中 ManagedLedger

返回:

the number of entries

getTotalSize

public long getTotalSize()

从接口复制的说明: ManagedLedger

Get the total sizes in bytes of the managed ledger, without accounting for replicas.

This is defined by the sizes of all the BookKeeper ledgers that are being maintained by this ManagedLedger.

This method is non-blocking.

指定者:

getTotalSize 在接口中 ManagedLedger

返回:

total size in bytes

getEstimatedBacklogSize

public long getEstimatedBacklogSize()

从接口复制的说明: ManagedLedger

Get estimated total unconsumed or backlog size in bytes for the managed ledger, without accounting for replicas.

指定者:

getEstimatedBacklogSize 在接口中 ManagedLedger

返回:

estimated total backlog size

getEarliestMessagePublishTimeInBacklog

public CompletableFuture<Long> getEarliestMessagePublishTimeInBacklog()

从接口复制的说明: ManagedLedger

Get the publishing time of the oldest message in the backlog.

指定者:

getEarliestMessagePublishTimeInBacklog 在接口中 ManagedLedger

返回:

the publishing time of the oldest message

getEarliestMessagePublishTimeOfPos

public CompletableFuture<Long> getEarliestMessagePublishTimeOfPos(PositionImpl pos)

getEstimatedBacklogSize

public long getEstimatedBacklogSize(PositionImpl pos)

Get estimated backlog size from a specific position.

asyncTerminate

public void asyncTerminate(AsyncCallbacks.TerminateCallback callback,
 Object ctx)

指定者:

asyncTerminate 在接口中 ManagedLedger

terminate

public Position terminate()
                   throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Terminate the managed ledger and return the last committed entry.

Once the managed ledger is terminated, it will not accept any more write

指定者:

terminate 在接口中 ManagedLedger

返回:

抛出:

InterruptedException

ManagedLedgerException

isTerminated

public boolean isTerminated()

从接口复制的说明: ManagedLedger

Returns whether the managed ledger was terminated.

指定者:

isTerminated 在接口中 ManagedLedger

close

public void close()
           throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Close the ManagedLedger.

This will close all the underlying BookKeeper ledgers. All the ManagedCursors associated will be invalidated.

指定者:

close 在接口中 ManagedLedger

抛出:

ManagedLedgerException

InterruptedException

asyncClose

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

从接口复制的说明: ManagedLedger

Close the ManagedLedger asynchronously.

指定者:

asyncClose 在接口中 ManagedLedger

参数:

callback - callback object

ctx - opaque context

另请参阅:

• ManagedLedger.close()

createComplete

public void createComplete(int rc,
 org.apache.bookkeeper.client.LedgerHandle lh,
 Object ctx)

指定者:

createComplete 在接口中 org.apache.bookkeeper.client.AsyncCallback.CreateCallback

updateLedgersIdsComplete

public void updateLedgersIdsComplete(@Nullable
 org.apache.bookkeeper.client.LedgerHandle originalCurrentLedger)

rollCurrentLedgerIfFull

public void rollCurrentLedgerIfFull()

从接口复制的说明: ManagedLedger

Roll current ledger if it is full.

指定者:

rollCurrentLedgerIfFull 在接口中 ManagedLedger

asyncFindPosition

public CompletableFuture<Position> asyncFindPosition(com.google.common.base.Predicate<Entry> predicate)

从接口复制的说明: ManagedLedger

Find position by sequenceId.

指定者:

asyncFindPosition 在接口中 ManagedLedger

getManagedLedgerInterceptor

public ManagedLedgerInterceptor getManagedLedgerInterceptor()

从接口复制的说明: ManagedLedger

Get the ManagedLedgerInterceptor for ManagedLedger.

指定者:

getManagedLedgerInterceptor 在接口中 ManagedLedger

getLedgerMetadata

public CompletableFuture<String> getLedgerMetadata(long ledgerId)

getLedgerInfo

public CompletableFuture<MLDataFormats.ManagedLedgerInfo.LedgerInfo> getLedgerInfo(long ledgerId)

从接口复制的说明: ManagedLedger

Get basic ledger summary. will got null if corresponding ledger not exists.

指定者:

getLedgerInfo 在接口中 ManagedLedger

getOptionalLedgerInfo

public Optional<MLDataFormats.ManagedLedgerInfo.LedgerInfo> getOptionalLedgerInfo(long ledgerId)

从接口复制的说明: ManagedLedger

Get basic ledger summary. will get Optional.empty() if corresponding ledger not exists.

指定者:

getOptionalLedgerInfo 在接口中 ManagedLedger

invalidateLedgerHandle

public void invalidateLedgerHandle(org.apache.bookkeeper.client.api.ReadHandle ledgerHandle)

asyncReadEntry

public void asyncReadEntry(PositionImpl position,
 AsyncCallbacks.ReadEntryCallback callback,
 Object ctx)

asyncReadEntry

protected void asyncReadEntry(org.apache.bookkeeper.client.api.ReadHandle ledger,
 PositionImpl position,
 AsyncCallbacks.ReadEntryCallback callback,
 Object ctx)

asyncReadEntry

protected void asyncReadEntry(org.apache.bookkeeper.client.api.ReadHandle ledger,
 long firstEntry,
 long lastEntry,
 boolean isSlowestReader,
 org.apache.bookkeeper.mledger.impl.OpReadEntry opReadEntry,
 Object ctx)

getStats

public ManagedLedgerMXBean getStats()

指定者:

getStats 在接口中 ManagedLedger

返回:

the managed ledger stats MBean

hasMoreEntries

public boolean hasMoreEntries(PositionImpl position)

onCursorReadPositionUpdated

public void onCursorReadPositionUpdated(ManagedCursorImpl cursor,
 Position newReadPosition)

addWaitingEntryCallBack

public void addWaitingEntryCallBack(WaitingEntryCallBack cb)

maybeUpdateCursorBeforeTrimmingConsumedLedger

public void maybeUpdateCursorBeforeTrimmingConsumedLedger()

trimConsumedLedgersInBackground

public void trimConsumedLedgersInBackground(CompletableFuture<?> promise)

从接口复制的说明: ManagedLedger

Trim consumed ledgers in background.

指定者:

trimConsumedLedgersInBackground 在接口中 ManagedLedger

trimConsumedLedgersInBackground

public void trimConsumedLedgersInBackground(boolean isTruncate,
 CompletableFuture<?> promise)

delete

public void delete()
            throws InterruptedException,
ManagedLedgerException

Delete this ManagedLedger completely from the system.

指定者:

delete 在接口中 ManagedLedger

抛出:

Exception

InterruptedException

ManagedLedgerException

asyncDelete

public void asyncDelete(AsyncCallbacks.DeleteLedgerCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Async delete a ledger.

指定者:

asyncDelete 在接口中 ManagedLedger

offloadPrefix

public Position offloadPrefix(Position pos)
                       throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Offload as many entries before position as possible to longterm storage.

指定者:

offloadPrefix 在接口中 ManagedLedger

参数:

pos - the position before which entries will be offloaded

返回:

the earliest position which was not offloaded

抛出:

InterruptedException

ManagedLedgerException

另请参阅:

• ManagedLedger.asyncOffloadPrefix(Position,OffloadCallback,Object)

asyncOffloadPrefix

public void asyncOffloadPrefix(Position pos,
 AsyncCallbacks.OffloadCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Offload as many entries before position as possible to longterm storage. As internally, entries is stored in ledgers, and ledgers can only be operated on as a whole, it is likely not possible to offload every entry before the passed in position. Only complete ledgers will be offloaded. On completion a position will be passed to the callback. This position is the earliest entry which was not offloaded.

指定者:

asyncOffloadPrefix 在接口中 ManagedLedger

参数:

pos - the position before which entries will be offloaded

callback - a callback which will be supplied with the earliest unoffloaded position on completion

ctx - a context object which will be passed to the callback on completion

getPositionAfterN

public PositionImpl getPositionAfterN(PositionImpl startPosition,
 long n,
 ManagedLedgerImpl.PositionBound startRange)

Get the entry position at a given distance from a given position.

参数:

startPosition - starting position

n - number of entries to skip ahead

startRange - specifies whether or not to include the start position in calculating the distance

返回:

the new position that is n entries ahead

getPreviousPosition

public PositionImpl getPreviousPosition(PositionImpl position)

Get the entry position that come before the specified position in the message stream, using information from the ledger list and each ledger entries count.

参数:

position - the current position

返回:

the previous position

isValidPosition

public boolean isValidPosition(PositionImpl position)

Validate whether a specified position is valid for the current managed ledger.

参数:

position - the position to validate

返回:

true if the position is valid, false otherwise

ledgerExists

public boolean ledgerExists(long ledgerId)

getNextValidLedger

public Long getNextValidLedger(long ledgerId)

getNextValidPosition

public PositionImpl getNextValidPosition(PositionImpl position)

getNextValidPositionInternal

public PositionImpl getNextValidPositionInternal(PositionImpl position)

getFirstPosition

public PositionImpl getFirstPosition()

getSlowestConsumer

public ManagedCursor getSlowestConsumer()

从接口复制的说明: ManagedLedger

Get the slowest consumer.

指定者:

getSlowestConsumer 在接口中 ManagedLedger

返回:

the slowest consumer

activateCursor

public void activateCursor(ManagedCursor cursor)

deactivateCursor

public void deactivateCursor(ManagedCursor cursor)

removeWaitingCursor

public void removeWaitingCursor(ManagedCursor cursor)

从接口复制的说明: ManagedLedger

Remove a ManagedCursor from this ManagedLedger's waitingCursors.

指定者:

removeWaitingCursor 在接口中 ManagedLedger

参数:

cursor - the ManagedCursor

isCursorActive

public boolean isCursorActive(ManagedCursor cursor)

getLedgersInfoAsList

public List<MLDataFormats.ManagedLedgerInfo.LedgerInfo> getLedgersInfoAsList()

getLedgersInfo

public NavigableMap<Long,MLDataFormats.ManagedLedgerInfo.LedgerInfo> getLedgersInfo()

getConfig

public ManagedLedgerConfig getConfig()

从接口复制的说明: ManagedLedger

Returns managed-ledger config.

指定者:

getConfig 在接口中 ManagedLedger

setConfig

public void setConfig(ManagedLedgerConfig config)

从接口复制的说明: ManagedLedger

Updates managed-ledger config.

指定者:

setConfig 在接口中 ManagedLedger

getEntriesAddedCounter

public long getEntriesAddedCounter()

getCurrentLedgerEntries

public long getCurrentLedgerEntries()

getCurrentLedgerSize

public long getCurrentLedgerSize()

getLastLedgerCreatedTimestamp

public long getLastLedgerCreatedTimestamp()

getLastLedgerCreationFailureTimestamp

public long getLastLedgerCreationFailureTimestamp()

getWaitingCursorsCount

public int getWaitingCursorsCount()

getPendingAddEntriesCount

public int getPendingAddEntriesCount()

getLastConfirmedEntry

public Position getLastConfirmedEntry()

从接口复制的说明: ManagedLedger

Gets last confirmed entry of the managed ledger.

指定者:

getLastConfirmedEntry 在接口中 ManagedLedger

返回:

the last confirmed entry id

getState

public ManagedLedgerImpl.State getState()

getCacheSize

public long getCacheSize()

isReadOnly

protected boolean isReadOnly()

createManagedLedgerException

public static ManagedLedgerException createManagedLedgerException(int bkErrorCode)

createManagedLedgerException

public static ManagedLedgerException createManagedLedgerException(Throwable t)

asyncCreateLedger

protected void asyncCreateLedger(org.apache.bookkeeper.client.BookKeeper bookKeeper,
 ManagedLedgerConfig config,
 org.apache.bookkeeper.client.BookKeeper.DigestType digestType,
 org.apache.bookkeeper.client.AsyncCallback.CreateCallback cb,
 Map<String,byte[]> metadata)

Create ledger async and schedule a timeout task to check ledger-creation is complete else it fails the callback with TimeoutException.

参数:

bookKeeper -

config -

digestType -

cb -

metadata -

getClock

public Clock getClock()

checkAndCompleteLedgerOpTask

protected boolean checkAndCompleteLedgerOpTask(int rc,
 org.apache.bookkeeper.client.LedgerHandle lh,
 Object ctx)

check if ledger-op task is already completed by timeout-task. If completed then delete the created ledger

参数:

rc -

lh -

ctx -

返回:

getOffloadedSize

public long getOffloadedSize()

从接口复制的说明: ManagedLedger

Return the size of all ledgers offloaded to 2nd tier storage.

指定者:

getOffloadedSize 在接口中 ManagedLedger

getLastOffloadedLedgerId

public long getLastOffloadedLedgerId()

从接口复制的说明: ManagedLedger

Get last offloaded ledgerId. If no offloaded yet, it returns 0.

指定者:

getLastOffloadedLedgerId 在接口中 ManagedLedger

返回:

last offloaded ledgerId

getLastOffloadedSuccessTimestamp

public long getLastOffloadedSuccessTimestamp()

从接口复制的说明: ManagedLedger

Get last suceessful offloaded timestamp. If no successful offload, it returns 0.

指定者:

getLastOffloadedSuccessTimestamp 在接口中 ManagedLedger

返回:

last successful offloaded timestamp

getLastOffloadedFailureTimestamp

public long getLastOffloadedFailureTimestamp()

从接口复制的说明: ManagedLedger

Get last failed offloaded timestamp. If no failed offload, it returns 0.

指定者:

getLastOffloadedFailureTimestamp 在接口中 ManagedLedger

返回:

last failed offloaded timestamp

getProperties

public Map<String,String> getProperties()

从接口复制的说明: ManagedLedger

Returns managed-ledger's properties.

指定者:

getProperties 在接口中 ManagedLedger

返回:

key-values of properties

setProperty

public void setProperty(String key,
 String value)
                 throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Add key-value to propertiesMap.

指定者:

setProperty 在接口中 ManagedLedger

参数:

key - key of property to add

value - value of property to add

抛出:

InterruptedException

ManagedLedgerException

asyncSetProperty

public void asyncSetProperty(String key,
 String value,
 AsyncCallbacks.UpdatePropertiesCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Async add key-value to propertiesMap.

指定者:

asyncSetProperty 在接口中 ManagedLedger

参数:

key - key of property to add

value - value of property to add

callback - a callback which will be supplied with the newest properties in managedLedger.

ctx - a context object which will be passed to the callback on completion.

deleteProperty

public void deleteProperty(String key)
                    throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Delete the property by key.

指定者:

deleteProperty 在接口中 ManagedLedger

参数:

key - key of property to delete

抛出:

InterruptedException

ManagedLedgerException

asyncDeleteProperty

public void asyncDeleteProperty(String key,
 AsyncCallbacks.UpdatePropertiesCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Async delete the property by key.

指定者:

asyncDeleteProperty 在接口中 ManagedLedger

参数:

key - key of property to delete

callback - a callback which will be supplied with the newest properties in managedLedger.

ctx - a context object which will be passed to the callback on completion.

setProperties

public void setProperties(Map<String,String> properties)
                   throws InterruptedException,
ManagedLedgerException

从接口复制的说明: ManagedLedger

Update managed-ledger's properties.

指定者:

setProperties 在接口中 ManagedLedger

参数:

properties - key-values of properties

抛出:

InterruptedException

ManagedLedgerException

asyncSetProperties

public void asyncSetProperties(Map<String,String> properties,
 AsyncCallbacks.UpdatePropertiesCallback callback,
 Object ctx)

从接口复制的说明: ManagedLedger

Async update managed-ledger's properties.

指定者:

asyncSetProperties 在接口中 ManagedLedger

参数:

properties - key-values of properties.

callback - a callback which will be supplied with the newest properties in managedLedger.

ctx - a context object which will be passed to the callback on completion.

setEntriesAddedCounter

public void setEntriesAddedCounter(long count)

asyncTruncate

public CompletableFuture<Void> asyncTruncate()

从接口复制的说明: ManagedLedger

Truncate ledgers The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers.

指定者:

asyncTruncate 在接口中 ManagedLedger

getManagedLedgerInternalStats

public CompletableFuture<org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats> getManagedLedgerInternalStats(boolean includeLedgerMetadata)

从接口复制的说明: ManagedLedger

Get managed ledger internal stats.

指定者:

getManagedLedgerInternalStats 在接口中 ManagedLedger

参数:

includeLedgerMetadata - the flag to control managed ledger internal stats include ledger metadata

返回:

the future of managed ledger internal stats

getEnsemblesAsync

public CompletableFuture<Set<org.apache.bookkeeper.net.BookieId>> getEnsemblesAsync(long ledgerId)

checkInactiveLedgerAndRollOver

public void checkInactiveLedgerAndRollOver()

从接口复制的说明: ManagedLedger

Check current inactive ledger (based on ManagedLedgerConfig.getInactiveLedgerRollOverTimeMs() and roll over that ledger if inactive.

指定者:

checkInactiveLedgerAndRollOver 在接口中 ManagedLedger

getTheSlowestNonDurationReadPosition

public Position getTheSlowestNonDurationReadPosition()