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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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(), """
45
from bzrlib.smart import client, protocol
46
from bzrlib.transport import ssh
50
# We must not read any more than 64k at a time so we don't risk "no buffer
51
# space available" errors on some platforms. Windows in particular is likely
52
# to give error 10053 or 10055 if we read more than 64k from a socket.
53
_MAX_READ_SIZE = 64 * 1024
56
def _get_protocol_factory_for_bytes(bytes):
57
"""Determine the right protocol factory for 'bytes'.
59
This will return an appropriate protocol factory depending on the version
60
of the protocol being used, as determined by inspecting the given bytes.
61
The bytes should have at least one newline byte (i.e. be a whole line),
62
otherwise it's possible that a request will be incorrectly identified as
65
Typical use would be::
67
factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
68
server_protocol = factory(transport, write_func, root_client_path)
69
server_protocol.accept_bytes(unused_bytes)
71
:param bytes: a str of bytes of the start of the request.
72
:returns: 2-tuple of (protocol_factory, unused_bytes). protocol_factory is
73
a callable that takes three args: transport, write_func,
74
root_client_path. unused_bytes are any bytes that were not part of a
75
protocol version marker.
77
if bytes.startswith(protocol.MESSAGE_VERSION_THREE):
78
protocol_factory = protocol.build_server_protocol_three
79
bytes = bytes[len(protocol.MESSAGE_VERSION_THREE):]
80
elif bytes.startswith(protocol.REQUEST_VERSION_TWO):
81
protocol_factory = protocol.SmartServerRequestProtocolTwo
82
bytes = bytes[len(protocol.REQUEST_VERSION_TWO):]
84
protocol_factory = protocol.SmartServerRequestProtocolOne
85
return protocol_factory, bytes
88
def _get_line(read_bytes_func):
89
"""Read bytes using read_bytes_func until a newline byte.
91
This isn't particularly efficient, so should only be used when the
92
expected size of the line is quite short.
94
:returns: a tuple of two strs: (line, excess)
98
while newline_pos == -1:
99
new_bytes = read_bytes_func(1)
102
# Ran out of bytes before receiving a complete line.
104
newline_pos = bytes.find('\n')
105
line = bytes[:newline_pos+1]
106
excess = bytes[newline_pos+1:]
110
class SmartMedium(object):
111
"""Base class for smart protocol media, both client- and server-side."""
114
self._push_back_buffer = None
116
def _push_back(self, bytes):
117
"""Return unused bytes to the medium, because they belong to the next
120
This sets the _push_back_buffer to the given bytes.
122
if self._push_back_buffer is not None:
123
raise AssertionError(
124
"_push_back called when self._push_back_buffer is %r"
125
% (self._push_back_buffer,))
128
self._push_back_buffer = bytes
130
def _get_push_back_buffer(self):
131
if self._push_back_buffer == '':
132
raise AssertionError(
133
'%s._push_back_buffer should never be the empty string, '
134
'which can be confused with EOF' % (self,))
135
bytes = self._push_back_buffer
136
self._push_back_buffer = None
139
def read_bytes(self, desired_count):
140
"""Read some bytes from this medium.
142
:returns: some bytes, possibly more or less than the number requested
143
in 'desired_count' depending on the medium.
145
if self._push_back_buffer is not None:
146
return self._get_push_back_buffer()
147
bytes_to_read = min(desired_count, _MAX_READ_SIZE)
148
return self._read_bytes(bytes_to_read)
150
def _read_bytes(self, count):
151
raise NotImplementedError(self._read_bytes)
154
"""Read bytes from this request's response until a newline byte.
156
This isn't particularly efficient, so should only be used when the
157
expected size of the line is quite short.
159
:returns: a string of bytes ending in a newline (byte 0x0A).
161
line, excess = _get_line(self.read_bytes)
162
self._push_back(excess)
166
class SmartServerStreamMedium(SmartMedium):
167
"""Handles smart commands coming over a stream.
169
The stream may be a pipe connected to sshd, or a tcp socket, or an
170
in-process fifo for testing.
172
One instance is created for each connected client; it can serve multiple
173
requests in the lifetime of the connection.
175
The server passes requests through to an underlying backing transport,
176
which will typically be a LocalTransport looking at the server's filesystem.
178
:ivar _push_back_buffer: a str of bytes that have been read from the stream
179
but not used yet, or None if there are no buffered bytes. Subclasses
180
should make sure to exhaust this buffer before reading more bytes from
181
the stream. See also the _push_back method.
184
def __init__(self, backing_transport, root_client_path='/'):
185
"""Construct new server.
187
:param backing_transport: Transport for the directory served.
189
# backing_transport could be passed to serve instead of __init__
190
self.backing_transport = backing_transport
191
self.root_client_path = root_client_path
192
self.finished = False
193
SmartMedium.__init__(self)
196
"""Serve requests until the client disconnects."""
197
# Keep a reference to stderr because the sys module's globals get set to
198
# None during interpreter shutdown.
199
from sys import stderr
201
while not self.finished:
202
server_protocol = self._build_protocol()
203
self._serve_one_request(server_protocol)
205
stderr.write("%s terminating on exception %s\n" % (self, e))
208
def _build_protocol(self):
209
"""Identifies the version of the incoming request, and returns an
210
a protocol object that can interpret it.
212
If more bytes than the version prefix of the request are read, they will
213
be fed into the protocol before it is returned.
215
:returns: a SmartServerRequestProtocol.
217
bytes = self._get_line()
218
protocol_factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
219
protocol = protocol_factory(
220
self.backing_transport, self._write_out, self.root_client_path)
221
protocol.accept_bytes(unused_bytes)
224
def _serve_one_request(self, protocol):
225
"""Read one request from input, process, send back a response.
227
:param protocol: a SmartServerRequestProtocol.
230
self._serve_one_request_unguarded(protocol)
231
except KeyboardInterrupt:
234
self.terminate_due_to_error()
236
def terminate_due_to_error(self):
237
"""Called when an unhandled exception from the protocol occurs."""
238
raise NotImplementedError(self.terminate_due_to_error)
240
def _read_bytes(self, desired_count):
241
"""Get some bytes from the medium.
243
:param desired_count: number of bytes we want to read.
245
raise NotImplementedError(self._read_bytes)
248
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
250
def __init__(self, sock, backing_transport, root_client_path='/'):
253
:param sock: the socket the server will read from. It will be put
256
SmartServerStreamMedium.__init__(
257
self, backing_transport, root_client_path=root_client_path)
258
sock.setblocking(True)
261
def _serve_one_request_unguarded(self, protocol):
262
while protocol.next_read_size():
263
# We can safely try to read large chunks. If there is less data
264
# than _MAX_READ_SIZE ready, the socket wil just return a short
265
# read immediately rather than block.
266
bytes = self.read_bytes(_MAX_READ_SIZE)
270
protocol.accept_bytes(bytes)
272
self._push_back(protocol.unused_data)
274
def _read_bytes(self, desired_count):
275
# We ignore the desired_count because on sockets it's more efficient to
276
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
277
return osutils.until_no_eintr(self.socket.recv, _MAX_READ_SIZE)
279
def terminate_due_to_error(self):
280
# TODO: This should log to a server log file, but no such thing
281
# exists yet. Andrew Bennetts 2006-09-29.
285
def _write_out(self, bytes):
286
osutils.send_all(self.socket, bytes)
289
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
291
def __init__(self, in_file, out_file, backing_transport):
292
"""Construct new server.
294
:param in_file: Python file from which requests can be read.
295
:param out_file: Python file to write responses.
296
:param backing_transport: Transport for the directory served.
298
SmartServerStreamMedium.__init__(self, backing_transport)
299
if sys.platform == 'win32':
300
# force binary mode for files
302
for f in (in_file, out_file):
303
fileno = getattr(f, 'fileno', None)
305
msvcrt.setmode(fileno(), os.O_BINARY)
309
def _serve_one_request_unguarded(self, protocol):
311
# We need to be careful not to read past the end of the current
312
# request, or else the read from the pipe will block, so we use
313
# protocol.next_read_size().
314
bytes_to_read = protocol.next_read_size()
315
if bytes_to_read == 0:
316
# Finished serving this request.
319
bytes = self.read_bytes(bytes_to_read)
321
# Connection has been closed.
325
protocol.accept_bytes(bytes)
327
def _read_bytes(self, desired_count):
328
return self._in.read(desired_count)
330
def terminate_due_to_error(self):
331
# TODO: This should log to a server log file, but no such thing
332
# exists yet. Andrew Bennetts 2006-09-29.
336
def _write_out(self, bytes):
337
self._out.write(bytes)
340
class SmartClientMediumRequest(object):
341
"""A request on a SmartClientMedium.
343
Each request allows bytes to be provided to it via accept_bytes, and then
344
the response bytes to be read via read_bytes.
347
request.accept_bytes('123')
348
request.finished_writing()
349
result = request.read_bytes(3)
350
request.finished_reading()
352
It is up to the individual SmartClientMedium whether multiple concurrent
353
requests can exist. See SmartClientMedium.get_request to obtain instances
354
of SmartClientMediumRequest, and the concrete Medium you are using for
355
details on concurrency and pipelining.
358
def __init__(self, medium):
359
"""Construct a SmartClientMediumRequest for the medium medium."""
360
self._medium = medium
361
# we track state by constants - we may want to use the same
362
# pattern as BodyReader if it gets more complex.
363
# valid states are: "writing", "reading", "done"
364
self._state = "writing"
366
def accept_bytes(self, bytes):
367
"""Accept bytes for inclusion in this request.
369
This method may not be be called after finished_writing() has been
370
called. It depends upon the Medium whether or not the bytes will be
371
immediately transmitted. Message based Mediums will tend to buffer the
372
bytes until finished_writing() is called.
374
:param bytes: A bytestring.
376
if self._state != "writing":
377
raise errors.WritingCompleted(self)
378
self._accept_bytes(bytes)
380
def _accept_bytes(self, bytes):
381
"""Helper for accept_bytes.
383
Accept_bytes checks the state of the request to determing if bytes
384
should be accepted. After that it hands off to _accept_bytes to do the
387
raise NotImplementedError(self._accept_bytes)
389
def finished_reading(self):
390
"""Inform the request that all desired data has been read.
392
This will remove the request from the pipeline for its medium (if the
393
medium supports pipelining) and any further calls to methods on the
394
request will raise ReadingCompleted.
396
if self._state == "writing":
397
raise errors.WritingNotComplete(self)
398
if self._state != "reading":
399
raise errors.ReadingCompleted(self)
401
self._finished_reading()
403
def _finished_reading(self):
404
"""Helper for finished_reading.
406
finished_reading checks the state of the request to determine if
407
finished_reading is allowed, and if it is hands off to _finished_reading
408
to perform the action.
410
raise NotImplementedError(self._finished_reading)
412
def finished_writing(self):
413
"""Finish the writing phase of this request.
415
This will flush all pending data for this request along the medium.
416
After calling finished_writing, you may not call accept_bytes anymore.
418
if self._state != "writing":
419
raise errors.WritingCompleted(self)
420
self._state = "reading"
421
self._finished_writing()
423
def _finished_writing(self):
424
"""Helper for finished_writing.
426
finished_writing checks the state of the request to determine if
427
finished_writing is allowed, and if it is hands off to _finished_writing
428
to perform the action.
430
raise NotImplementedError(self._finished_writing)
432
def read_bytes(self, count):
433
"""Read bytes from this requests response.
435
This method will block and wait for count bytes to be read. It may not
436
be invoked until finished_writing() has been called - this is to ensure
437
a message-based approach to requests, for compatibility with message
438
based mediums like HTTP.
440
if self._state == "writing":
441
raise errors.WritingNotComplete(self)
442
if self._state != "reading":
443
raise errors.ReadingCompleted(self)
444
return self._read_bytes(count)
446
def _read_bytes(self, count):
447
"""Helper for SmartClientMediumRequest.read_bytes.
449
read_bytes checks the state of the request to determing if bytes
450
should be read. After that it hands off to _read_bytes to do the
453
By default this forwards to self._medium.read_bytes because we are
454
operating on the medium's stream.
456
return self._medium.read_bytes(count)
459
line = self._read_line()
460
if not line.endswith('\n'):
461
# end of file encountered reading from server
462
raise errors.ConnectionReset(
463
"please check connectivity and permissions",
464
"(and try -Dhpss if further diagnosis is required)")
467
def _read_line(self):
468
"""Helper for SmartClientMediumRequest.read_line.
470
By default this forwards to self._medium._get_line because we are
471
operating on the medium's stream.
473
return self._medium._get_line()
476
class _DebugCounter(object):
477
"""An object that counts the HPSS calls made to each client medium.
479
When a medium is garbage-collected, or failing that when atexit functions
480
are run, the total number of calls made on that medium are reported via
485
self.counts = weakref.WeakKeyDictionary()
486
client._SmartClient.hooks.install_named_hook(
487
'call', self.increment_call_count, 'hpss call counter')
488
atexit.register(self.flush_all)
490
def track(self, medium):
491
"""Start tracking calls made to a medium.
493
This only keeps a weakref to the medium, so shouldn't affect the
496
medium_repr = repr(medium)
497
# Add this medium to the WeakKeyDictionary
498
self.counts[medium] = [0, medium_repr]
499
# Weakref callbacks are fired in reverse order of their association
500
# with the referenced object. So we add a weakref *after* adding to
501
# the WeakKeyDict so that we can report the value from it before the
502
# entry is removed by the WeakKeyDict's own callback.
503
ref = weakref.ref(medium, self.done)
505
def increment_call_count(self, params):
506
# Increment the count in the WeakKeyDictionary
507
value = self.counts[params.medium]
511
value = self.counts[ref]
512
count, medium_repr = value
513
# In case this callback is invoked for the same ref twice (by the
514
# weakref callback and by the atexit function), set the call count back
515
# to 0 so this item won't be reported twice.
518
trace.note('HPSS calls: %d %s', count, medium_repr)
521
for ref in list(self.counts.keys()):
524
_debug_counter = None
527
class SmartClientMedium(SmartMedium):
528
"""Smart client is a medium for sending smart protocol requests over."""
530
def __init__(self, base):
531
super(SmartClientMedium, self).__init__()
533
self._protocol_version_error = None
534
self._protocol_version = None
535
self._done_hello = False
536
# Be optimistic: we assume the remote end can accept new remote
537
# requests until we get an error saying otherwise.
538
# _remote_version_is_before tracks the bzr version the remote side
539
# can be based on what we've seen so far.
540
self._remote_version_is_before = None
541
# Install debug hook function if debug flag is set.
542
if 'hpss' in debug.debug_flags:
543
global _debug_counter
544
if _debug_counter is None:
545
_debug_counter = _DebugCounter()
546
_debug_counter.track(self)
548
def _is_remote_before(self, version_tuple):
549
"""Is it possible the remote side supports RPCs for a given version?
553
needed_version = (1, 2)
554
if medium._is_remote_before(needed_version):
555
fallback_to_pre_1_2_rpc()
559
except UnknownSmartMethod:
560
medium._remember_remote_is_before(needed_version)
561
fallback_to_pre_1_2_rpc()
563
:seealso: _remember_remote_is_before
565
if self._remote_version_is_before is None:
566
# So far, the remote side seems to support everything
568
return version_tuple >= self._remote_version_is_before
570
def _remember_remote_is_before(self, version_tuple):
571
"""Tell this medium that the remote side is older the given version.
573
:seealso: _is_remote_before
575
if (self._remote_version_is_before is not None and
576
version_tuple > self._remote_version_is_before):
577
# We have been told that the remote side is older than some version
578
# which is newer than a previously supplied older-than version.
579
# This indicates that some smart verb call is not guarded
580
# appropriately (it should simply not have been tried).
581
raise AssertionError(
582
"_remember_remote_is_before(%r) called, but "
583
"_remember_remote_is_before(%r) was called previously."
584
% (version_tuple, self._remote_version_is_before))
585
self._remote_version_is_before = version_tuple
587
def protocol_version(self):
588
"""Find out if 'hello' smart request works."""
589
if self._protocol_version_error is not None:
590
raise self._protocol_version_error
591
if not self._done_hello:
593
medium_request = self.get_request()
594
# Send a 'hello' request in protocol version one, for maximum
595
# backwards compatibility.
596
client_protocol = protocol.SmartClientRequestProtocolOne(medium_request)
597
client_protocol.query_version()
598
self._done_hello = True
599
except errors.SmartProtocolError, e:
600
# Cache the error, just like we would cache a successful
602
self._protocol_version_error = e
606
def should_probe(self):
607
"""Should RemoteBzrDirFormat.probe_transport send a smart request on
610
Some transports are unambiguously smart-only; there's no need to check
611
if the transport is able to carry smart requests, because that's all
612
it is for. In those cases, this method should return False.
614
But some HTTP transports can sometimes fail to carry smart requests,
615
but still be usuable for accessing remote bzrdirs via plain file
616
accesses. So for those transports, their media should return True here
617
so that RemoteBzrDirFormat can determine if it is appropriate for that
622
def disconnect(self):
623
"""If this medium maintains a persistent connection, close it.
625
The default implementation does nothing.
628
def remote_path_from_transport(self, transport):
629
"""Convert transport into a path suitable for using in a request.
631
Note that the resulting remote path doesn't encode the host name or
632
anything but path, so it is only safe to use it in requests sent over
633
the medium from the matching transport.
635
medium_base = urlutils.join(self.base, '/')
636
rel_url = urlutils.relative_url(medium_base, transport.base)
637
return urllib.unquote(rel_url)
640
class SmartClientStreamMedium(SmartClientMedium):
641
"""Stream based medium common class.
643
SmartClientStreamMediums operate on a stream. All subclasses use a common
644
SmartClientStreamMediumRequest for their requests, and should implement
645
_accept_bytes and _read_bytes to allow the request objects to send and
649
def __init__(self, base):
650
SmartClientMedium.__init__(self, base)
651
self._current_request = None
653
def accept_bytes(self, bytes):
654
self._accept_bytes(bytes)
657
"""The SmartClientStreamMedium knows how to close the stream when it is
663
"""Flush the output stream.
665
This method is used by the SmartClientStreamMediumRequest to ensure that
666
all data for a request is sent, to avoid long timeouts or deadlocks.
668
raise NotImplementedError(self._flush)
670
def get_request(self):
671
"""See SmartClientMedium.get_request().
673
SmartClientStreamMedium always returns a SmartClientStreamMediumRequest
676
return SmartClientStreamMediumRequest(self)
679
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
680
"""A client medium using simple pipes.
682
This client does not manage the pipes: it assumes they will always be open.
685
def __init__(self, readable_pipe, writeable_pipe, base):
686
SmartClientStreamMedium.__init__(self, base)
687
self._readable_pipe = readable_pipe
688
self._writeable_pipe = writeable_pipe
690
def _accept_bytes(self, bytes):
691
"""See SmartClientStreamMedium.accept_bytes."""
692
self._writeable_pipe.write(bytes)
695
"""See SmartClientStreamMedium._flush()."""
696
self._writeable_pipe.flush()
698
def _read_bytes(self, count):
699
"""See SmartClientStreamMedium._read_bytes."""
700
return self._readable_pipe.read(count)
703
class SmartSSHClientMedium(SmartClientStreamMedium):
704
"""A client medium using SSH."""
706
def __init__(self, host, port=None, username=None, password=None,
707
base=None, vendor=None, bzr_remote_path=None):
708
"""Creates a client that will connect on the first use.
710
:param vendor: An optional override for the ssh vendor to use. See
711
bzrlib.transport.ssh for details on ssh vendors.
713
SmartClientStreamMedium.__init__(self, base)
714
self._connected = False
716
self._password = password
718
self._username = username
719
self._read_from = None
720
self._ssh_connection = None
721
self._vendor = vendor
722
self._write_to = None
723
self._bzr_remote_path = bzr_remote_path
724
if self._bzr_remote_path is None:
725
symbol_versioning.warn(
726
'bzr_remote_path is required as of bzr 0.92',
727
DeprecationWarning, stacklevel=2)
728
self._bzr_remote_path = os.environ.get('BZR_REMOTE_PATH', 'bzr')
730
def _accept_bytes(self, bytes):
731
"""See SmartClientStreamMedium.accept_bytes."""
732
self._ensure_connection()
733
self._write_to.write(bytes)
735
def disconnect(self):
736
"""See SmartClientMedium.disconnect()."""
737
if not self._connected:
739
self._read_from.close()
740
self._write_to.close()
741
self._ssh_connection.close()
742
self._connected = False
744
def _ensure_connection(self):
745
"""Connect this medium if not already connected."""
748
if self._vendor is None:
749
vendor = ssh._get_ssh_vendor()
751
vendor = self._vendor
752
self._ssh_connection = vendor.connect_ssh(self._username,
753
self._password, self._host, self._port,
754
command=[self._bzr_remote_path, 'serve', '--inet',
755
'--directory=/', '--allow-writes'])
756
self._read_from, self._write_to = \
757
self._ssh_connection.get_filelike_channels()
758
self._connected = True
761
"""See SmartClientStreamMedium._flush()."""
762
self._write_to.flush()
764
def _read_bytes(self, count):
765
"""See SmartClientStreamMedium.read_bytes."""
766
if not self._connected:
767
raise errors.MediumNotConnected(self)
768
bytes_to_read = min(count, _MAX_READ_SIZE)
769
return self._read_from.read(bytes_to_read)
772
# Port 4155 is the default port for bzr://, registered with IANA.
773
BZR_DEFAULT_INTERFACE = None
774
BZR_DEFAULT_PORT = 4155
777
class SmartTCPClientMedium(SmartClientStreamMedium):
778
"""A client medium using TCP."""
780
def __init__(self, host, port, base):
781
"""Creates a client that will connect on the first use."""
782
SmartClientStreamMedium.__init__(self, base)
783
self._connected = False
788
def _accept_bytes(self, bytes):
789
"""See SmartClientMedium.accept_bytes."""
790
self._ensure_connection()
791
osutils.send_all(self._socket, bytes)
793
def disconnect(self):
794
"""See SmartClientMedium.disconnect()."""
795
if not self._connected:
799
self._connected = False
801
def _ensure_connection(self):
802
"""Connect this medium if not already connected."""
805
if self._port is None:
806
port = BZR_DEFAULT_PORT
808
port = int(self._port)
810
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
811
socket.SOCK_STREAM, 0, 0)
812
except socket.gaierror, (err_num, err_msg):
813
raise errors.ConnectionError("failed to lookup %s:%d: %s" %
814
(self._host, port, err_msg))
815
# Initialize err in case there are no addresses returned:
816
err = socket.error("no address found for %s" % self._host)
817
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
819
self._socket = socket.socket(family, socktype, proto)
820
self._socket.setsockopt(socket.IPPROTO_TCP,
821
socket.TCP_NODELAY, 1)
822
self._socket.connect(sockaddr)
823
except socket.error, err:
824
if self._socket is not None:
829
if self._socket is None:
830
# socket errors either have a (string) or (errno, string) as their
832
if type(err.args) is str:
835
err_msg = err.args[1]
836
raise errors.ConnectionError("failed to connect to %s:%d: %s" %
837
(self._host, port, err_msg))
838
self._connected = True
841
"""See SmartClientStreamMedium._flush().
843
For TCP we do no flushing. We may want to turn off TCP_NODELAY and
844
add a means to do a flush, but that can be done in the future.
847
def _read_bytes(self, count):
848
"""See SmartClientMedium.read_bytes."""
849
if not self._connected:
850
raise errors.MediumNotConnected(self)
851
# We ignore the desired_count because on sockets it's more efficient to
852
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
854
return self._socket.recv(_MAX_READ_SIZE)
855
except socket.error, e:
856
if len(e.args) and e.args[0] == errno.ECONNRESET:
857
# Callers expect an empty string in that case
863
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
864
"""A SmartClientMediumRequest that works with an SmartClientStreamMedium."""
866
def __init__(self, medium):
867
SmartClientMediumRequest.__init__(self, medium)
868
# check that we are safe concurrency wise. If some streams start
869
# allowing concurrent requests - i.e. via multiplexing - then this
870
# assert should be moved to SmartClientStreamMedium.get_request,
871
# and the setting/unsetting of _current_request likewise moved into
872
# that class : but its unneeded overhead for now. RBC 20060922
873
if self._medium._current_request is not None:
874
raise errors.TooManyConcurrentRequests(self._medium)
875
self._medium._current_request = self
877
def _accept_bytes(self, bytes):
878
"""See SmartClientMediumRequest._accept_bytes.
880
This forwards to self._medium._accept_bytes because we are operating
881
on the mediums stream.
883
self._medium._accept_bytes(bytes)
885
def _finished_reading(self):
886
"""See SmartClientMediumRequest._finished_reading.
888
This clears the _current_request on self._medium to allow a new
889
request to be created.
891
if self._medium._current_request is not self:
892
raise AssertionError()
893
self._medium._current_request = None
895
def _finished_writing(self):
896
"""See SmartClientMediumRequest._finished_writing.
898
This invokes self._medium._flush to ensure all bytes are transmitted.
900
self._medium._flush()
added
removed
bzrlib/smart/medium.py
