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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XRemoteContentProviderConnectionControl.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ucb_XRemoteContentProviderConnectionControl_idl__
  32 #define __com_sun_star_ucb_XRemoteContentProviderConnectionControl_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 module com { module sun { module star { module ucb {
  39      published interface XRemoteContentProviderAcceptor;
  40 }; }; }; };
  41
  42 module com { module sun { module star { module ucb {
  43
  44 //============================================================================
  45 /** A simple mechanism to find out if the connection between a remote content
  46     provider distributor and acceptor gets lost.
  47
  48     <p>This interface should be supported by the <var>DoneListener</var>
  49     parameter of
  50     <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>.
  51
  52     @version 1.0
  53     @author Stephan Bergmann
  54  */
  55 published interface XRemoteContentProviderConnectionControl:
  56     com::sun::star::uno::XInterface
  57 {
  58     //------------------------------------------------------------------------
  59     /** Enable connection control, using as a token some object implemented on
  60         the remote content provider acceptor's side.
  61
  62         <p>The implementation of this interface must hold a reference to the
  63         supplied token.  If the connection gets lost, the reference count of
  64         the token will drop, which the remote content provider acceptor can
  65         observe.
  66
  67         @param Acceptor
  68         The remote content provider acceptor on the other side of the
  69         connection.
  70
  71         @param Token
  72         Some object implemented on the remote content provider acceptor's side
  73         of the connection.
  74      */
  75     void
  76     enableConnectionControl([in] XRemoteContentProviderAcceptor Acceptor,
  77                             [in] com::sun::star::uno::XInterface Token);
  78 };
  79
  80 }; }; }; };
  81
  82 #endif