Class PgChannel
- java.lang.Object
- 
- io.vertx.mutiny.pgclient.pubsub.PgChannel
 
- 
- All Implemented Interfaces:
- ReadStream<String>,- StreamBase
 
 public class PgChannel extends Object implements ReadStream<String> A channel to Postgres that tracks the subscription to a given Postgres channel using theLISTEN/UNLISTENcommands. When paused the channel discards the messages. NOTE: This class has been automatically generated from theoriginalnon Mutiny-ified interface using Vert.x codegen.
- 
- 
Field SummaryFields Modifier and Type Field Description static TypeArg<PgChannel>__TYPE_ARG
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PgChannelendHandler(Runnable endHandler)booleanequals(Object o)PgChannelexceptionHandler(Consumer<Throwable> handler)ReadStream<String>fetch(long arg0)io.vertx.pgclient.pubsub.PgChannelgetDelegate()PgChannelhandler(Consumer<String> handler)inthashCode()static PgChannelnewInstance(io.vertx.pgclient.pubsub.PgChannel arg)PgChannelpause()Pipe<String>pipe()io.smallrye.mutiny.Uni<Void>pipeTo(WriteStream<String> dst)Pipe thisReadStreamto theWriteStream.VoidpipeToAndAwait(WriteStream<String> dst)Blocking variant ofio.vertx.mutiny.core.streams.ReadStream#pipeTo(io.vertx.mutiny.core.streams.WriteStream.) voidpipeToAndForget(WriteStream<String> dst)Variant ofio.vertx.mutiny.core.streams.ReadStream#pipeTo(io.vertx.mutiny.core.streams.WriteStreamthat ignores the result of the operation.) PgChannelresume()PgChannelsubscribeHandler(Runnable handler)Iterable<String>toBlockingIterable()Stream<String>toBlockingStream()io.smallrye.mutiny.Multi<String>toMulti()StringtoString()
 
- 
- 
- 
Constructor Detail- 
PgChannelpublic PgChannel(io.vertx.pgclient.pubsub.PgChannel delegate) 
 - 
PgChannelpublic PgChannel(Object delegate) 
 
- 
 - 
Method Detail- 
getDelegatepublic io.vertx.pgclient.pubsub.PgChannel getDelegate() - Specified by:
- getDelegatein interface- ReadStream<String>
- Specified by:
- getDelegatein interface- StreamBase
 
 - 
fetchpublic ReadStream<String> fetch(long arg0) - Specified by:
- fetchin interface- ReadStream<String>
- Returns:
- a reference to this, so the API can be used fluently
 
 - 
pipepublic Pipe<String> pipe() - Specified by:
- pipein interface- ReadStream<String>
- Returns:
- a pipe
 
 - 
pipeTopublic io.smallrye.mutiny.Uni<Void> pipeTo(WriteStream<String> dst) Description copied from interface:ReadStreamPipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails. Once this stream has ended or failed, the write stream will be ended and the handlerwill be called with the result.Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.- Specified by:
- pipeToin interface- ReadStream<String>
- Parameters:
- dst- the destination write stream
- Returns:
- the unifiring the result of the operation when completed, or a failure if the operation failed.
 
 - 
pipeToAndAwaitpublic Void pipeToAndAwait(WriteStream<String> dst) Description copied from interface:ReadStreamBlocking variant ofio.vertx.mutiny.core.streams.ReadStream#pipeTo(io.vertx.mutiny.core.streams.WriteStream.) This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException). - Specified by:
- pipeToAndAwaitin interface- ReadStream<String>
- Parameters:
- dst- the destination write stream
- Returns:
- the Void instance produced by the operation.
 
 - 
pipeToAndForgetpublic void pipeToAndForget(WriteStream<String> dst) Description copied from interface:ReadStreamVariant ofio.vertx.mutiny.core.streams.ReadStream#pipeTo(io.vertx.mutiny.core.streams.WriteStreamthat ignores the result of the operation.) This method subscribes on the result of io.vertx.mutiny.core.streams.ReadStream#pipeTo(io.vertx.mutiny.core.streams.WriteStream, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from) io.vertx.mutiny.core.streams.ReadStream#pipeTo(io.vertx.mutiny.core.streams.WriteStreambut you don't need to compose it with other operations.) - Specified by:
- pipeToAndForgetin interface- ReadStream<String>
- Parameters:
- dst- the destination write stream
 
 - 
subscribeHandlerpublic PgChannel subscribeHandler(Runnable handler) - Parameters:
- handler- the handler
- Returns:
 
 - 
handlerpublic PgChannel handler(Consumer<String> handler) - Specified by:
- handlerin interface- ReadStream<String>
- Parameters:
- handler- the handler
- Returns:
 
 - 
pausepublic PgChannel pause() - Specified by:
- pausein interface- ReadStream<String>
- Returns:
- a reference to this, so the API can be used fluently
 
 - 
resumepublic PgChannel resume() - Specified by:
- resumein interface- ReadStream<String>
- Returns:
- a reference to this, so the API can be used fluently
 
 - 
endHandlerpublic PgChannel endHandler(Runnable endHandler) - Specified by:
- endHandlerin interface- ReadStream<String>
- Parameters:
- endHandler- the handler
- Returns:
 
 - 
exceptionHandlerpublic PgChannel exceptionHandler(Consumer<Throwable> handler) - Specified by:
- exceptionHandlerin interface- ReadStream<String>
- Specified by:
- exceptionHandlerin interface- StreamBase
- Parameters:
- handler- the exception handler
- Returns:
 
 - 
toMultipublic io.smallrye.mutiny.Multi<String> toMulti() - Specified by:
- toMultiin interface- ReadStream<String>
 
 - 
newInstancepublic static PgChannel newInstance(io.vertx.pgclient.pubsub.PgChannel arg) 
 
- 
 
-