io.jooby

Interface Sender

public interface Sender

Non-blocking sender. Reactive responses uses this class to send partial data in non-blocking manner. RxJava example:

   Sender sender = ctx.getSender();

   Flux.fromCallable(...)
     .subscribe(new Subscriber () {

       onSubscribe(Subscription s) {
         this.subscription = s;
         this.subscription.request(1);
       }

       onNext(Object next) {
         sender.write(next, (ctx, cause) -> {
           subscription.request(1);
         });
       }

       onError(Throwable error) {
         subscription.cancel();
       }

       onComplete() {
         sender.close();
       }
     })

 

Since:

2.0.0

Author:

edgar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Sender.Callback Write callback.

Method Summary

Modifier and Type	Method and Description
void	close() Close the sender.
Sender	write(byte[] data, Sender.Callback callback) Write a bytes chunk.
default Sender	write(String data, Charset charset, Sender.Callback callback) Write a string chunk.
default Sender	write(String data, Sender.Callback callback) Write a string chunk.

Method Detail

write

@Nonnull
default Sender write(@Nonnull
                              String data,
                              @Nonnull
                              Sender.Callback callback)

Write a string chunk. Chunk is flushed immediately.

Parameters:

data - String chunk.

callback - Callback.

Returns:

This sender.

write

@Nonnull
default Sender write(@Nonnull
                              String data,
                              @Nonnull
                              Charset charset,
                              @Nonnull
                              Sender.Callback callback)

Write a string chunk. Chunk is flushed immediately.

Parameters:

data - String chunk.

charset - Charset.

callback - Callback.

Returns:

This sender.

write

@Nonnull
Sender write(@Nonnull
                      byte[] data,
                      @Nonnull
                      Sender.Callback callback)

Write a bytes chunk. Chunk is flushed immediately.

Parameters:

data - Bytes chunk.

callback - Callback.

Returns:

This sender.

close

void close()

Close the sender.