diff options
8 files changed, 67 insertions, 37 deletions
diff --git a/udkapi/com/sun/star/connection/Acceptor.idl b/udkapi/com/sun/star/connection/Acceptor.idl index c1d7a9782f1b..d9c372eabff4 100644 --- a/udkapi/com/sun/star/connection/Acceptor.idl +++ b/udkapi/com/sun/star/connection/Acceptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: Acceptor.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:30 $ + * last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,6 +72,11 @@ //============================================================================= /** allows to accept connection attempts from another process. + <p> + Acceptor is a delagating service. You can add further acceptors by giving + them a service name com.sun.star.connection.Acceptor.xxx, where xxx is the + connection type used int the connection string during accept()/connect() call. + */ service Acceptor { diff --git a/udkapi/com/sun/star/connection/AlreadyAcceptingException.idl b/udkapi/com/sun/star/connection/AlreadyAcceptingException.idl index ed3f6788fde2..959bf0fb0744 100644 --- a/udkapi/com/sun/star/connection/AlreadyAcceptingException.idl +++ b/udkapi/com/sun/star/connection/AlreadyAcceptingException.idl @@ -2,9 +2,9 @@ * * $RCSfile: AlreadyAcceptingException.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:44 $ + * last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,7 +64,7 @@ module com { module sun { module star { module connection { -/** @missing +/** Is thrown, when there is another thread already accepting on this instance. */ exception AlreadyAcceptingException: com::sun::star::uno::Exception { diff --git a/udkapi/com/sun/star/connection/ConnectionSetupException.idl b/udkapi/com/sun/star/connection/ConnectionSetupException.idl index ceb37248931c..d9f0bee7553f 100644 --- a/udkapi/com/sun/star/connection/ConnectionSetupException.idl +++ b/udkapi/com/sun/star/connection/ConnectionSetupException.idl @@ -2,9 +2,9 @@ * * $RCSfile: ConnectionSetupException.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:44 $ + * last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,7 +64,7 @@ module com { module sun { module star { module connection { -/** @missing +/** Is e.g. thrown, when it is not possible to accept on a local resource. */ exception ConnectionSetupException: com::sun::star::uno::Exception { diff --git a/udkapi/com/sun/star/connection/Connector.idl b/udkapi/com/sun/star/connection/Connector.idl index 465b9f613038..f0656b4262ed 100644 --- a/udkapi/com/sun/star/connection/Connector.idl +++ b/udkapi/com/sun/star/connection/Connector.idl @@ -2,9 +2,9 @@ * * $RCSfile: Connector.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:28:30 $ + * last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,11 +72,16 @@ //============================================================================= /** allows to establish a connection to another process. + <p> + Connector is a delagating service. You can add further connectors by giving + them a service name com.sun.star.connection.Connector.xxx, where xxx is the + connection type used int the connection string during accept()/connect() call. */ service Connector { /** The main interface of the service. **/ + interface com::sun::star::connection::XConnector; }; diff --git a/udkapi/com/sun/star/connection/NoConnectException.idl b/udkapi/com/sun/star/connection/NoConnectException.idl index 69e12e1cbf8d..e290b43a736a 100644 --- a/udkapi/com/sun/star/connection/NoConnectException.idl +++ b/udkapi/com/sun/star/connection/NoConnectException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NoConnectException.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: mi $ $Date: 2000-12-11 16:09:44 $ + * last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -64,7 +64,7 @@ module com { module sun { module star { module connection { -/** @missing +/** Is thrown in case no one is accepting on the specified resource. */ exception NoConnectException: com::sun::star::uno::Exception { diff --git a/udkapi/com/sun/star/connection/XAcceptor.idl b/udkapi/com/sun/star/connection/XAcceptor.idl index 5cfe50e22f28..81a6c6be856e 100644 --- a/udkapi/com/sun/star/connection/XAcceptor.idl +++ b/udkapi/com/sun/star/connection/XAcceptor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAcceptor.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:34 $ + * last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,25 +69,30 @@ module com { module sun { module star { module connection { -/** @missing +/** allows to passivly accept connection attempts from other processes. + + <p> + This is the counterpart to the XConnector interface. */ interface XAcceptor: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::connection::XAcceptor::accept /** accepts an interprocess connection. Waits until someone connects to the resource. <p> - After a successful return, the method may be called again to accept - further connections, but the parameter string MUST be left unchanged. + After a successful return, the method may be called again to accept + further connections, but the parameter string MUST be left unchanged. + @param sConnectionDescription contains the kind of the connection plus a comma seperated list of attributes. e.g. <em>socket,host=locahost,port=2345</em> for a tcpip connection. - @return empty XConnection-reference, when stopAccepting was called + @return null reference, stopAccepting was called. Otherwise a valid XConnection + reference. @throws AlreadyAcceptingException Only one acceptor-thread per instance allowed. @throws ConnectionSetupException Problems during setting up the acceptor. - (e.g. Security-reasons, socket already busy .. ) + (e.g. Security-reasons, socket already busy, etc. ) @throws com::sun::star::lang::IllegalArgumentException sConnectionDescription could not be interpreted @@ -98,7 +103,6 @@ interface XAcceptor: com::sun::star::uno::XInterface com::sun::star::lang::IllegalArgumentException); - // DocMerge from xml: method com::sun::star::connection::XAcceptor::stopAccepting /** pushes acceptor out of the accept-call. */ void stopAccepting(); diff --git a/udkapi/com/sun/star/connection/XConnection.idl b/udkapi/com/sun/star/connection/XConnection.idl index 511737b52096..450585bfb801 100644 --- a/udkapi/com/sun/star/connection/XConnection.idl +++ b/udkapi/com/sun/star/connection/XConnection.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnection.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:34 $ + * last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,43 +66,57 @@ module com { module sun { module star { module connection { -/** @missing +/** A bidirectional bytestream. + + <p> You should additionally implement XConnection2. + + @see XConnection2 */ interface XConnection: com::sun::star::uno::XInterface { - // DocMerge from xml: method com::sun::star::connection::XConnection::read - /** blocking. + /** reads a requested number of bytes from the connection. + <p> This method is blocking, meaning that it always returns a bytesequence + with the requested number of bytes unless it has reached end of file (which + often means, that close() has been called). + + <p> please see also the readSomeBytes() method of XConnection2. - @incomplete + @return The read number of bytes. The return value and the length of the + returned sequence must be identical. + @param nBytesToRead + The number of bytes to be read from the stream. + + @throws com::sun::star::io::IOException + in case an error occured during reading from the stream. */ long read( [out] sequence < byte > aReadBytes , [in] long nBytesToRead ) raises( com::sun::star::io::IOException ); // DocMerge from xml: method com::sun::star::connection::XConnection::write - /** blocking. + /** writes the given bytesequence to the stream. + <p>The method blocks until the whole sequence is written. - @incomplete + @throws com::sun::star::io::IOException + in case an error occured during writing to the stream. */ void write( [in] sequence < byte > aData ) raises( com::sun::star::io::IOException ); - /** @missing + /** Empties all internal buffers. */ void flush( ) raises( com::sun::star::io::IOException ); - - // DocMerge from xml: method com::sun::star::connection::XConnection::close /** Immeadiatly terminates any ongoing read or write calls. + All subsequent read or write calls() */ void close( ) raises( com::sun::star::io::IOException ); - // DocMerge from xml: method com::sun::star::connection::XConnection::getDescription /** A unique string describing the connection. <p>This string is different from the arguments to <member>XConnection::accept</member> diff --git a/udkapi/com/sun/star/connection/XConnector.idl b/udkapi/com/sun/star/connection/XConnector.idl index 14ab21ca7d3f..61c53121c276 100644 --- a/udkapi/com/sun/star/connection/XConnector.idl +++ b/udkapi/com/sun/star/connection/XConnector.idl @@ -2,9 +2,9 @@ * * $RCSfile: XConnector.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 15:10:34 $ + * last change: $Author: jbu $ $Date: 2001-10-12 16:04:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -69,14 +69,16 @@ module com { module sun { module star { module connection { -// DocMerge: empty anyway +/** + allows to activly establish an interprocess connection. + */ interface XConnector: com::sun::star::uno::XInterface { // DocMerge from xml: method com::sun::star::connection::XConnector::connect /** creates a new connection interprocess connection. <p> - Tries to connect to an <type>XAcceptor</member>. + Tries to connect to an <type>XAcceptor</type>. @param sConnectionDescription contains the kind of the connection plus a comma seperated list of attributes. |