io.vertx.pgclient.impl.pubsub

Class PgSubscriberImpl

java.lang.Object

io.vertx.pgclient.impl.pubsub.PgSubscriberImpl

All Implemented Interfaces:

PgSubscriber

public class PgSubscriberImpl
extends Object
implements PgSubscriber

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CHANNEL_NAME_LENGTH
static int	NAMEDATALEN

Constructor Summary

Constructors

Constructor and Description
PgSubscriberImpl(Vertx vertx, PgConnectOptions options)

Method Summary

Modifier and Type	Method and Description
PgConnection	actualConnection()
static String	applyIdLengthLimit(String channelName)
PgChannel	channel(String name) Return a channel for the given name.
Future<Void>	close() Like PgSubscriber.close(Handler) but with a future of the result
void	close(Handler<AsyncResult<Void>> handler) Close the subscriber, the retry policy will not be invoked.
boolean	closed()
PgSubscriber	closeHandler(Handler<Void> handler) Set an handler called when the subscriber is closed.
Future<Void>	connect() Like PgSubscriber.connect(Handler) but with a future of the result
PgSubscriber	connect(Handler<AsyncResult<Void>> handler) Connect the subscriber to Postgres.
PgSubscriber	reconnectPolicy(Function<Integer,Long> policy) Set the reconnect policy that is executed when the subscriber is disconnected.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.pgclient.pubsub.PgSubscriber

subscriber

Field Detail

NAMEDATALEN

public static final int NAMEDATALEN

See Also:

Constant Field Values

MAX_CHANNEL_NAME_LENGTH

public static final int MAX_CHANNEL_NAME_LENGTH

See Also:

Constant Field Values

Constructor Detail

PgSubscriberImpl

public PgSubscriberImpl(Vertx vertx,
                        PgConnectOptions options)

Method Detail

applyIdLengthLimit

public static String applyIdLengthLimit(String channelName)

closeHandler

public PgSubscriber closeHandler(Handler<Void> handler)

Description copied from interface: PgSubscriber

Set an handler called when the subscriber is closed.

Specified by:

closeHandler in interface PgSubscriber

Parameters:

handler - the handler

Returns:

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

reconnectPolicy

public PgSubscriber reconnectPolicy(Function<Integer,Long> policy)

Description copied from interface: PgSubscriber

Set the reconnect policy that is executed when the subscriber is disconnected.

When the subscriber is disconnected, the policy function is called with the actual number of retries and returns an amountOfTime value:

• when amountOfTime < 0: the subscriber is closed and there is no retry
• when amountOfTime == 0: the subscriber retries to connect immediately
• when amountOfTime > 0: the subscriber retries after amountOfTime milliseconds

The default policy does not perform any retries.

Specified by:

reconnectPolicy in interface PgSubscriber

Parameters:

policy - the policy to set

Returns:

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

closed

public boolean closed()

Specified by:

closed in interface PgSubscriber

Returns:

whether the subscriber is closed

actualConnection

public PgConnection actualConnection()

Specified by:

actualConnection in interface PgSubscriber

Returns:

the actual connection to Postgres, it might be null

connect

public PgSubscriber connect(Handler<AsyncResult<Void>> handler)

Description copied from interface: PgSubscriber

Connect the subscriber to Postgres.

Specified by:

connect in interface PgSubscriber

Parameters:

handler - the handler notified of the connection success or failure

Returns:

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

connect

public Future<Void> connect()

Description copied from interface: PgSubscriber

Like PgSubscriber.connect(Handler) but with a future of the result

Specified by:

connect in interface PgSubscriber

close

public Future<Void> close()

Description copied from interface: PgSubscriber

Like PgSubscriber.close(Handler) but with a future of the result

Specified by:

close in interface PgSubscriber

close

public void close(Handler<AsyncResult<Void>> handler)

Description copied from interface: PgSubscriber

Close the subscriber, the retry policy will not be invoked.

Specified by:

close in interface PgSubscriber

channel

public PgChannel channel(String name)

Description copied from interface: PgSubscriber

Return a channel for the given name.

Specified by:

channel in interface PgSubscriber

Parameters:

name - the channel name

This will be the name of the channel exactly as held by Postgres for sending notifications. Internally this name will be truncated to the Postgres identifier maxiumum length of (NAMEDATALEN = 64) - 1 == 63 characters, and prepared as a quoted identifier without unicode escape sequence support for use in LISTEN/UNLISTEN commands. Examples of channel names and corresponding NOTIFY commands:

• when name == "the_channel": NOTIFY the_channel, 'msg', NOTIFY The_Channel, 'msg', or NOTIFY "the_channel", 'msg' succeed in delivering a message to the created channel
• when name == "The_Channel": NOTIFY "The_Channel", 'msg', succeeds in delivering a message to the created channel

Returns:

the channel