org.apache.pulsar.broker.systopic

Interface SystemTopicClient

All Known Implementing Classes:

SystemTopicClientBase, TopicPoliciesSystemTopicClient

public interface SystemTopicClient

Pulsar system topic

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	close() Close the system topic
CompletableFuture<Void>	closeAsync() Close the system topic asynchronously.
List<SystemTopicClient.Reader>	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>	getWriters() Get all writers of the system topic
static boolean	isSystemTopic(org.apache.pulsar.common.naming.TopicName topicName)
SystemTopicClient.Reader	newReader() Create a reader for the system topic.
CompletableFuture<SystemTopicClient.Reader>	newReaderAsync() Create a reader for the system topic asynchronously.
SystemTopicClient.Writer	newWriter() Create a writer for the system topic.
CompletableFuture<SystemTopicClient.Writer>	newWriterAsync() Create a writer for the system topic asynchronously.

Method Detail

getTopicName

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

Get topic name of the system topic.

Returns:

topic name

newReader

SystemTopicClient.Reader 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> newReaderAsync()

Create a reader for the system topic asynchronously.

newWriter

SystemTopicClient.Writer 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> 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> getWriters()

Get all writers of the system topic

Returns:

writer list

getReaders

List<SystemTopicClient.Reader> getReaders()

Get all readers of the system topic

Returns:

reader list

isSystemTopic

static boolean isSystemTopic(org.apache.pulsar.common.naming.TopicName topicName)