Package org.apache.pulsar.broker.systopic

Interface SystemTopicClient<T>

All Known Implementing Classes:

SystemTopicClientBase, TopicPoliciesSystemTopicClient, TransactionBufferSystemTopicClient

public interface SystemTopicClient<T>

Pulsar system topic.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SystemTopicClient.Reader<T>	Reader for system topic.
static interface	SystemTopicClient.Writer<T>	Writer for system topic.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the system topic.
CompletableFuture<Void>	closeAsync()	Close the system topic asynchronously.
List<SystemTopicClient.Reader<T>>	getReaders()	Get all readers of the system topic.
org.apache.pulsar.common.naming.TopicName	getTopicName()	Get topic name of the system topic.
List<SystemTopicClient.Writer<T>>	getWriters()	Get all writers of the system topic.
SystemTopicClient.Reader<T>	newReader()	Create a reader for the system topic.
CompletableFuture<SystemTopicClient.Reader<T>>	newReaderAsync()	Create a reader for the system topic asynchronously.
SystemTopicClient.Writer<T>	newWriter()	Create a writer for the system topic.
CompletableFuture<SystemTopicClient.Writer<T>>	newWriterAsync()	Create a writer for the system topic asynchronously.

Method Details

getTopicName

org.apache.pulsar.common.naming.TopicName getTopicName()

Get topic name of the system topic.

Returns:

topic name

newReader

SystemTopicClient.Reader<T> newReader()
                               throws org.apache.pulsar.client.api.PulsarClientException

Create a reader for the system topic.

Returns:

a new reader for the system topic

Throws:

org.apache.pulsar.client.api.PulsarClientException

newReaderAsync

CompletableFuture<SystemTopicClient.Reader<T>> newReaderAsync()

Create a reader for the system topic asynchronously.

newWriter

SystemTopicClient.Writer<T> newWriter()
                               throws org.apache.pulsar.client.api.PulsarClientException

Create a writer for the system topic.

Returns:

writer for the system topic

Throws:

org.apache.pulsar.client.api.PulsarClientException

newWriterAsync

CompletableFuture<SystemTopicClient.Writer<T>> newWriterAsync()

Create a writer for the system topic asynchronously.

close

void close()
    throws Exception

Close the system topic.

Throws:

Exception

closeAsync

CompletableFuture<Void> closeAsync()

Close the system topic asynchronously.

Returns:

getWriters

List<SystemTopicClient.Writer<T>> getWriters()

Get all writers of the system topic.

Returns:

Set the set of writers

getReaders

List<SystemTopicClient.Reader<T>> getReaders()

Get all readers of the system topic.

Returns:

Set the set of readers