beagled/IIndexer.cs

   1 //
   2 // IIndexer.cs
   3 //
   4 // Copyright (C) 2005 Novell, Inc.
   5 //
   6
   7 //
   8 // Permission is hereby granted, free of charge, to any person obtaining a
   9 // copy of this software and associated documentation files (the "Software"),
  10 // to deal in the Software without restriction, including without limitation
  11 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12 // and/or sell copies of the Software, and to permit persons to whom the
  13 // Software is furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in
  16 // all copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24 // DEALINGS IN THE SOFTWARE.
  25 //
  26
  27 using System;
  28 using System.Collections;
  29
  30 namespace Beagle.Daemon {
  31
  32
  33         public delegate void IIndexerFlushHandler (IIndexer source, IndexerReceipt [] receipts);
  34
  35         public interface IIndexer {
  36
  37                 int GetItemCount ();
  38
  39                 void Add (Indexable indexable);
  40
  41                 void Remove (Uri uri);
  42
  43                 // The optimization will happen after the next flush.
  44                 void Optimize ();
  45
  46                 IndexerReceipt [] FlushAndBlock ();
  47
  48                 // In general, we don't guarantee that Flush will not block.
  49                 // FlushEvent might be fired before Flush returns.
  50                 // Also, FlushEvent might fire multiple times.  We signal
  51                 // that the flush is finished by firing FlushEvent with
  52                 // receipts == null.
  53                 void Flush ();
  54
  55                 event IIndexerFlushHandler FlushEvent;
  56
  57
  58
  59
  60         }
  61 }