tech.ydb.topic.read

Interface SyncReader

All Known Implementing Classes:

SyncReaderImpl

public interface SyncReader

Author:

Nikolay Perfilov

Method Summary

Modifier and Type	Method and Description
void	init() Initialize reading in the background.
void	initAndWait() Initialize internal threads and wait for server init response.
default Message	receive() Receive a Message.
default Message	receive(long timeout, TimeUnit unit) Receive a Message.
Message	receive(ReceiveSettings settings) Receive a Message.
void	shutdown() Stops internal threads and makes cleanup in background.

Method Detail

init

void init()

Initialize reading in the background. Non-blocking

initAndWait

void initAndWait()

Initialize internal threads and wait for server init response. Blocking

receive

Message receive(ReceiveSettings settings)
         throws InterruptedException

Receive a Message. Blocks until a Message is received.

Parameters:

settings - settings for receiving a Message

Returns:

returns a Message, or null if the specified timeout time elapses before a message is available

Throws:

InterruptedException

receive

@Nullable
default Message receive(long timeout,
                                  TimeUnit unit)
                           throws InterruptedException

Receive a Message. Blocks until a Message is received.

Parameters:

timeout - timeout to wait a Message with

unit - TimeUnit for timeout

Returns:

returns a Message, or null if the specified waiting time elapses before a message is available

Throws:

InterruptedException

receive

default Message receive()
                 throws InterruptedException

Receive a Message. Blocks until a Message is received.

Returns:

Message

Throws:

InterruptedException

shutdown

void shutdown()

Stops internal threads and makes cleanup in background. Blocking