Module: Mongo::Retryable

Relationships & Source Files
Namespace Children
Classes: `BaseWorker`, `ReadWorker`, `WriteWorker`
Extension / Inclusion / Inheritance Descendants
Included In: `CachingCursor`, `Cluster::CursorReaper`, `Collection`, `Collection::View::Aggregation`, `Collection::View::Aggregation::Behavior`, `Collection::View::ChangeStream`, `Collection::View::MapReduce`, `Cursor`, `Database`, `Database::View`, `Index::View`, `SearchIndex::View`, `Server::Connection`, `Session`
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, Forwardable
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

Instance Method Summary

#read_worker Internal use only Internal use only

Returns the read worker for handling retryable reads.
#select_server(cluster, server_selector, session, failed_server = nil, timeout: nil) ⇒ Mongo::Server Internal use only Internal use only

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

Returns the write worker for handling retryable writes.

Instance Method Details

#read_worker

This method is for internal use only.

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

[ GitHub ]

# 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 for internal use only.

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:

(Mongo::Server) —

A server matching the server preference.

Since:

2.1.0

[ GitHub ]

# 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

This method is for internal use only.

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

[ GitHub ]

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


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