Module: Mongo::Cursor::NonTailable Private

Included in:

Database::View, Index::View

Defined in:

lib/mongo/cursor/nontailable.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

This module is used by cursor-implementing classes to indicate that the only cursors they generate are non-tailable, and iterable.

Instance Method Summary

• #cursor_type ⇒ nil private

  These views are always non-tailable.

• #timeout_mode ⇒ :iterable private

  These views apply timeouts to each iteration of a cursor, as opposed to the entire lifetime of the cursor.

Instance Method Details

#cursor_type ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

These views are always non-tailable.

Returns:

• (nil) —

  indicating a non-tailable cursor.

# File 'lib/mongo/cursor/nontailable.rb', line 13

def cursor_type
  nil
end

#timeout_mode ⇒ :iterable

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

These views apply timeouts to each iteration of a cursor, as opposed to the entire lifetime of the cursor.

Returns:

• (:iterable) —

  indicating a cursor with a timeout mode of “iterable”.

# File 'lib/mongo/cursor/nontailable.rb', line 22

def timeout_mode
  :iterable
end