se.kth.iss.ug2.Transport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of standalone-ugclient Show documentation

A stand-alone Maven UgClient package separated from the UG server.

There is a newer version: 1.0.5

/*
 * MIT License
 *
 * Copyright (c) 2017 Kungliga Tekniska högskolan
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package se.kth.iss.ug2;

/**
 * Transport mechanism abstraction
 */
public interface Transport {
    /**
     * This method sends the rpc request to the server and returns the reply
     * from the server or throws an Ug2Exception.
     *
     * @param request the request to send to server. 
     * @return the reply.
     * @throws Ug2Exception on errors.
     */
    public Ug2Msg rpc(Ug2Msg request) throws Ug2Exception;

    /**
     * @return a display name for the server (URL or such).
     */
    public String server();

    /**
     * Releases all resources bound to the channel instance.
     */
    public void close();
}