com.netflix.eureka2.transport.MessageConnection 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
/*
 * Copyright 2014 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 com.netflix.eureka2.transport;

import io.reactivex.netty.channel.ObservableConnection;
import rx.Observable;

import java.util.concurrent.TimeoutException;

/**
 * FIXME Lifecycle concept exists at multiple levels. Can we abstract it away and share the implementation?
 * 
FIXME What to do with unrecognized messages - dead letter mailbox?
 * 

 * Bidirectional communication channel between Eureka client and server. Equivalent to {@link ObservableConnection}
 * in RxNetty, with higher level message passing semantics.
 *
 * Messages can be send with and without acknowledgement. If acknowledgment is not received within
 * defined timeout period, the corresponding observable is completed with a {@link TimeoutException} error.
 *
 * @author Tomasz Bak
 */
public interface MessageConnection {

    /**
     * Connection readable name, which should include enough information to identify
     * the other side.
     */
    String name();

    /**
     * Submit a message one-way.
     *
     * @return observable completing normally if acknowledgement was received, or with
     *         exception if message could not be delivered
     */
    Observable submit(Object message);

    /**
     * Submit a message and expect acknowledgement in return. Acknowledgements do not
     * provide any insight into processing status on the other side (success or failure).
     *
     * @return observable completing normally if acknowledgement was received, or with
     *         exception if message could not be delivered or acknowledgement timeout happened
     */
    Observable submitWithAck(Object message);

    /**
     * Submit a message with a user content and expect acknowledgement in return. Acknowledgement does not
     * provide any insight into processing status on the other side (success or failure). If the
     * acknowledgement is not received in the specified amount of time, the return observable returns an error.
     *
     * @param  timeout maximum waiting time for acknowledgement
     *
     * @return observable that returns exactly one {@link Acknowledgement} object or {@link TimeoutException}
     *         if no acknowledgment received on time
     */
    Observable submitWithAck(Object message, long timeout);

    /**
     * Send back an acknowledgement. Acknowledgement request is ignored if a timeout expired.
     *
     * @return observable completing normally if acknowledgement was successfully submitted,
     *         or with exception if message could not be delivered
     */
    Observable acknowledge();

    /**
     * @return observable of messages send by the other side of a connection
     */
    Observable