Module: Mongo::Retryable

Extended by:
Forwardable
Included in:
Cluster::CursorReaper, Collection, Collection::View::Aggregation::Behavior, Collection::View::ChangeStream, Collection::View::MapReduce, Cursor, Database, Database::View, Index::View, SearchIndex::View, Server::Connection, Session
Defined in:
lib/mongo/retryable.rb,
lib/mongo/retryable/base_worker.rb,
lib/mongo/retryable/read_worker.rb,
lib/mongo/retryable/write_worker.rb

Overview

Defines basic behavior around retrying operations.

Since:

  • 2.1.0

Defined Under Namespace

Classes: BaseWorker, ReadWorker, WriteWorker

Instance Method Summary collapse

Instance Method Details

#read_worker ⇒ Object

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.

Note:

this is only a public method so that tests can add expectations based on it.

Returns the read worker for handling retryable reads.

Since:

  • 2.1.0



65
66
67
 
# File 'lib/mongo/retryable.rb', line 65

def read_worker
  @read_worker ||= ReadWorker.new(self)
end

#select_server(cluster, server_selector, session, failed_server = nil, timeout: nil) ⇒ Mongo::Server

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.

This is a separate method to make it possible for the test suite to assert that server selection is performed during retry attempts.

This is a public method so that it can be accessed via the read and write worker delegates, as needed.

Returns:

Since:

  • 2.1.0



49
50
51
52
53
54
55
56
57
 
# File 'lib/mongo/retryable.rb', line 49

def select_server(cluster, server_selector, session, failed_server = nil, timeout: nil)
  server_selector.select_server(
    cluster,
    nil,
    session,
    deprioritized: [failed_server].compact,
    timeout: timeout
  )
end

#write_worker ⇒ Object

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.

Note:

this is only a public method so that tests can add expectations based on it.

Returns the write worker for handling retryable writes.

Since:

  • 2.1.0



75
76
77
 
# File 'lib/mongo/retryable.rb', line 75

def write_worker
  @write_worker ||= WriteWorker.new(self)
end