diff options
author | Sage Weil <sage@inktank.com> | 2013-07-18 10:53:04 -0700 |
---|---|---|
committer | Greg Farnum <greg@inktank.com> | 2013-07-19 13:21:47 -0700 |
commit | 27868ca5ac6bd09f7de8836d61776a17e21657e0 (patch) | |
tree | fb1657b34e86132730859500884ffbf7e370dd90 | |
parent | 8dcf0b199af36f0f3b3fb81103949050d53750e4 (diff) | |
download | ceph-27868ca5ac6bd09f7de8836d61776a17e21657e0.tar.gz |
msgr: update docs for mark_down, mark_down_all semantics
* RESET events
* note that the reset detection only happens if it is enabled in the
policy.
Signed-off-by: Sage Weil <sage@inktank.com>
-rw-r--r-- | src/msg/Messenger.h | 42 |
1 files changed, 26 insertions, 16 deletions
diff --git a/src/msg/Messenger.h b/src/msg/Messenger.h index 28643e10767..be0dcd1738e 100644 --- a/src/msg/Messenger.h +++ b/src/msg/Messenger.h @@ -476,22 +476,30 @@ public: */ virtual int send_keepalive(Connection *con) = 0; /** - * Mark down a Connection to a remote. This will cause us to - * discard our outgoing queue for them, and if they try - * to reconnect they will discard their queue when we - * inform them of the session reset. If there is no - * Connection to the given dest, it is a no-op. - * It does not generate any notifications to the Dispatcher. + * Mark down a Connection to a remote. + * + * This will cause us to discard our outgoing queue for them, and if + * reset detection is enabled in the policy and the endpoint tries + * to reconnect they will discard their queue when we inform them of + * the session reset. + * + * If there is no Connection to the given dest, it is a no-op. + * + * This generates a RESET notification to the Dispatcher. * * @param a The address to mark down. */ virtual void mark_down(const entity_addr_t& a) = 0; /** - * Mark down the given Connection. This will cause us to - * discard its outgoing queue, and if the endpoint tries - * to reconnect they will discard their queue when we - * inform them of the session reset. + * Mark down the given Connection. + * + * This will cause us to discard its outgoing queue, and if reset + * detection is enabled in the policy and the endpoint tries to + * reconnect they will discard their queue when we inform them of + * the session reset. + * * If the Connection* is NULL, this is a no-op. + * * It does not generate any notifications to the Dispatcher. * * @param con The Connection to mark down. @@ -501,6 +509,14 @@ public: mark_down(con.get()); } /** + * Mark all the existing Connections down. This is equivalent + * to iterating over all Connections and calling mark_down() + * on each. + * + * This will generate a RESET event for each closed connections. + */ + virtual void mark_down_all() = 0; + /** * Unlike mark_down, this function will try and deliver * all messages before ending the connection, and it will use * the Pipe's existing semantics to do so. Once the Messages @@ -530,12 +546,6 @@ public: */ virtual void mark_disposable(Connection *con) = 0; /** - * Mark all the existing Connections down. This is equivalent - * to iterating over all Connections and calling mark_down() - * on each. - */ - virtual void mark_down_all() = 0; - /** * @} // Connection Management */ protected: |