rx.CompletableSubscriber Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rxjava Show documentation

rxjava

There is a newer version: 1.3.8

/*
 * Copyright 2016 Netflix, Inc.
 *
 * 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 rx;

import rx.annotations.Experimental;

/**
 * Represents the subscription API callbacks when subscribing to a Completable instance.
 */
@Experimental
public interface CompletableSubscriber {
    /**
     * Called once the deferred computation completes normally.
     */
    void onCompleted();

    /**
     * Called once if the deferred computation 'throws' an exception.
     * @param e the exception, not null.
     */
    void onError(Throwable e);

    /**
     * Called once by the Completable to set a Subscription on this instance which
     * then can be used to cancel the subscription at any time.
     * @param d the Subscription instance to call dispose on for cancellation, not null
     */
    void onSubscribe(Subscription d);
}