mcs/class/Novell.Directory.Ldap/Novell.Directory.Ldap/LdapSearchQueue.cs

   1 /******************************************************************************
   2 * The MIT License
   3 * Copyright (c) 2003 Novell Inc.  www.novell.com
   4 *
   5 * Permission is hereby granted, free of charge, to any person obtaining  a copy
   6 * of this software and associated documentation files (the Software), to deal
   7 * in the Software without restriction, including  without limitation the rights
   8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 * copies of the Software, and to  permit persons to whom the Software is
  10 * furnished to do so, subject to the following conditions:
  11 *
  12 * The above copyright notice and this permission notice shall be included in
  13 * all copies or substantial portions of the Software.
  14 *
  15 * THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21 * SOFTWARE.
  22 *******************************************************************************/
  23 //
  24 // Novell.Directory.Ldap.LdapSearchQueue.cs
  25 //
  26 // Author:
  27 //   Sunil Kumar (Sunilk@novell.com)
  28 //
  29 // (C) 2003 Novell, Inc (http://www.novell.com)
  30 //
  31
  32 using System;
  33
  34 namespace Novell.Directory.Ldap
  35 {
  36
  37         /// <summary>  A mechanism for queuing asynchronous search results
  38         /// received from a server.
  39         ///
  40         /// </summary>
  41         /// <seealso cref="LdapConnection.Search">
  42         /// </seealso>
  43         /// <seealso cref="LdapResponseQueue">
  44         /// </seealso>
  45         public class LdapSearchQueue:LdapMessageQueue
  46         {
  47                 /// <summary> Constructs a response queue using a specific client queue
  48                 ///
  49                 /// </summary>
  50                 /// <param name="agent">The message agent to associate with this queue
  51                 /// </param>
  52                 /* package */
  53                 internal LdapSearchQueue(MessageAgent agent):base("LdapSearchQueue", agent)
  54                 {
  55                         return ;
  56                 }
  57                 /// <summary> Merges two message queues.  It appends the current and
  58                 /// future contents from another queue to this one.
  59                 ///
  60                 /// After the operation, queue2.getMessageIDs()
  61                 /// returns an empty array, and its outstanding responses
  62                 /// have been removed and appended to this queue.
  63                 ///
  64                 /// </summary>
  65                 /// <param name="queue2">   The queue that is merged from.  Following
  66                 /// the merge, this queue object will no
  67                 /// longer receive any data, and calls made
  68                 /// to its methods will fail with a RuntimeException.
  69                 /// The queue can be reactivated by using it in an
  70                 /// Ldap request, after which it will receive responses
  71                 /// for that request..
  72                 /// </param>
  73                 public virtual void  merge(LdapMessageQueue queue2)
  74                 {
  75
  76                         LdapSearchQueue q = (LdapSearchQueue) queue2;
  77                         agent.merge(q.MessageAgent);
  78
  79                         return ;
  80                 }
  81         }
  82 }