com.sun.star.lib.uno.protocols.urp

Class urp

java.lang.Object

com.sun.star.lib.uno.protocols.urp.urp

All Implemented Interfaces:

IProtocol

public final class urp
extends Object
implements IProtocol

This class internally relies on the availability of Java UNO type information for the interface type com.sun.star.bridge.XProtocolProperties, even though URP itself does not rely on that type.

Constructor Summary

Constructors

Constructor and Description
urp(com.sun.star.uno.IBridge bridge, String attributes, InputStream input, OutputStream output)

Method Summary

Modifier and Type	Method and Description
void	init() Initializes the connection.
Message	readMessage() Reads a request or reply message.
void	terminate()
void	writeReply(boolean exception, ThreadId tid, Object result) Writes a reply message.
boolean	writeRequest(String oid, com.sun.star.lib.uno.typedesc.TypeDescription type, String function, ThreadId tid, Object[] arguments) Writes a request message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

urp

public urp(com.sun.star.uno.IBridge bridge,
           String attributes,
           InputStream input,
           OutputStream output)

Method Detail

init

public void init()
          throws IOException

Description copied from interface: IProtocol

Initializes the connection.

This method must be called exactly once, after the readMessage loop has already been established.

Specified by:

init in interface IProtocol

Throws:

IOException

See Also:

IProtocol.init()

terminate

public void terminate()

Specified by:

terminate in interface IProtocol

See Also:

IProtocol.terminate()

readMessage

public Message readMessage()
                    throws IOException

Description copied from interface: IProtocol

Reads a request or reply message.

Access to this method from multiple threads must be properly synchronized.

Specified by:

readMessage in interface IProtocol

Returns:

a non-null message; if the input stream is exhausted, a java.io.IOException is thrown instead.

Throws:

IOException

See Also:

IProtocol.readMessage()

writeRequest

public boolean writeRequest(String oid,
                            com.sun.star.lib.uno.typedesc.TypeDescription type,
                            String function,
                            ThreadId tid,
                            Object[] arguments)
                     throws IOException

Description copied from interface: IProtocol

Writes a request message.

Specified by:

writeRequest in interface IProtocol

Parameters:

oid - a non-null OID.

type - a non-null UNO type.

function - a non-null function (the name of a UNO interface method or attribute compatible with the given type, or either "queryInterface" or "release").

tid - a non-null TID.

arguments - a list of UNO arguments compatible with the given type and function; may be null to represent an empty list.

Returns:

true if the request message is sent as a synchronous request.

Throws:

IOException

See Also:

IProtocol.writeRequest(java.lang.String, com.sun.star.lib.uno.typedesc.TypeDescription, java.lang.String, com.sun.star.lib.uno.environments.remote.ThreadId, java.lang.Object[])

writeReply

public void writeReply(boolean exception,
                       ThreadId tid,
                       Object result)
                throws IOException

Description copied from interface: IProtocol

Writes a reply message.

Specified by:

writeReply in interface IProtocol

Parameters:

exception - true if the reply corresponds to a raised exception.

tid - a non-null TID.

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.

Throws:

IOException

See Also:

IProtocol.writeReply(boolean, com.sun.star.lib.uno.environments.remote.ThreadId, java.lang.Object)