office-gobmx/udkapi/com/sun/star/connection/XAcceptor.idl
Tor Lillqvist d1449a9b99 Bin pointless "DocMerge" comment lines
Change-Id: I8eb2116b39929770f00e30d5ab9ca2c28c988e35
2013-03-13 10:36:21 +02:00

76 lines
2.8 KiB
Text

/* -*- Mode: C++; 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 .
*/
#ifndef _COM_SUN_STAR_CONNECTION_XACCEPTOR_IDL_
#define _COM_SUN_STAR_CONNECTION_XACCEPTOR_IDL_
#include <com/sun/star/connection/ConnectionSetupException.idl>
#include <com/sun/star/connection/AlreadyAcceptingException.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/connection/XConnection.idl>
module com { module sun { module star { module connection {
/** allows to passively accept connection attempts from other processes.
<p>
This is the counterpart to the XConnector interface.
*/
published interface XAcceptor: com::sun::star::uno::XInterface
{
/** 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.
@param sConnectionDescription
contains the kind of the connection plus a
comma separated list of attributes,
e.g., <em>socket,host=localhost,port=2345</em> for a tcpip connection.
@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, etc.)
@throws com::sun::star::lang::IllegalArgumentException
sConnectionDescription could not be interpreted
*/
XConnection accept( [in] string sConnectionDescription )
raises( AlreadyAcceptingException,
ConnectionSetupException,
com::sun::star::lang::IllegalArgumentException);
/** pushes acceptor out of the accept-call.
*/
void stopAccepting();
};
};};};};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */