summaryrefslogtreecommitdiff
path: root/ACE/apps/drwho/BS_Client.h
diff options
context:
space:
mode:
Diffstat (limited to 'ACE/apps/drwho/BS_Client.h')
-rw-r--r--ACE/apps/drwho/BS_Client.h56
1 files changed, 30 insertions, 26 deletions
diff --git a/ACE/apps/drwho/BS_Client.h b/ACE/apps/drwho/BS_Client.h
index 9859768df82..f5a820bfa19 100644
--- a/ACE/apps/drwho/BS_Client.h
+++ b/ACE/apps/drwho/BS_Client.h
@@ -1,46 +1,50 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// drwho
-//
-// = FILENAME
-// BS_Client.h
-//
-// = AUTHOR
-// Douglas C. Schmidt
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file BS_Client.h
+ *
+ * $Id$
+ *
+ * @author Douglas C. Schmidt
+ */
+//=============================================================================
+
#ifndef _BS_CLIENT_H
#define _BS_CLIENT_H
#include "Binary_Search.h"
+/**
+ * @class BS_Client
+ *
+ * @brief Provides the client's binary search lookup table abstraction.
+ */
class BS_Client : public Binary_Search
{
- // = TITLE
- // Provides the client's binary search lookup table abstraction.
public:
// = Initialization.
+ /// Constructor.
BS_Client (void);
- // Constructor.
+ /**
+ * This function is used to merge the <key_name> from server
+ * <host_name> into the sorted list of userids kept on the client's
+ * side. Since we *know* we are going to find the name we use the
+ * traditional binary search.
+ */
virtual Protocol_Record *insert (const char *key_name,
int max_len = MAXUSERIDNAMELEN);
- // This function is used to merge the <key_name> from server
- // <host_name> into the sorted list of userids kept on the client's
- // side. Since we *know* we are going to find the name we use the
- // traditional binary search.
+ /**
+ * An iterator, similar to Binary_Search::get_next_friend, though in
+ * this case the friend records are returned in the order they
+ * appeared in the friend file, rather than in sorted order. Also,
+ * we skip over entries that don't have any hosts associated with
+ * them.
+ */
virtual Protocol_Record *get_each_entry (void);
- // An iterator, similar to Binary_Search::get_next_friend, though in
- // this case the friend records are returned in the order they
- // appeared in the friend file, rather than in sorted order. Also,
- // we skip over entries that don't have any hosts associated with
- // them.
};
#endif /* _BS_CLIENT_H */