io.reactiverse.pgclient.pubsub.PgChannel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of reactive-pg-client Show documentation
Show all versions of reactive-pg-client Show documentation
The reactive Postgres client
/*
* Copyright (C) 2017 Julien Viet
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package io.reactiverse.pgclient.pubsub;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Handler;
import io.vertx.core.streams.ReadStream;
/**
* A channel to Postgres that tracks the subscription to a given Postgres channel using the {@code LISTEN/UNLISTEN} commands.
*
* When paused the channel discards the messages.
*/
@VertxGen
public interface PgChannel extends ReadStream {
/**
* Set an handler called when the the channel get subscribed.
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
PgChannel subscribeHandler(Handler 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 {@code LISTEN} command if needed
* - when the handler is unset, the subscriber sends a {@code UNLISTEN} command if needed
*
*
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
@Override
PgChannel handler(Handler handler);
/**
* Pause the channel, all notifications are discarded.
*
* @return a reference to this, so the API can be used fluently
*/
@Override
PgChannel pause();
/**
* Resume the channel.
*
* @return a reference to this, so the API can be used fluently
*/
@Override
PgChannel resume();
/**
* Set an handler to be called when no more notifications will be received.
*
* @param endHandler the handler
* @return a reference to this, so the API can be used fluently
*/
@Override
PgChannel endHandler(Handler endHandler);
@Override
PgChannel exceptionHandler(Handler handler);
}