1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
/*
* 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.
*
* <p>A class implementing a given protocol <var>prot</var> must be named
* <code>com.sun.star.lib.uno.protocols.<var>prot</var>.<var>prot</var></code>
* and must have a public constructor that takes four arguments: The first
* argument of type <code>com.sun.star.uno.IBridge</code> must not be null. The
* second argument of type <code>String</code> represents any attributes; it may
* be null if there are no attributes. The third argument of type
* <code>java.io.InputStream</code> must not be null. The fourth argument of
* type <code>java.io.OutputStream</code> must not be null.</p>
*/
public interface IProtocol {
/**
* Initializes the connection.
*
* <p>This method must be called exactly once, after the
* <code>readMessage</code> loop has already been established.</p>
*/
void init() throws IOException;
void terminate();
/**
* Reads a request or reply message.
*
* <p>Access to this method from multiple threads must be properly
* synchronized.</p>
*
* @return a non-null message; if the input stream is exhausted, a
* <code>java.io.IOException</code> 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 <code>type</code>, or either
* <code>"queryInterface"</code> or <code>"release"</code>).
* @param tid a non-null TID.
* @param arguments a list of UNO arguments compatible with the given
* <code>type</code> and <code>function</code>; may be null to represent
* an empty list.
* @return <code>true</code> 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 <code>true</code> if the reply corresponds to a raised
* exception.
* @param tid a non-null TID.
* @param result if <code>exception</code> is <code>true</code>, a non-null
* UNO exception; otherwise, a UNO return value, which may be null to
* represent a <code>VOID</code> return value.
*/
void writeReply(boolean exception, ThreadId tid, Object result)
throws IOException;
}
|
