Class: Mongo::Error::InvalidServerPreference

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, Error
Instance Chain: self, Error
Inherits:	Error Object Error Mongo::Error::InvalidServerPreference
Defined in:	lib/mongo/error/invalid_server_preference.rb

Overview

Raised when an invalid server preference is provided.

Since:

2.0.0

Constant Summary

INVALID_MAX_STALENESS =

Deprecated.

::Mongo::Error message for when the max staleness is not at least twice the heartbeat frequency.

Since:

2.4.0

# File 'lib/mongo/error/invalid_server_preference.rb', line 45

'`max_staleness` value is too small. It must be at least ' +
"`ServerSelector::SMALLEST_MAX_STALENESS_SECONDS` and (the cluster's heartbeat_frequency " +
'setting + `Cluster::IDLE_WRITE_PERIOD_SECONDS`).'

NO_HEDGE_SUPPORT = Internal use only

Deprecated.
Hedged reads are deprecated in MongoDB Server 8.0 and will be removed in a future version.

::Mongo::Error message when hedge is specified for a read preference that does not support it.
Since:
- 2.0.0
# File 'lib/mongo/error/invalid_server_preference.rb', line 39
```
'The hedge option cannot be set for this read preference'
```
NO_MAX_STALENESS_SUPPORT =

::Mongo::Error message when a max staleness is specified for a read preference that cannot support it.
Since:
- 2.4.0
# File 'lib/mongo/error/invalid_server_preference.rb', line 31
```
'max_staleness cannot be set for this read preference.'
```
NO_TAG_SUPPORT =

::Mongo::Error message when tags are specified for a read preference that cannot support them.
Since:
- 2.4.0
# File 'lib/mongo/error/invalid_server_preference.rb', line 26
```
'This read preference cannot be combined with tags.'
```

Class Method Summary

.new(message) ⇒ InvalidServerPreference constructor

Instantiate the new exception.

Constructor Details

.new(message) ⇒ `InvalidServerPreference`

Instantiate the new exception.

Examples:

Instantiate the exception.

Mongo::Error::InvalidServerPreference.new

Parameters:

message (String) —
The error message.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/error/invalid_server_preference.rb', line 57


def initialize(message)
  super
end

Class: Mongo::Error::InvalidServerPreference

Overview

Constant Summary

Class Method Summary

Constructor Details

.new(message) ⇒ InvalidServerPreference

.new(message) ⇒ `InvalidServerPreference`