]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
msgr: Update 'documentation'.
authorGreg Farnum <gregf@hq.newdream.net>
Wed, 10 Feb 2010 20:02:42 +0000 (12:02 -0800)
committerGreg Farnum <gregf@hq.newdream.net>
Wed, 10 Feb 2010 20:02:56 +0000 (12:02 -0800)
src/msg/SimpleMessenger.h

index ca1c8975c069ad4ad0c0121d9db2a809a2f2134a..fb046de81ef7db8b47bfb0b8ce3d44b9b4b04767 100644 (file)
@@ -37,14 +37,13 @@ using namespace __gnu_cxx;
 
 /*
  * This class handles transmission and reception of messages. Generally
- * speaking, there are 3 major components:
- * 1) SimpleMessenger. It's the exterior class and handles the others.
- * 2) Endpoint. Wraps the Messenger object which this SimpleMessenger serves,
- *    and handles individual message delivery. Once upon a time you could have
- *    multiple Endpoints in a SimpleMessenger; now it *might* be simpler and
- *    cleaner to merge the class with SimpleMessenger itself.
- * 3) Pipe. Each network connection is handled through a pipe, which handles
+ * speaking, there are 2 major components:
+ * 1) Pipe. Each network connection is handled through a pipe, which handles
  *    the input and output of each message.
+ * 2) SimpleMessenger. It's the exterior class passed to the external 
+ *    message handler and handles queuing and ordering of pipes. Each
+ *    pipe maintains its own message ordering, but the SimpleMessenger
+ *    decides what order pipes get to deliver messages in.
  *
  * This class should only be created on the heap, and it should be destroyed
  * via a call to destroy(). Making it on the stack or otherwise calling