/************************************************************** * * 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 * * 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.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.
This method must be called exactly once, after the
* readMessage
loop has already been established.
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 threadId 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;
}