SERVER-19464 Add a way to explicitly kill a DBClientCursor before destruction

1 files changed, 12 insertions, 0 deletions

diff --git a/src/mongo/client/dbclientcursor.h b/src/mongo/client/dbclientcursor.h
index c10f4adf8ff..2dede943b4b 100644
--- a/src/mongo/client/dbclientcursor.h
+++ b/src/mongo/client/dbclientcursor.h
@@ -229,6 +229,18 @@ public:
      */
     void exhaustReceiveMore();
 
+    /**
+     * Marks this object as dead and sends the KillCursors message to the server.
+     *
+     * Any errors that result from this are swallowed since this is typically performed as part of
+     * cleanup and a failure to kill the cursor should not result in a failure of the operation
+     * using the cursor.
+     *
+     * Killing an already killed or exhausted cursor does nothing, so it is safe to always call this
+     * if you want to ensure that a cursor is killed.
+     */
+    void kill();
+
 private:
     DBClientCursor(DBClientBase* client,
                    const std::string& ns,