tech.ydb.topic.write

Interface SyncWriter

All Known Implementing Classes:

SyncWriterImpl

public interface SyncWriter

Author:

Nikolay Perfilov

Method Summary

Modifier and Type	Method and Description
void	flush() Waits until all current writes will be sent to server and response will be received.
void	init() Initialize internal threads in the background.
InitResult	initAndWait() Initialize internal threads and wait for server init response.
default void	send(Message message) Send message.
default void	send(Message message, long timeout, TimeUnit unit) Send message.
void	send(Message message, SendSettings settings) Send message.
void	send(Message message, SendSettings settings, long timeout, TimeUnit unit) Send message.
void	shutdown(long timeout, TimeUnit unit) Stops internal threads and makes cleanup in background.

Method Detail

init

void init()

Initialize internal threads in the background. Non-blocking

initAndWait

InitResult initAndWait()

Initialize internal threads and wait for server init response. Blocking

Returns:

InitResult containing initialization data like lastSeqNo

send

void send(Message message,
          SendSettings settings)

Send message. Blocks infinitely until the message is put into sending buffer.

Parameters:

message - message data to write

settings - send settings

send

void send(Message message,
          SendSettings settings,
          long timeout,
          TimeUnit unit)
   throws InterruptedException,
          ExecutionException,
          TimeoutException

Send message. Blocks until the message is put into sending buffer. If in-flight or memory usage limits is reached, waits until timeout expires and then throws TimeoutException if message was not put into queue

Parameters:

message - message data to write

settings - send settings

timeout - timeout to wait until message is punt into sending buffer

unit - TimeUnit for timeout

Throws:

InterruptedException

ExecutionException

TimeoutException

send

default void send(Message message)

Send message. Blocks infinitely until the message is put into sending buffer.

Parameters:

message - message data to write

send

default void send(Message message,
                  long timeout,
                  TimeUnit unit)
           throws InterruptedException,
                  ExecutionException,
                  TimeoutException

Send message. Blocks until the message is put into sending buffer. If in-flight or memory usage limits is reached, waits until timeout expires and then throws TimeoutException if message was not put into queue

Parameters:

message - message data to write

timeout - timeout to wait until message is punt into sending buffer

unit - TimeUnit for timeout

Throws:

InterruptedException

ExecutionException

TimeoutException

flush

void flush()

Waits until all current writes will be sent to server and response will be received. Blocking

shutdown

void shutdown(long timeout,
              TimeUnit unit)
       throws InterruptedException,
              ExecutionException,
              TimeoutException

Stops internal threads and makes cleanup in background. Blocking

Throws:

InterruptedException

ExecutionException

TimeoutException