157 lines
4.5 KiB
Python
157 lines
4.5 KiB
Python
# Copyright 2014-2015 MongoDB, Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
"""Represent one server in the topology."""
|
|
|
|
from pymongo.server_type import SERVER_TYPE
|
|
from pymongo.ismaster import IsMaster
|
|
|
|
|
|
class ServerDescription(object):
|
|
"""Immutable representation of one server.
|
|
|
|
:Parameters:
|
|
- `address`: A (host, port) pair
|
|
- `ismaster`: Optional IsMaster instance
|
|
- `round_trip_time`: Optional float
|
|
- `error`: Optional, the last error attempting to connect to the server
|
|
"""
|
|
|
|
__slots__ = (
|
|
'_address', '_server_type', '_all_hosts', '_tags', '_replica_set_name',
|
|
'_primary', '_max_bson_size', '_max_message_size',
|
|
'_max_write_batch_size', '_min_wire_version', '_max_wire_version',
|
|
'_round_trip_time', '_me', '_is_writable', '_is_readable', '_error',
|
|
'_set_version', '_election_id')
|
|
|
|
def __init__(
|
|
self,
|
|
address,
|
|
ismaster=None,
|
|
round_trip_time=None,
|
|
error=None):
|
|
self._address = address
|
|
if not ismaster:
|
|
ismaster = IsMaster({})
|
|
|
|
self._server_type = ismaster.server_type
|
|
self._all_hosts = ismaster.all_hosts
|
|
self._tags = ismaster.tags
|
|
self._replica_set_name = ismaster.replica_set_name
|
|
self._primary = ismaster.primary
|
|
self._max_bson_size = ismaster.max_bson_size
|
|
self._max_message_size = ismaster.max_message_size
|
|
self._max_write_batch_size = ismaster.max_write_batch_size
|
|
self._min_wire_version = ismaster.min_wire_version
|
|
self._max_wire_version = ismaster.max_wire_version
|
|
self._set_version = ismaster.set_version
|
|
self._election_id = ismaster.election_id
|
|
self._is_writable = ismaster.is_writable
|
|
self._is_readable = ismaster.is_readable
|
|
self._round_trip_time = round_trip_time
|
|
self._me = ismaster.me
|
|
self._error = error
|
|
|
|
@property
|
|
def address(self):
|
|
return self._address
|
|
|
|
@property
|
|
def server_type(self):
|
|
return self._server_type
|
|
|
|
@property
|
|
def all_hosts(self):
|
|
"""List of hosts, passives, and arbiters known to this server."""
|
|
return self._all_hosts
|
|
|
|
@property
|
|
def tags(self):
|
|
return self._tags
|
|
|
|
@property
|
|
def replica_set_name(self):
|
|
"""Replica set name or None."""
|
|
return self._replica_set_name
|
|
|
|
@property
|
|
def primary(self):
|
|
"""This server's opinion about who the primary is, or None."""
|
|
return self._primary
|
|
|
|
@property
|
|
def max_bson_size(self):
|
|
return self._max_bson_size
|
|
|
|
@property
|
|
def max_message_size(self):
|
|
return self._max_message_size
|
|
|
|
@property
|
|
def max_write_batch_size(self):
|
|
return self._max_write_batch_size
|
|
|
|
@property
|
|
def min_wire_version(self):
|
|
return self._min_wire_version
|
|
|
|
@property
|
|
def max_wire_version(self):
|
|
return self._max_wire_version
|
|
|
|
@property
|
|
def set_version(self):
|
|
return self._set_version
|
|
|
|
@property
|
|
def election_id(self):
|
|
return self._election_id
|
|
|
|
@property
|
|
def election_tuple(self):
|
|
return self._set_version, self._election_id
|
|
|
|
@property
|
|
def me(self):
|
|
return self._me
|
|
|
|
@property
|
|
def round_trip_time(self):
|
|
"""The current average latency or None."""
|
|
# This override is for unittesting only!
|
|
if self._address in self._host_to_round_trip_time:
|
|
return self._host_to_round_trip_time[self._address]
|
|
|
|
return self._round_trip_time
|
|
|
|
@property
|
|
def error(self):
|
|
"""The last error attempting to connect to the server, or None."""
|
|
return self._error
|
|
|
|
@property
|
|
def is_writable(self):
|
|
return self._is_writable
|
|
|
|
@property
|
|
def is_readable(self):
|
|
return self._is_readable
|
|
|
|
@property
|
|
def is_server_type_known(self):
|
|
return self.server_type != SERVER_TYPE.Unknown
|
|
|
|
# For unittesting only. Use under no circumstances!
|
|
_host_to_round_trip_time = {}
|