org.fabric3.binding.zeromq.runtime.message.Subscriber Maven / Gradle / Ivy

Go to download
/*
 * Fabric3
 * Copyright (c) 2009-2015 Metaform Systems
 *
 * 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.
 * Portions originally based on Apache Tuscany 2007
 * licensed under the Apache 2.0 license.
 */
package org.fabric3.binding.zeromq.runtime.message;

import java.util.function.BiConsumer;

import org.fabric3.spi.discovery.ChannelEntry;
import org.fabric3.spi.discovery.EntryChange;

/**
 * Implementations receive messages on a ZeroMQ SUB socket. Qualities of service such as reliability may be provided by an implementation.
 */
public interface Subscriber extends BiConsumer {

    /**
     * Initializes the server and its underlying socket.
     */
    void start();

    /**
     * Disposes the server and any open resources.
     */
    void stop();

    /**
     * Increments the connection count.
     */
    void incrementConnectionCount();

    /**
     * Decrements the connection count.
     */
    void decrementConnectionCount();

    /**
     * True if this subscriber has active consumer connections.
     *
     * @return true if this subscriber has active consumer connections
     */
    boolean hasConnections();

}