org.opendaylight.jsonrpc.bus.api.Requester Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bus-api Show documentation

There is a newer version: 1.17.1

/*
 * Copyright (c) 2018 Lumina Networks, Inc. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.jsonrpc.bus.api;

import io.netty.util.concurrent.Future;

/**
 * Requester session type allow to send requests to remote {@link Responder} peer.
 *
 * @author Richard Kosegi
 * @since Mar 4, 2018
 */
public interface Requester extends ClientSession {
    /**
     * Send request to the peer.
     *
     * @param message message to send.
     * @return {@link Future} containing the result of send. The Future blocks until the response is received or
     *         timeout expires, whichever comes first.
     * @throws RecoverableTransportException when underlying transport is not ready
     */
    Future send(String message);
}