io.zeebe.logstreams.impl.service

Class LogStreamService

java.lang.Object

io.zeebe.logstreams.impl.service.LogStreamService

All Implemented Interfaces:

LogStream, Service<LogStream>, AutoCloseable

public class LogStreamService
extends Object
implements LogStream, Service<LogStream>

Field Summary

Fields inherited from interface io.zeebe.logstreams.log.LogStream

DEFAULT_MAX_APPEND_BLOCK_SIZE

Constructor Summary

Constructors

Constructor and Description
LogStreamService(LogStreamBuilder builder)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the log stream synchronously.
ActorFuture<Void>	closeAppender() Stops the streaming to the log storage.
ActorFuture<Void>	closeAsync() Closes the log stream asynchronous.
LogStream	get()
long	getCommitPosition()
LogBlockIndex	getLogBlockIndex() Returns the LogBlockIndex object, which is used for indexing the LogStorage.
Injector<LogBlockIndex>	getLogBlockIndexInjector()
LogBlockIndexWriter	getLogBlockIndexWriter() Returns the log block index controller, which creates periodically the block index for the log storage.
Injector<LogBlockIndexWriter>	getLogBockIndexWriterInjector()
String	getLogName() Returns the name of the log stream.
LogStorage	getLogStorage() Returns the log storage, which is accessed by the LogStream.
LogStorageAppender	getLogStorageAppender() Returns the log stream controller, which streams the logged events from the write buffer into the log storage.
Injector<LogStorage>	getLogStorageInjector()
int	getPartitionId()
int	getTerm()
Dispatcher	getWriteBuffer() Returns the writeBuffer, which is used by the LogStreamController to stream the content into the log storage.
ActorFuture<LogStorageAppender>	openAppender() This method delegates to #openLogStreamController(AgentRunnerService, int).
void	registerOnAppendCondition(ActorCondition condition)
void	registerOnCommitPositionUpdatedCondition(ActorCondition condition)
void	removeOnAppendCondition(ActorCondition condition)
void	removeOnCommitPositionUpdatedCondition(ActorCondition condition)
void	setCommitPosition(long commitPosition) Sets the log streams commit position to the given position.
void	setTerm(int term) Sets the log streams term.
void	start(ServiceStartContext startContext)
void	stop(ServiceStopContext stopContext)
void	truncate(long position) Truncates the log stream from the given position to the end of the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogStreamService

public LogStreamService(LogStreamBuilder builder)

Method Detail

start

public void start(ServiceStartContext startContext)

Specified by:

start in interface Service<LogStream>

openAppender

public ActorFuture<LogStorageAppender> openAppender()

Description copied from interface: LogStream

This method delegates to #openLogStreamController(AgentRunnerService, int).

The LogStream.DEFAULT_MAX_APPEND_BLOCK_SIZE is used as default max append block size and the old agent runner service is reused.

Specified by:

openAppender in interface LogStream

Returns:

returns the future for the log stream controller opening

See Also:

#openLogStreamController(AgentRunnerService, int)}

closeAppender

public ActorFuture<Void> closeAppender()

Description copied from interface: LogStream

Stops the streaming to the log storage. New events are no longer append to the log storage.

Specified by:

closeAppender in interface LogStream

stop

public void stop(ServiceStopContext stopContext)

Specified by:

stop in interface Service<LogStream>

get

public LogStream get()

Specified by:

get in interface Service<LogStream>

getPartitionId

public int getPartitionId()

Specified by:

getPartitionId in interface LogStream

Returns:

the partition id of the log stream

getLogName

public String getLogName()

Description copied from interface: LogStream

Returns the name of the log stream.

Specified by:

getLogName in interface LogStream

Returns:

the log stream name

close

public void close()

Description copied from interface: LogStream

Closes the log stream synchronously. This blocks until the log stream is closed.

Specified by:

close in interface LogStream

Specified by:

close in interface AutoCloseable

closeAsync

public ActorFuture<Void> closeAsync()

Description copied from interface: LogStream

Closes the log stream asynchronous.

Specified by:

closeAsync in interface LogStream

getLogStorage

public LogStorage getLogStorage()

Description copied from interface: LogStream

Returns the log storage, which is accessed by the LogStream.

Specified by:

getLogStorage in interface LogStream

Returns:

the log storage

getLogBlockIndex

public LogBlockIndex getLogBlockIndex()

Description copied from interface: LogStream

Returns the LogBlockIndex object, which is used for indexing the LogStorage.

Specified by:

getLogBlockIndex in interface LogStream

Returns:

the log block index

getLogBlockIndexWriter

public LogBlockIndexWriter getLogBlockIndexWriter()

Description copied from interface: LogStream

Returns the log block index controller, which creates periodically the block index for the log storage.

Specified by:

getLogBlockIndexWriter in interface LogStream

Returns:

the log block index controller

getWriteBuffer

public Dispatcher getWriteBuffer()

Description copied from interface: LogStream

Returns the writeBuffer, which is used by the LogStreamController to stream the content into the log storage.

Specified by:

getWriteBuffer in interface LogStream

Returns:

the writebuffer, which is used by the LogStreamController

getLogStorageAppender

public LogStorageAppender getLogStorageAppender()

Description copied from interface: LogStream

Returns the log stream controller, which streams the logged events from the write buffer into the log storage.

Specified by:

getLogStorageAppender in interface LogStream

Returns:

the log stream controller

getCommitPosition

public long getCommitPosition()

Specified by:

getCommitPosition in interface LogStream

Returns:

the current commit position, or a negative value if no entry is committed.

truncate

public void truncate(long position)

Description copied from interface: LogStream

Truncates the log stream from the given position to the end of the stream. Each event which has a higher position as the given will be truncated. This method will truncated the log storage and block index.

Specified by:

truncate in interface LogStream

Parameters:

position - the position to start the truncation

setCommitPosition

public void setCommitPosition(long commitPosition)

Description copied from interface: LogStream

Sets the log streams commit position to the given position.

Specified by:

setCommitPosition in interface LogStream

registerOnCommitPositionUpdatedCondition

public void registerOnCommitPositionUpdatedCondition(ActorCondition condition)

Specified by:

registerOnCommitPositionUpdatedCondition in interface LogStream

removeOnCommitPositionUpdatedCondition

public void removeOnCommitPositionUpdatedCondition(ActorCondition condition)

Specified by:

removeOnCommitPositionUpdatedCondition in interface LogStream

registerOnAppendCondition

public void registerOnAppendCondition(ActorCondition condition)

Specified by:

registerOnAppendCondition in interface LogStream

removeOnAppendCondition

public void removeOnAppendCondition(ActorCondition condition)

Specified by:

removeOnAppendCondition in interface LogStream

getTerm

public int getTerm()

Specified by:

getTerm in interface LogStream

Returns:

the current term in which the log stream is active

setTerm

public void setTerm(int term)

Description copied from interface: LogStream

Sets the log streams term.

Specified by:

setTerm in interface LogStream

getLogBlockIndexInjector

public Injector<LogBlockIndex> getLogBlockIndexInjector()

getLogBockIndexWriterInjector

public Injector<LogBlockIndexWriter> getLogBockIndexWriterInjector()

getLogStorageInjector

public Injector<LogStorage> getLogStorageInjector()