io.reactiverse.rxjava.pgclient.pubsub

Class PgChannel

java.lang.Object

io.reactiverse.rxjava.pgclient.pubsub.PgChannel

All Implemented Interfaces:

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

public class PgChannel
extends Object
implements io.vertx.rxjava.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.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.rx.TypeArg<PgChannel>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
PgChannel(PgChannel delegate)

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.
boolean	equals(Object o)
PgChannel	exceptionHandler(io.vertx.core.Handler<Throwable> handler)
io.vertx.rxjava.core.streams.ReadStream<String>	fetch(long arg0)
PgChannel	getDelegate()
PgChannel	handler(io.vertx.core.Handler<String> handler) Set or unset an handler to be called when a the channel is notified by Postgres.
int	hashCode()
static PgChannel	newInstance(PgChannel arg)
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.
Observable<String>	toObservable()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

newInstance, newInstance

Methods inherited from interface io.vertx.rxjava.core.streams.StreamBase

newInstance

Field Detail

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<PgChannel> __TYPE_ARG

Constructor Detail

PgChannel

public PgChannel(PgChannel delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public PgChannel getDelegate()

Specified by:

getDelegate in interface io.vertx.rxjava.core.streams.ReadStream<String>

Specified by:

getDelegate in interface io.vertx.rxjava.core.streams.StreamBase

toObservable

public Observable<String> toObservable()

Specified by:

toObservable in interface io.vertx.rxjava.core.streams.ReadStream<String>

fetch

public io.vertx.rxjava.core.streams.ReadStream<String> fetch(long arg0)

Specified by:

fetch in interface io.vertx.rxjava.core.streams.ReadStream<String>

subscribeHandler

public 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

public 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.rxjava.core.streams.ReadStream<String>

Parameters:

handler - the handler

Returns:

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

pause

public PgChannel pause()

Pause the channel, all notifications are discarded.

Specified by:

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

Returns:

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

resume

public PgChannel resume()

Resume the channel.

Specified by:

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

Returns:

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

endHandler

public 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.rxjava.core.streams.ReadStream<String>

Parameters:

endHandler - the handler

Returns:

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

exceptionHandler

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

Specified by:

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

Specified by:

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

newInstance

public static PgChannel newInstance(PgChannel arg)