Org.Lwes/Listener/IEventSinkRegistrationKey.cs

   1 //
   2 // This file is part of the LWES .NET Binding (LWES.net)
   3 //
   4 // COPYRIGHT© 2009, Phillip Clark (cerebralkungfu[at*g mail[dot*com)
   5 //       original .NET implementation
   6 //
   7 // LWES.net is free software: you can redistribute it and/or modify
   8 // it under the terms of the Lesser GNU General Public License as published by
   9 // the Free Software Foundation, either version 3 of the License, or
  10 // (at your option) any later version.
  11 //
  12 // LWES.net is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // Lesser GNU General Public License for more details.
  16 //
  17 // You should have received a copy of the Lesser GNU General Public License
  18 // along with LWES.net.  If not, see <http://www.gnu.org/licenses/>.
  19 //
  20 namespace Org.Lwes.Listener
  21 {
  22         using System;
  23
  24         /// <summary>
  25         /// Registration key for event sinks.
  26         /// </summary>
  27         public interface IEventSinkRegistrationKey
  28         {
  29                 /// <summary>
  30                 /// An opaque handback object.
  31                 /// </summary>
  32                 Object Handback
  33                 {
  34                         get;
  35                         set;
  36                 }
  37
  38                 /// <summary>
  39                 /// The listener with which the event sink is registered.
  40                 /// </summary>
  41                 IEventListener Listener
  42                 {
  43                         get;
  44                 }
  45
  46                 /// <summary>
  47                 /// The status of the event sink.
  48                 /// </summary>
  49                 EventSinkStatus Status
  50                 {
  51                         get;
  52                 }
  53
  54                 /// <summary>
  55                 /// Activates the event sink.
  56                 /// </summary>
  57                 /// <returns><em>true</em> if the event sink has not already been canceled; otherwise <em>false</em></returns>
  58                 bool Activate();
  59
  60                 /// <summary>
  61                 /// Cancels a registration. An event sink whose registration is canceled will no longer
  62                 /// receive event or garbage notification.
  63                 /// </summary>
  64                 void Cancel();
  65
  66                 /// <summary>
  67                 /// Disables garbage notification for a sink.
  68                 /// </summary>
  69                 void DisableGarbageNotification();
  70
  71                 /// <summary>
  72                 /// Suspends the event sink. An event sink whose registration is suspended will not
  73                 /// receive event or garbage notification until it is re-activated.
  74                 /// </summary>
  75                 /// <returns><em>true</em> if the event sink has not already been canceled; otherwise <em>false</em></returns>
  76                 bool Suspend();
  77         }
  78 }