ACE/apps/drwho/BS_Client.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file    BS_Client.h
   6  *
   7  *  @author Douglas C. Schmidt
   8  */
   9 //=============================================================================
  10
  11
  12 #ifndef _BS_CLIENT_H
  13 #define _BS_CLIENT_H
  14
  15 #include "Binary_Search.h"
  16
  17 /**
  18  * @class BS_Client
  19  *
  20  * @brief Provides the client's binary search lookup table abstraction.
  21  */
  22 class BS_Client : public Binary_Search
  23 {
  24 public:
  25   // = Initialization.
  26   /// Constructor.
  27   BS_Client ();
  28
  29   /**
  30    * This function is used to merge the <key_name> from server
  31    * <host_name> into the sorted list of userids kept on the client's
  32    * side.  Since we *know* we are going to find the name we use the
  33    * traditional binary search.
  34    */
  35   virtual Protocol_Record *insert (const char *key_name,
  36                                    int max_len = MAXUSERIDNAMELEN);
  37
  38   /**
  39    * An iterator, similar to Binary_Search::get_next_friend, though in
  40    * this case the friend records are returned in the order they
  41    * appeared in the friend file, rather than in sorted order.  Also,
  42    * we skip over entries that don't have any hosts associated with
  43    * them.
  44    */
  45   virtual Protocol_Record *get_each_entry ();
  46 };
  47
  48 #endif /* _BS_CLIENT_H */