com.netflix.eureka2.service.ServiceChannel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eureka-core Show documentation

eureka-core developed by Netflix

There is a newer version: 2.0.0-DP4

package com.netflix.eureka2.service;

import com.netflix.eureka2.registry.EurekaRegistry;
import rx.Observable;

/**
 * A {@link ServiceChannel} is a medium to define eureka protocols for modification to the {@link EurekaRegistry}.
 *
 * As is the case with a typical channel, there are two ends to a channel, viz.
 *
 * Sender
 * A party that writes to this channel.
 *
 * Receiver
 * A party that reads from this channel.
 *
 * @author Nitesh Kant
 */
public interface ServiceChannel {

    /**
     * Closes this channel.
     */
    void close();

    /**
     * Returns an {@link Observable} for the lifecycle of this channel.
     *
     * @return An {@link Observable} for the lifecycle of this channel which completes when the channel closes.
     */
    Observable asLifecycleObservable();
}