io.objectbox.reactive.DataSubscription Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of objectbox-java Show documentation

ObjectBox is a fast NoSQL database for Objects

The newest version!

/*
 * Copyright 2017 ObjectBox Ltd. All rights reserved.
 *
 * 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.objectbox.reactive;

/**
 * The result of subscribing an @{@link DataObserver} using @{@link SubscriptionBuilder#observer(DataObserver)}.
 * Used to cancel the subscription (unsubscribe).
 */
public interface DataSubscription {
    /** The Observer shall not receive anymore updates. */
    void cancel();

    /** Current cancellation state of the subscription. */
    boolean isCanceled();
}