1 files changed, 42 insertions, 27 deletions

diff --git a/examples/ASX/Event_Server/Event_Server/Peer_Router.h b/examples/ASX/Event_Server/Event_Server/Peer_Router.h
index d9b7021f726..3369fe6415f 100644
--- a/examples/ASX/Event_Server/Event_Server/Peer_Router.h
+++ b/examples/ASX/Event_Server/Event_Server/Peer_Router.h
@@ -16,10 +16,10 @@ class Peer_Router;
 class Peer_Router_Context;
 
 class Peer_Handler : public ACE_Svc_Handler<ACE_SOCK_STREAM, ACE_SYNCH>
+{
   // = TITLE
   //     Receive input from a Peer and forward to the appropriate
-  //     <Peer_Router>.
-{
+  //     <Peer_Router> (i.e., <Consumer_Router> or <Supplier_Router>).
 public:
   Peer_Handler (Peer_Router_Context * = 0);
   // Initialization method.
@@ -29,28 +29,34 @@ public:
   // object.
 
   virtual int handle_input (ACE_HANDLE);
-  // Receive input from the peer.
+  // Receive input from a peer.
 
   virtual int put (ACE_Message_Block *, ACE_Time_Value *tv = 0);  
-  // Send output to a peer.
+  // Send output to a peer.  Note that this implementation "blocks" if
+  // flow control occurs.  This is undesirable for "real"
+  // applications.  The best way around this is to make the
+  // <Peer_Handler> an Active Object, e.g., as done in the
+  // $ACE_ROOT/apps/Gateway/Gateway application.
 
 protected:
-  Peer_Router_Context *prc_;  
-  // Pointer to router context.
+  Peer_Router_Context *peer_router_context_;  
+  // Pointer to router context.  This maintains the state that is
+  // shared by both Tasks in a <Peer_Router> Module.
 };
 
 class Peer_Router_Context : public ACE_Acceptor<Peer_Handler, ACE_SOCK_ACCEPTOR>
+{
   // = TITLE
   //     Defines state and behavior shared between both Tasks in a
-  //     Peer_Router Module.  
+  //     <Peer_Router> Module.  
   //
   // = DESCRIPTION
-  //     This class also serves as an Acceptor, which creates
-  //     Peer_Handlers when Peers connect.
-{
+  //     This class also serves as an <ACE_Acceptor>, which creates
+  //     <Peer_Handlers> when Peers connect.
 public:
   // = Initialization and termination methods.
   Peer_Router_Context (u_short port);
+  // Constructor.
 
   virtual int unbind_peer (ROUTING_KEY);
   // Remove the <Peer_Handler *> from the <PEER_MAP> that corresponds
@@ -61,29 +67,37 @@ public:
   // <ROUTING_KEY>.
 
   int send_peers (ACE_Message_Block *mb);
-  // Send the <ACE_Message_Block> to the peer(s).
+  // Send the <ACE_Message_Block> to all the peers.  Note that in a
+  // "real" application this logic would most likely be more
+  // selective, i.e., it would actually do "routing" based on
+  // addressing information passed in the <ACE_Message_Block>.
 
   int make_svc_handler (Peer_Handler *&sh);
-  // Create a new <Peer_Handler> for each connection.
+  // Factory Method that creates a new <Peer_Handler> for each
+  // connection.  This method overrides the default behavior in
+  // <ACE_Acceptor>.
 
   // = Set/Get Router Task.
-  Peer_Router *peer_router ();
+  Peer_Router *peer_router (void);
   void peer_router (Peer_Router *);
 
   void release (void);
   // Decrement the reference count and delete <this> when count == 0;
 
   void duplicate (void);
-  // Increment the reference count 
+  // Increment the reference count.
 
 private:
   Peer_Router *peer_router_;
   // Pointer to the <Peer_Router> that we are accepting for.
 
-  // = Useful typedefs
-  typedef ACE_Map_Manager <ROUTING_KEY, Peer_Handler *, ACE_SYNCH_RW_MUTEX> PEER_MAP;
-  typedef ACE_Map_Iterator<ROUTING_KEY, Peer_Handler *, ACE_SYNCH_RW_MUTEX> PEER_ITERATOR;
-  typedef ACE_Map_Entry<ROUTING_KEY, Peer_Handler *> PEER_ENTRY;
+  // = Useful typedefs.
+  typedef ACE_Map_Manager <ROUTING_KEY, Peer_Handler *, ACE_SYNCH_RW_MUTEX> 
+          PEER_MAP;
+  typedef ACE_Map_Iterator<ROUTING_KEY, Peer_Handler *, ACE_SYNCH_RW_MUTEX> 
+          PEER_ITERATOR;
+  typedef ACE_Map_Entry<ROUTING_KEY, Peer_Handler *> 
+          PEER_ENTRY;
 
   PEER_MAP peer_map_;
   // Map used to keep track of active peers.
@@ -95,21 +109,22 @@ private:
   // Private to ensure dynamic allocation.
 
   friend class Friend_Of_Peer_Router_Context;
-  // declare a friend class to avoid compiler warnings because the
+  // Declare a friend class to avoid compiler warnings because the
   // destructor is private.
 };
 
 class Peer_Router : public ACE_Task<ACE_SYNCH>
+{
   // = TITLE
   //     This abstract base class provides mechanisms for routing
-  //     messages to/from a ACE_Stream from/to one or more peers (which
+  //     messages to/from a <ACE_Stream> from/to one or more peers (which
   //     are typically running on remote hosts).
   //
   // = DESCRIPTION
-  //     A subclass of Peer_Router overrides the open(), close(), and
-  //     put() methods in order to specialize the behavior of the router
-  //     to meet application-specific requirements.
-{
+  //     Subclasses of <Peer_Router> (such as <Consumer_Router> or
+  //     <Supplier_Router>) override the <open>, <close>, and
+  //     <put> methods to specialize the behavior of the router to
+  //     meet application-specific requirements.
 protected:
   Peer_Router (Peer_Router_Context *prc);
   // Initialization method.
@@ -124,9 +139,9 @@ protected:
   // Helpful typedef.
 
 private:
-  Peer_Router_Context *prc_;
-  // Reference to the context shared by the writer and reader Tasks in
-  // the Consumer and Supplier Modules.
+  Peer_Router_Context *peer_router_context_;
+  // Reference to the context shared by the writer and reader Tasks,
+  // e.g., in the <Consumer_Router> and <Supplier_Router> Modules.
 
   // = Prevent copies and pass-by-value.
   Peer_Router (const Peer_Router &);