io.reactiverse.pgclient.pubsub

Interface PgChannel

All Superinterfaces:

io.vertx.core.streams.ReadStream<String>, io.vertx.core.streams.StreamBase

public interface PgChannel
extends io.vertx.core.streams.ReadStream<String>

A channel to Postgres that tracks the subscription to a given Postgres channel using the LISTEN/UNLISTEN commands.

When paused the channel discards the messages.

Method Summary

Modifier and Type	Method and Description
PgChannel	endHandler(io.vertx.core.Handler<Void> endHandler) Set an handler to be called when no more notifications will be received.
PgChannel	exceptionHandler(io.vertx.core.Handler<Throwable> handler)
PgChannel	handler(io.vertx.core.Handler<String> handler) Set or unset an handler to be called when a the channel is notified by Postgres.
PgChannel	pause() Pause the channel, all notifications are discarded.
PgChannel	resume() Resume the channel.
PgChannel	subscribeHandler(io.vertx.core.Handler<Void> handler) Set an handler called when the the channel get subscribed.

Methods inherited from interface io.vertx.core.streams.ReadStream

fetch

Method Detail

subscribeHandler

PgChannel subscribeHandler(io.vertx.core.Handler<Void> handler)

Set an handler called when the the channel get subscribed.

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

handler

PgChannel handler(io.vertx.core.Handler<String> handler)

Set or unset an handler to be called when a the channel is notified by Postgres.

• when the handler is set, the subscriber sends a LISTEN command if needed
• when the handler is unset, the subscriber sends a UNLISTEN command if needed

Specified by:

handler in interface io.vertx.core.streams.ReadStream<String>

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

pause

PgChannel pause()

Pause the channel, all notifications are discarded.

Specified by:

pause in interface io.vertx.core.streams.ReadStream<String>

Returns:

a reference to this, so the API can be used fluently

resume

PgChannel resume()

Resume the channel.

Specified by:

resume in interface io.vertx.core.streams.ReadStream<String>

Returns:

a reference to this, so the API can be used fluently

endHandler

PgChannel endHandler(io.vertx.core.Handler<Void> endHandler)

Set an handler to be called when no more notifications will be received.

Specified by:

endHandler in interface io.vertx.core.streams.ReadStream<String>

Parameters:

endHandler - the handler

Returns:

a reference to this, so the API can be used fluently

exceptionHandler

PgChannel exceptionHandler(io.vertx.core.Handler<Throwable> handler)

Specified by:

exceptionHandler in interface io.vertx.core.streams.ReadStream<String>

Specified by:

exceptionHandler in interface io.vertx.core.streams.StreamBase