Class Mongo::Cursor::Builder::OpKillCursors
In: lib/mongo/cursor/builder/op_kill_cursors.rb
Parent: Object

Encapsulates behavior around generating an OP_KILL_CURSORS specification.

@since 2.2.0

Methods

get_cursors_list   new   specification   update_cursors  

Attributes

cursor  [R]  @return [ Cursor ] cursor The cursor.

Public Class methods

get_cursors_list(spec)

Get the list of cursor ids from a spec generated by this Builder.

@example Get the list of cursor ids. 

  OpKillCursors.cursors(spec)

@return [ Hash ] The specification.

@since 2.3.0

new(cursor)

Create the new builder.

@example Create the builder. 

  OpKillCursors.new(cursor)

@param [ Cursor ] cursor The cursor.

@since 2.2.0

update_cursors(spec, ids)

Update a specification‘s list of cursor ids.

@example Update a specification‘s list of cursor ids. 

  OpKillCursors.update_cursors(spec, ids)

@return [ Hash ] The specification. @return [ Array ] The ids to update with.

@since 2.3.0

Public Instance methods

specification()

Get the specification.

@example Get the specification. 

  op_kill_cursors.specification

@return [ Hash ] The specification.

@since 2.2.0

[Validate]