1
# Copyright (C) 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""The 'medium' layer for the smart servers and clients.
19
"Medium" here is the noun meaning "a means of transmission", not the adjective
20
for "the quality between big and small."
22
Media carry the bytes of the requests somehow (e.g. via TCP, wrapped in HTTP, or
23
over SSH), and pass them to and from the protocol logic. See the overview in
24
bzrlib/transport/smart/__init__.py.
33
from bzrlib.lazy_import import lazy_import
34
lazy_import(globals(), """
46
from bzrlib.smart import client, protocol, request, vfs
47
from bzrlib.transport import ssh
51
# We must not read any more than 64k at a time so we don't risk "no buffer
52
# space available" errors on some platforms. Windows in particular is likely
53
# to give error 10053 or 10055 if we read more than 64k from a socket.
54
_MAX_READ_SIZE = 64 * 1024
57
def _get_protocol_factory_for_bytes(bytes):
58
"""Determine the right protocol factory for 'bytes'.
60
This will return an appropriate protocol factory depending on the version
61
of the protocol being used, as determined by inspecting the given bytes.
62
The bytes should have at least one newline byte (i.e. be a whole line),
63
otherwise it's possible that a request will be incorrectly identified as
66
Typical use would be::
68
factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
69
server_protocol = factory(transport, write_func, root_client_path)
70
server_protocol.accept_bytes(unused_bytes)
72
:param bytes: a str of bytes of the start of the request.
73
:returns: 2-tuple of (protocol_factory, unused_bytes). protocol_factory is
74
a callable that takes three args: transport, write_func,
75
root_client_path. unused_bytes are any bytes that were not part of a
76
protocol version marker.
78
if bytes.startswith(protocol.MESSAGE_VERSION_THREE):
79
protocol_factory = protocol.build_server_protocol_three
80
bytes = bytes[len(protocol.MESSAGE_VERSION_THREE):]
81
elif bytes.startswith(protocol.REQUEST_VERSION_TWO):
82
protocol_factory = protocol.SmartServerRequestProtocolTwo
83
bytes = bytes[len(protocol.REQUEST_VERSION_TWO):]
85
protocol_factory = protocol.SmartServerRequestProtocolOne
86
return protocol_factory, bytes
89
def _get_line(read_bytes_func):
90
"""Read bytes using read_bytes_func until a newline byte.
92
This isn't particularly efficient, so should only be used when the
93
expected size of the line is quite short.
95
:returns: a tuple of two strs: (line, excess)
99
while newline_pos == -1:
100
new_bytes = read_bytes_func(1)
103
# Ran out of bytes before receiving a complete line.
105
newline_pos = bytes.find('\n')
106
line = bytes[:newline_pos+1]
107
excess = bytes[newline_pos+1:]
111
class SmartMedium(object):
112
"""Base class for smart protocol media, both client- and server-side."""
115
self._push_back_buffer = None
117
def _push_back(self, bytes):
118
"""Return unused bytes to the medium, because they belong to the next
121
This sets the _push_back_buffer to the given bytes.
123
if self._push_back_buffer is not None:
124
raise AssertionError(
125
"_push_back called when self._push_back_buffer is %r"
126
% (self._push_back_buffer,))
129
self._push_back_buffer = bytes
131
def _get_push_back_buffer(self):
132
if self._push_back_buffer == '':
133
raise AssertionError(
134
'%s._push_back_buffer should never be the empty string, '
135
'which can be confused with EOF' % (self,))
136
bytes = self._push_back_buffer
137
self._push_back_buffer = None
140
def read_bytes(self, desired_count):
141
"""Read some bytes from this medium.
143
:returns: some bytes, possibly more or less than the number requested
144
in 'desired_count' depending on the medium.
146
if self._push_back_buffer is not None:
147
return self._get_push_back_buffer()
148
bytes_to_read = min(desired_count, _MAX_READ_SIZE)
149
return self._read_bytes(bytes_to_read)
151
def _read_bytes(self, count):
152
raise NotImplementedError(self._read_bytes)
155
"""Read bytes from this request's response until a newline byte.
157
This isn't particularly efficient, so should only be used when the
158
expected size of the line is quite short.
160
:returns: a string of bytes ending in a newline (byte 0x0A).
162
line, excess = _get_line(self.read_bytes)
163
self._push_back(excess)
166
def _report_activity(self, bytes, direction):
167
"""Notify that this medium has activity.
169
Implementations should call this from all methods that actually do IO.
170
Be careful that it's not called twice, if one method is implemented on
173
:param bytes: Number of bytes read or written.
174
:param direction: 'read' or 'write' or None.
176
ui.ui_factory.report_transport_activity(self, bytes, direction)
179
class SmartServerStreamMedium(SmartMedium):
180
"""Handles smart commands coming over a stream.
182
The stream may be a pipe connected to sshd, or a tcp socket, or an
183
in-process fifo for testing.
185
One instance is created for each connected client; it can serve multiple
186
requests in the lifetime of the connection.
188
The server passes requests through to an underlying backing transport,
189
which will typically be a LocalTransport looking at the server's filesystem.
191
:ivar _push_back_buffer: a str of bytes that have been read from the stream
192
but not used yet, or None if there are no buffered bytes. Subclasses
193
should make sure to exhaust this buffer before reading more bytes from
194
the stream. See also the _push_back method.
197
def __init__(self, backing_transport, root_client_path='/'):
198
"""Construct new server.
200
:param backing_transport: Transport for the directory served.
202
# backing_transport could be passed to serve instead of __init__
203
self.backing_transport = backing_transport
204
self.root_client_path = root_client_path
205
self.finished = False
206
SmartMedium.__init__(self)
209
"""Serve requests until the client disconnects."""
210
# Keep a reference to stderr because the sys module's globals get set to
211
# None during interpreter shutdown.
212
from sys import stderr
214
while not self.finished:
215
server_protocol = self._build_protocol()
216
self._serve_one_request(server_protocol)
218
stderr.write("%s terminating on exception %s\n" % (self, e))
221
def _build_protocol(self):
222
"""Identifies the version of the incoming request, and returns an
223
a protocol object that can interpret it.
225
If more bytes than the version prefix of the request are read, they will
226
be fed into the protocol before it is returned.
228
:returns: a SmartServerRequestProtocol.
230
bytes = self._get_line()
231
protocol_factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
232
protocol = protocol_factory(
233
self.backing_transport, self._write_out, self.root_client_path)
234
protocol.accept_bytes(unused_bytes)
237
def _serve_one_request(self, protocol):
238
"""Read one request from input, process, send back a response.
240
:param protocol: a SmartServerRequestProtocol.
243
self._serve_one_request_unguarded(protocol)
244
except KeyboardInterrupt:
247
self.terminate_due_to_error()
249
def terminate_due_to_error(self):
250
"""Called when an unhandled exception from the protocol occurs."""
251
raise NotImplementedError(self.terminate_due_to_error)
253
def _read_bytes(self, desired_count):
254
"""Get some bytes from the medium.
256
:param desired_count: number of bytes we want to read.
258
raise NotImplementedError(self._read_bytes)
261
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
263
def __init__(self, sock, backing_transport, root_client_path='/'):
266
:param sock: the socket the server will read from. It will be put
269
SmartServerStreamMedium.__init__(
270
self, backing_transport, root_client_path=root_client_path)
271
sock.setblocking(True)
274
def _serve_one_request_unguarded(self, protocol):
275
while protocol.next_read_size():
276
# We can safely try to read large chunks. If there is less data
277
# than _MAX_READ_SIZE ready, the socket wil just return a short
278
# read immediately rather than block.
279
bytes = self.read_bytes(_MAX_READ_SIZE)
283
protocol.accept_bytes(bytes)
285
self._push_back(protocol.unused_data)
287
def _read_bytes(self, desired_count):
288
return _read_bytes_from_socket(
289
self.socket.recv, desired_count, self._report_activity)
291
def terminate_due_to_error(self):
292
# TODO: This should log to a server log file, but no such thing
293
# exists yet. Andrew Bennetts 2006-09-29.
297
def _write_out(self, bytes):
298
osutils.send_all(self.socket, bytes, self._report_activity)
301
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
303
def __init__(self, in_file, out_file, backing_transport):
304
"""Construct new server.
306
:param in_file: Python file from which requests can be read.
307
:param out_file: Python file to write responses.
308
:param backing_transport: Transport for the directory served.
310
SmartServerStreamMedium.__init__(self, backing_transport)
311
if sys.platform == 'win32':
312
# force binary mode for files
314
for f in (in_file, out_file):
315
fileno = getattr(f, 'fileno', None)
317
msvcrt.setmode(fileno(), os.O_BINARY)
321
def _serve_one_request_unguarded(self, protocol):
323
# We need to be careful not to read past the end of the current
324
# request, or else the read from the pipe will block, so we use
325
# protocol.next_read_size().
326
bytes_to_read = protocol.next_read_size()
327
if bytes_to_read == 0:
328
# Finished serving this request.
331
bytes = self.read_bytes(bytes_to_read)
333
# Connection has been closed.
337
protocol.accept_bytes(bytes)
339
def _read_bytes(self, desired_count):
340
return self._in.read(desired_count)
342
def terminate_due_to_error(self):
343
# TODO: This should log to a server log file, but no such thing
344
# exists yet. Andrew Bennetts 2006-09-29.
348
def _write_out(self, bytes):
349
self._out.write(bytes)
352
class SmartClientMediumRequest(object):
353
"""A request on a SmartClientMedium.
355
Each request allows bytes to be provided to it via accept_bytes, and then
356
the response bytes to be read via read_bytes.
359
request.accept_bytes('123')
360
request.finished_writing()
361
result = request.read_bytes(3)
362
request.finished_reading()
364
It is up to the individual SmartClientMedium whether multiple concurrent
365
requests can exist. See SmartClientMedium.get_request to obtain instances
366
of SmartClientMediumRequest, and the concrete Medium you are using for
367
details on concurrency and pipelining.
370
def __init__(self, medium):
371
"""Construct a SmartClientMediumRequest for the medium medium."""
372
self._medium = medium
373
# we track state by constants - we may want to use the same
374
# pattern as BodyReader if it gets more complex.
375
# valid states are: "writing", "reading", "done"
376
self._state = "writing"
378
def accept_bytes(self, bytes):
379
"""Accept bytes for inclusion in this request.
381
This method may not be called after finished_writing() has been
382
called. It depends upon the Medium whether or not the bytes will be
383
immediately transmitted. Message based Mediums will tend to buffer the
384
bytes until finished_writing() is called.
386
:param bytes: A bytestring.
388
if self._state != "writing":
389
raise errors.WritingCompleted(self)
390
self._accept_bytes(bytes)
392
def _accept_bytes(self, bytes):
393
"""Helper for accept_bytes.
395
Accept_bytes checks the state of the request to determing if bytes
396
should be accepted. After that it hands off to _accept_bytes to do the
399
raise NotImplementedError(self._accept_bytes)
401
def finished_reading(self):
402
"""Inform the request that all desired data has been read.
404
This will remove the request from the pipeline for its medium (if the
405
medium supports pipelining) and any further calls to methods on the
406
request will raise ReadingCompleted.
408
if self._state == "writing":
409
raise errors.WritingNotComplete(self)
410
if self._state != "reading":
411
raise errors.ReadingCompleted(self)
413
self._finished_reading()
415
def _finished_reading(self):
416
"""Helper for finished_reading.
418
finished_reading checks the state of the request to determine if
419
finished_reading is allowed, and if it is hands off to _finished_reading
420
to perform the action.
422
raise NotImplementedError(self._finished_reading)
424
def finished_writing(self):
425
"""Finish the writing phase of this request.
427
This will flush all pending data for this request along the medium.
428
After calling finished_writing, you may not call accept_bytes anymore.
430
if self._state != "writing":
431
raise errors.WritingCompleted(self)
432
self._state = "reading"
433
self._finished_writing()
435
def _finished_writing(self):
436
"""Helper for finished_writing.
438
finished_writing checks the state of the request to determine if
439
finished_writing is allowed, and if it is hands off to _finished_writing
440
to perform the action.
442
raise NotImplementedError(self._finished_writing)
444
def read_bytes(self, count):
445
"""Read bytes from this requests response.
447
This method will block and wait for count bytes to be read. It may not
448
be invoked until finished_writing() has been called - this is to ensure
449
a message-based approach to requests, for compatibility with message
450
based mediums like HTTP.
452
if self._state == "writing":
453
raise errors.WritingNotComplete(self)
454
if self._state != "reading":
455
raise errors.ReadingCompleted(self)
456
return self._read_bytes(count)
458
def _read_bytes(self, count):
459
"""Helper for SmartClientMediumRequest.read_bytes.
461
read_bytes checks the state of the request to determing if bytes
462
should be read. After that it hands off to _read_bytes to do the
465
By default this forwards to self._medium.read_bytes because we are
466
operating on the medium's stream.
468
return self._medium.read_bytes(count)
471
line = self._read_line()
472
if not line.endswith('\n'):
473
# end of file encountered reading from server
474
raise errors.ConnectionReset(
475
"please check connectivity and permissions")
478
def _read_line(self):
479
"""Helper for SmartClientMediumRequest.read_line.
481
By default this forwards to self._medium._get_line because we are
482
operating on the medium's stream.
484
return self._medium._get_line()
487
class _DebugCounter(object):
488
"""An object that counts the HPSS calls made to each client medium.
490
When a medium is garbage-collected, or failing that when atexit functions
491
are run, the total number of calls made on that medium are reported via
496
self.counts = weakref.WeakKeyDictionary()
497
client._SmartClient.hooks.install_named_hook(
498
'call', self.increment_call_count, 'hpss call counter')
499
atexit.register(self.flush_all)
501
def track(self, medium):
502
"""Start tracking calls made to a medium.
504
This only keeps a weakref to the medium, so shouldn't affect the
507
medium_repr = repr(medium)
508
# Add this medium to the WeakKeyDictionary
509
self.counts[medium] = dict(count=0, vfs_count=0,
510
medium_repr=medium_repr)
511
# Weakref callbacks are fired in reverse order of their association
512
# with the referenced object. So we add a weakref *after* adding to
513
# the WeakKeyDict so that we can report the value from it before the
514
# entry is removed by the WeakKeyDict's own callback.
515
ref = weakref.ref(medium, self.done)
517
def increment_call_count(self, params):
518
# Increment the count in the WeakKeyDictionary
519
value = self.counts[params.medium]
521
request_method = request.request_handlers.get(params.method)
522
if issubclass(request_method, vfs.VfsRequest):
523
value['vfs_count'] += 1
526
value = self.counts[ref]
527
count, vfs_count, medium_repr = (
528
value['count'], value['vfs_count'], value['medium_repr'])
529
# In case this callback is invoked for the same ref twice (by the
530
# weakref callback and by the atexit function), set the call count back
531
# to 0 so this item won't be reported twice.
533
value['vfs_count'] = 0
535
trace.note('HPSS calls: %d (%d vfs) %s',
536
count, vfs_count, medium_repr)
539
for ref in list(self.counts.keys()):
542
_debug_counter = None
545
class SmartClientMedium(SmartMedium):
546
"""Smart client is a medium for sending smart protocol requests over."""
548
def __init__(self, base):
549
super(SmartClientMedium, self).__init__()
551
self._protocol_version_error = None
552
self._protocol_version = None
553
self._done_hello = False
554
# Be optimistic: we assume the remote end can accept new remote
555
# requests until we get an error saying otherwise.
556
# _remote_version_is_before tracks the bzr version the remote side
557
# can be based on what we've seen so far.
558
self._remote_version_is_before = None
559
# Install debug hook function if debug flag is set.
560
if 'hpss' in debug.debug_flags:
561
global _debug_counter
562
if _debug_counter is None:
563
_debug_counter = _DebugCounter()
564
_debug_counter.track(self)
566
def _is_remote_before(self, version_tuple):
567
"""Is it possible the remote side supports RPCs for a given version?
571
needed_version = (1, 2)
572
if medium._is_remote_before(needed_version):
573
fallback_to_pre_1_2_rpc()
577
except UnknownSmartMethod:
578
medium._remember_remote_is_before(needed_version)
579
fallback_to_pre_1_2_rpc()
581
:seealso: _remember_remote_is_before
583
if self._remote_version_is_before is None:
584
# So far, the remote side seems to support everything
586
return version_tuple >= self._remote_version_is_before
588
def _remember_remote_is_before(self, version_tuple):
589
"""Tell this medium that the remote side is older the given version.
591
:seealso: _is_remote_before
593
if (self._remote_version_is_before is not None and
594
version_tuple > self._remote_version_is_before):
595
# We have been told that the remote side is older than some version
596
# which is newer than a previously supplied older-than version.
597
# This indicates that some smart verb call is not guarded
598
# appropriately (it should simply not have been tried).
599
raise AssertionError(
600
"_remember_remote_is_before(%r) called, but "
601
"_remember_remote_is_before(%r) was called previously."
602
% (version_tuple, self._remote_version_is_before))
603
self._remote_version_is_before = version_tuple
605
def protocol_version(self):
606
"""Find out if 'hello' smart request works."""
607
if self._protocol_version_error is not None:
608
raise self._protocol_version_error
609
if not self._done_hello:
611
medium_request = self.get_request()
612
# Send a 'hello' request in protocol version one, for maximum
613
# backwards compatibility.
614
client_protocol = protocol.SmartClientRequestProtocolOne(medium_request)
615
client_protocol.query_version()
616
self._done_hello = True
617
except errors.SmartProtocolError, e:
618
# Cache the error, just like we would cache a successful
620
self._protocol_version_error = e
624
def should_probe(self):
625
"""Should RemoteBzrDirFormat.probe_transport send a smart request on
628
Some transports are unambiguously smart-only; there's no need to check
629
if the transport is able to carry smart requests, because that's all
630
it is for. In those cases, this method should return False.
632
But some HTTP transports can sometimes fail to carry smart requests,
633
but still be usuable for accessing remote bzrdirs via plain file
634
accesses. So for those transports, their media should return True here
635
so that RemoteBzrDirFormat can determine if it is appropriate for that
640
def disconnect(self):
641
"""If this medium maintains a persistent connection, close it.
643
The default implementation does nothing.
646
def remote_path_from_transport(self, transport):
647
"""Convert transport into a path suitable for using in a request.
649
Note that the resulting remote path doesn't encode the host name or
650
anything but path, so it is only safe to use it in requests sent over
651
the medium from the matching transport.
653
medium_base = urlutils.join(self.base, '/')
654
rel_url = urlutils.relative_url(medium_base, transport.base)
655
return urllib.unquote(rel_url)
658
class SmartClientStreamMedium(SmartClientMedium):
659
"""Stream based medium common class.
661
SmartClientStreamMediums operate on a stream. All subclasses use a common
662
SmartClientStreamMediumRequest for their requests, and should implement
663
_accept_bytes and _read_bytes to allow the request objects to send and
667
def __init__(self, base):
668
SmartClientMedium.__init__(self, base)
669
self._current_request = None
671
def accept_bytes(self, bytes):
672
self._accept_bytes(bytes)
675
"""The SmartClientStreamMedium knows how to close the stream when it is
681
"""Flush the output stream.
683
This method is used by the SmartClientStreamMediumRequest to ensure that
684
all data for a request is sent, to avoid long timeouts or deadlocks.
686
raise NotImplementedError(self._flush)
688
def get_request(self):
689
"""See SmartClientMedium.get_request().
691
SmartClientStreamMedium always returns a SmartClientStreamMediumRequest
694
return SmartClientStreamMediumRequest(self)
697
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
698
"""A client medium using simple pipes.
700
This client does not manage the pipes: it assumes they will always be open.
703
def __init__(self, readable_pipe, writeable_pipe, base):
704
SmartClientStreamMedium.__init__(self, base)
705
self._readable_pipe = readable_pipe
706
self._writeable_pipe = writeable_pipe
708
def _accept_bytes(self, bytes):
709
"""See SmartClientStreamMedium.accept_bytes."""
710
self._writeable_pipe.write(bytes)
711
self._report_activity(len(bytes), 'write')
714
"""See SmartClientStreamMedium._flush()."""
715
self._writeable_pipe.flush()
717
def _read_bytes(self, count):
718
"""See SmartClientStreamMedium._read_bytes."""
719
bytes = self._readable_pipe.read(count)
720
self._report_activity(len(bytes), 'read')
724
class SmartSSHClientMedium(SmartClientStreamMedium):
725
"""A client medium using SSH."""
727
def __init__(self, host, port=None, username=None, password=None,
728
base=None, vendor=None, bzr_remote_path=None):
729
"""Creates a client that will connect on the first use.
731
:param vendor: An optional override for the ssh vendor to use. See
732
bzrlib.transport.ssh for details on ssh vendors.
734
self._connected = False
736
self._password = password
738
self._username = username
739
# SmartClientStreamMedium stores the repr of this object in its
740
# _DebugCounter so we have to store all the values used in our repr
741
# method before calling the super init.
742
SmartClientStreamMedium.__init__(self, base)
743
self._read_from = None
744
self._ssh_connection = None
745
self._vendor = vendor
746
self._write_to = None
747
self._bzr_remote_path = bzr_remote_path
748
# for the benefit of progress making a short description of this
750
self._scheme = 'bzr+ssh'
753
return "%s(connected=%r, username=%r, host=%r, port=%r)" % (
754
self.__class__.__name__,
760
def _accept_bytes(self, bytes):
761
"""See SmartClientStreamMedium.accept_bytes."""
762
self._ensure_connection()
763
self._write_to.write(bytes)
764
self._report_activity(len(bytes), 'write')
766
def disconnect(self):
767
"""See SmartClientMedium.disconnect()."""
768
if not self._connected:
770
self._read_from.close()
771
self._write_to.close()
772
self._ssh_connection.close()
773
self._connected = False
775
def _ensure_connection(self):
776
"""Connect this medium if not already connected."""
779
if self._vendor is None:
780
vendor = ssh._get_ssh_vendor()
782
vendor = self._vendor
783
self._ssh_connection = vendor.connect_ssh(self._username,
784
self._password, self._host, self._port,
785
command=[self._bzr_remote_path, 'serve', '--inet',
786
'--directory=/', '--allow-writes'])
787
self._read_from, self._write_to = \
788
self._ssh_connection.get_filelike_channels()
789
self._connected = True
792
"""See SmartClientStreamMedium._flush()."""
793
self._write_to.flush()
795
def _read_bytes(self, count):
796
"""See SmartClientStreamMedium.read_bytes."""
797
if not self._connected:
798
raise errors.MediumNotConnected(self)
799
bytes_to_read = min(count, _MAX_READ_SIZE)
800
bytes = self._read_from.read(bytes_to_read)
801
self._report_activity(len(bytes), 'read')
805
# Port 4155 is the default port for bzr://, registered with IANA.
806
BZR_DEFAULT_INTERFACE = None
807
BZR_DEFAULT_PORT = 4155
810
class SmartTCPClientMedium(SmartClientStreamMedium):
811
"""A client medium using TCP."""
813
def __init__(self, host, port, base):
814
"""Creates a client that will connect on the first use."""
815
SmartClientStreamMedium.__init__(self, base)
816
self._connected = False
821
def _accept_bytes(self, bytes):
822
"""See SmartClientMedium.accept_bytes."""
823
self._ensure_connection()
824
osutils.send_all(self._socket, bytes, self._report_activity)
826
def disconnect(self):
827
"""See SmartClientMedium.disconnect()."""
828
if not self._connected:
832
self._connected = False
834
def _ensure_connection(self):
835
"""Connect this medium if not already connected."""
838
if self._port is None:
839
port = BZR_DEFAULT_PORT
841
port = int(self._port)
843
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
844
socket.SOCK_STREAM, 0, 0)
845
except socket.gaierror, (err_num, err_msg):
846
raise errors.ConnectionError("failed to lookup %s:%d: %s" %
847
(self._host, port, err_msg))
848
# Initialize err in case there are no addresses returned:
849
err = socket.error("no address found for %s" % self._host)
850
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
852
self._socket = socket.socket(family, socktype, proto)
853
self._socket.setsockopt(socket.IPPROTO_TCP,
854
socket.TCP_NODELAY, 1)
855
self._socket.connect(sockaddr)
856
except socket.error, err:
857
if self._socket is not None:
862
if self._socket is None:
863
# socket errors either have a (string) or (errno, string) as their
865
if type(err.args) is str:
868
err_msg = err.args[1]
869
raise errors.ConnectionError("failed to connect to %s:%d: %s" %
870
(self._host, port, err_msg))
871
self._connected = True
874
"""See SmartClientStreamMedium._flush().
876
For TCP we do no flushing. We may want to turn off TCP_NODELAY and
877
add a means to do a flush, but that can be done in the future.
880
def _read_bytes(self, count):
881
"""See SmartClientMedium.read_bytes."""
882
if not self._connected:
883
raise errors.MediumNotConnected(self)
884
return _read_bytes_from_socket(
885
self._socket.recv, count, self._report_activity)
888
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
889
"""A SmartClientMediumRequest that works with an SmartClientStreamMedium."""
891
def __init__(self, medium):
892
SmartClientMediumRequest.__init__(self, medium)
893
# check that we are safe concurrency wise. If some streams start
894
# allowing concurrent requests - i.e. via multiplexing - then this
895
# assert should be moved to SmartClientStreamMedium.get_request,
896
# and the setting/unsetting of _current_request likewise moved into
897
# that class : but its unneeded overhead for now. RBC 20060922
898
if self._medium._current_request is not None:
899
raise errors.TooManyConcurrentRequests(self._medium)
900
self._medium._current_request = self
902
def _accept_bytes(self, bytes):
903
"""See SmartClientMediumRequest._accept_bytes.
905
This forwards to self._medium._accept_bytes because we are operating
906
on the mediums stream.
908
self._medium._accept_bytes(bytes)
910
def _finished_reading(self):
911
"""See SmartClientMediumRequest._finished_reading.
913
This clears the _current_request on self._medium to allow a new
914
request to be created.
916
if self._medium._current_request is not self:
917
raise AssertionError()
918
self._medium._current_request = None
920
def _finished_writing(self):
921
"""See SmartClientMediumRequest._finished_writing.
923
This invokes self._medium._flush to ensure all bytes are transmitted.
925
self._medium._flush()
928
def _read_bytes_from_socket(sock, desired_count, report_activity):
929
# We ignore the desired_count because on sockets it's more efficient to
930
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
932
bytes = osutils.until_no_eintr(sock, _MAX_READ_SIZE)
933
except socket.error, e:
934
if len(e.args) and e.args[0] in (errno.ECONNRESET, 10054):
935
# The connection was closed by the other side. Callers expect an
936
# empty string to signal end-of-stream.
941
report_activity(len(bytes), 'read')
added
removed
bzrlib/smart/medium.py
