offapi/com/sun/star/ucb/XRemoteContentProviderConnectionControl.idl

   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
  20 module com { module sun { module star { module ucb {
  21      published interface XRemoteContentProviderAcceptor;
  22 }; }; }; };
  23
  24 module com { module sun { module star { module ucb {
  25
  26 /** A simple mechanism to find out if the connection between a remote content
  27     provider distributor and acceptor gets lost.
  28
  29     <p>This interface should be supported by the <var>DoneListener</var>
  30     parameter of
  31     XRemoteContentProviderAcceptor::addRemoteContentProvider().
  32
  33     @version 1.0
  34  */
  35 published interface XRemoteContentProviderConnectionControl:
  36     com::sun::star::uno::XInterface
  37 {
  38     /** Enable connection control, using as a token some object implemented on
  39         the remote content provider acceptor's side.
  40
  41         <p>The implementation of this interface must hold a reference to the
  42         supplied token.  If the connection gets lost, the reference count of
  43         the token will drop, which the remote content provider acceptor can
  44         observe.
  45
  46         @param Acceptor
  47         The remote content provider acceptor on the other side of the
  48         connection.
  49
  50         @param Token
  51         Some object implemented on the remote content provider acceptor's side
  52         of the connection.
  53      */
  54     void
  55     enableConnectionControl([in] XRemoteContentProviderAcceptor Acceptor,
  56                             [in] com::sun::star::uno::XInterface Token);
  57 };
  58
  59 }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */