net.sf.eBus.client.IESubscribeFeed Maven / Gradle / Ivy

Go to download
//
// Copyright 2017, 2018 Charles W. Rapp
//
// 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 net.sf.eBus.client;

/**
 * Provides a common view of single- and multi-key subscription
 * feeds, allowing such feeds to be referenced in a common way.
 *
 * @author Charles W. Rapp
 */

public interface IESubscribeFeed
    extends IEFeed
{
//---------------------------------------------------------------
// Member methods.
//

    /**
     * Puts the feed status callback in place.
     * @param cb the feed status update callback. May be
     * {@code null}.
     */
    void statusCallback(FeedStatusCallback cb);

    /**
     * Puts the notification message callback in place.
     * @param cb pass notification messages back to application
     * via this callback.
     */
    void notifyCallback(NotifyCallback cb);

    /**
     * Activates this notification subscription.
     */
    void subscribe();

    /**
     * De-activates this subscriber feed. Does nothing if this
     * feed if not currently subscribed.
     */
    void unsubscribe();
} // end of interface IESubscribeFeed