com.sun.star.lib.uno.environments.remote.IProtocol Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libreoffice Show documentation
Public UNO Java Classes (formerly jurt,juh,ridl,unoil)
The newest version!
/* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you 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 .
 */

package com.sun.star.lib.uno.environments.remote;

import com.sun.star.lib.uno.typedesc.TypeDescription;
import java.io.IOException;

/**
 * An abstraction of remote bridge protocols.
 *
 * A class implementing a given protocol prot must be named
 * com.sun.star.lib.uno.protocols.prot.prot
 * and must have a public constructor that takes four arguments:  The first
 * argument of type com.sun.star.uno.IBridge must not be null.  The
 * second argument of type String represents any attributes; it may
 * be null if there are no attributes.  The third argument of type
 * java.io.InputStream must not be null.  The fourth argument of
 * type java.io.OutputStream must not be null.
 */
public interface IProtocol {
    /**
     * Initializes the connection.
     *
     * This method must be called exactly once, after the
     * readMessage loop has already been established.
     */
    void init() throws IOException;

    void terminate();

    /**
     * Reads a request or reply message.
     *
     * Access to this method from multiple threads must be properly
     * synchronized.
     *
     * @return a non-null message; if the input stream is exhausted, a
     *     java.io.IOException is thrown instead.
     */
    Message readMessage() throws IOException;

    /**
     * Writes a request message.
     *
     * @param oid a non-null OID.
     * @param type a non-null UNO type.
     * @param function a non-null function (the name of a UNO interface method
     *     or attribute compatible with the given type, or either
     *     "queryInterface" or "release").
     * @param tid a non-null TID.
     * @param arguments a list of UNO arguments compatible with the given
     *     type and function; may be null to represent
     *     an empty list.
     * @return true if the request message is sent as a synchronous
     *     request.
     */
    boolean writeRequest(
        String oid, TypeDescription type, String function, ThreadId tid,
        Object[] arguments)
        throws IOException;

    /**
     * Writes a reply message.
     *
     * @param exception true if the reply corresponds to a raised
     *     exception.
     * @param tid a non-null TID.
     * @param result if exception is true, a non-null
     *     UNO exception; otherwise, a UNO return value, which may be null to
     *     represent a VOID return value.
     */
    void writeReply(boolean exception, ThreadId tid, Object result)
        throws IOException;
}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */