1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 *   Licensed to the Apache Software Foundation (ASF) under one or more
12 *   contributor license agreements. See the NOTICE file distributed
13 *   with this work for additional information regarding copyright
14 *   ownership. The ASF licenses this file to you under the Apache
15 *   License, Version 2.0 (the "License"); you may not use this file
16 *   except in compliance with the License. You may obtain a copy of
17 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef _COM_SUN_STAR_CONNECTION_XCONNECTOR_IDL_
20#define _COM_SUN_STAR_CONNECTION_XCONNECTOR_IDL_
21
22#include <com/sun/star/connection/ConnectionSetupException.idl>
23#include <com/sun/star/connection/NoConnectException.idl>
24#include <com/sun/star/lang/IllegalArgumentException.idl>
25#include <com/sun/star/connection/XConnection.idl>
26
27
28module com {  module sun {  module star {  module connection {
29
30/**
31   allows to actively establish an interprocess connection.
32 */
33published interface XConnector: com::sun::star::uno::XInterface
34{
35    /** creates a new connection interprocess connection.
36        <p>
37        Tries to connect to an XAcceptor.  Behavior is unspecified
38        if a call to connect is made when another call to connect either has not
39        yet returned or has returned successfully without raising an exception.
40
41        @param sConnectionDescription
42                contains the kind of the connection plus a
43                comma separated list of attributes,
44               e.g., <em>socket,host=localhost,port=2345</em> for a tcpip connection.
45
46        @throws ConnectionSetupException
47                Problems during setting up the connector
48              on client side, (e.g., Security-reasons, socket already busy .. ),
49                or the string could not be interpreted correctly.
50
51        @throws NoConnectException
52                Couldn't reach a server (e.g. network failure),
53                no server is listening
54     */
55    XConnection connect( [in] string sConnectionDescription )
56        raises( NoConnectException,ConnectionSetupException );
57};
58
59
60};};};};
61
62#endif
63
64/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
65