io.camunda.zeebe.logstreams.log.LogStream Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH under
* one or more contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright ownership.
* Licensed under the Zeebe Community License 1.1. You may not use this file
* except in compliance with the Zeebe Community License 1.1.
*/
package io.camunda.zeebe.logstreams.log;
import io.camunda.zeebe.logstreams.impl.log.LogStreamBuilderImpl;
import io.camunda.zeebe.scheduler.AsyncClosable;
import io.camunda.zeebe.scheduler.future.ActorFuture;
import io.camunda.zeebe.util.health.HealthMonitorable;
/**
* Represents a stream of events. New events are append to the end of the log. With {@link
* LogStream#newLogStreamWriter()} new writers can be created, which can be used to append new
* events to the log.
*
* To read events, the {@link LogStream#newLogStreamReader()} ()} can be used.
*/
public interface LogStream extends AsyncClosable, AutoCloseable, HealthMonitorable {
/**
* @return a new default LogStream builder
*/
static LogStreamBuilder builder() {
return new LogStreamBuilderImpl();
}
/**
* @return the partition id of the log stream
*/
int getPartitionId();
/**
* Returns the name of the log stream.
*
* @return the log stream name
*/
String getLogName();
/**
* @return a future, when successfully completed it returns a newly created log stream reader
*/
ActorFuture newLogStreamReader();
/**
* @return a future, when successfully completed it returns a newly created log stream record
* writer
*/
ActorFuture newLogStreamWriter();
/**
* Registers a listener that will be notified when new records are available to read from the
* logstream.
*
* @param recordAwaiter the listener to be notified
*/
void registerRecordAvailableListener(LogRecordAwaiter recordAwaiter);
/**
* Removes the listener.
*
* @param recordAwaiter the listener to remove
*/
void removeRecordAvailableListener(LogRecordAwaiter recordAwaiter);
}