Class Mongo::Protocol::KillCursors
In: lib/mongo/protocol/kill_cursors.rb
Parent: Message

MongoDB Wire protocol KillCursors message.

This is a client request message that is sent to the server in order to kill a number of cursors.

@api semipublic

Methods

new   payload  

Classes and Modules

Class Mongo::Protocol::KillCursors::Upconverter

Constants

OP_CODE = 2007   The operation code required to specify KillCursors message. @return [Fixnum] the operation code.

@since 2.5.0

Attributes

upconverter  [R] 

Public Class methods

new(collection, database, cursor_ids)

Creates a new KillCursors message

@example Kill the cursor on the server with id 1. 

  KillCursors.new([1])

@param [ Mongo::Database ] collection The collection. @param [ Mongo::Database ] database The database. @param [ Array<Fixnum> ] cursor_ids The cursor ids to kill.

Public Instance methods

payload()

Return the event payload for monitoring.

@example Return the event payload. 

  message.payload

@return [ BSON::Document ] The event payload.

@since 2.1.0

[Validate]