~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/medium.py

Implement version 3 of the network protocol. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2011 Canonical Ltd
 
1
# Copyright (C) 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""The 'medium' layer for the smart servers and clients.
18
18
 
24
24
bzrlib/transport/smart/__init__.py.
25
25
"""
26
26
 
27
 
from __future__ import absolute_import
28
 
 
29
 
import errno
30
27
import os
 
28
import socket
31
29
import sys
32
 
import time
33
 
 
34
 
import bzrlib
35
 
from bzrlib.lazy_import import lazy_import
36
 
lazy_import(globals(), """
37
 
import select
38
 
import socket
39
 
import thread
40
 
import weakref
41
30
 
42
31
from bzrlib import (
43
 
    debug,
44
32
    errors,
45
 
    trace,
46
 
    transport,
47
 
    ui,
48
 
    urlutils,
49
 
    )
50
 
from bzrlib.i18n import gettext
51
 
from bzrlib.smart import client, protocol, request, signals, vfs
 
33
    osutils,
 
34
    symbol_versioning,
 
35
    )
 
36
from bzrlib.smart.protocol import (
 
37
    MESSAGE_VERSION_THREE,
 
38
    REQUEST_VERSION_TWO,
 
39
    SmartClientRequestProtocolOne,
 
40
    SmartServerRequestProtocolOne,
 
41
    SmartServerRequestProtocolTwo,
 
42
    build_server_protocol_three
 
43
    )
52
44
from bzrlib.transport import ssh
53
 
""")
54
 
from bzrlib import osutils
55
45
 
56
 
# Throughout this module buffer size parameters are either limited to be at
57
 
# most _MAX_READ_SIZE, or are ignored and _MAX_READ_SIZE is used instead.
58
 
# For this module's purposes, MAX_SOCKET_CHUNK is a reasonable size for reads
59
 
# from non-sockets as well.
60
 
_MAX_READ_SIZE = osutils.MAX_SOCKET_CHUNK
61
46
 
62
47
def _get_protocol_factory_for_bytes(bytes):
63
48
    """Determine the right protocol factory for 'bytes'.
80
65
        root_client_path.  unused_bytes are any bytes that were not part of a
81
66
        protocol version marker.
82
67
    """
83
 
    if bytes.startswith(protocol.MESSAGE_VERSION_THREE):
84
 
        protocol_factory = protocol.build_server_protocol_three
85
 
        bytes = bytes[len(protocol.MESSAGE_VERSION_THREE):]
86
 
    elif bytes.startswith(protocol.REQUEST_VERSION_TWO):
87
 
        protocol_factory = protocol.SmartServerRequestProtocolTwo
88
 
        bytes = bytes[len(protocol.REQUEST_VERSION_TWO):]
 
68
    if bytes.startswith(MESSAGE_VERSION_THREE):
 
69
        protocol_factory = build_server_protocol_three
 
70
        bytes = bytes[len(MESSAGE_VERSION_THREE):]
 
71
    elif bytes.startswith(REQUEST_VERSION_TWO):
 
72
        protocol_factory = SmartServerRequestProtocolTwo
 
73
        bytes = bytes[len(REQUEST_VERSION_TWO):]
89
74
    else:
90
 
        protocol_factory = protocol.SmartServerRequestProtocolOne
 
75
        protocol_factory = SmartServerRequestProtocolOne
91
76
    return protocol_factory, bytes
92
77
 
93
78
 
94
 
def _get_line(read_bytes_func):
95
 
    """Read bytes using read_bytes_func until a newline byte.
96
 
 
97
 
    This isn't particularly efficient, so should only be used when the
98
 
    expected size of the line is quite short.
99
 
 
100
 
    :returns: a tuple of two strs: (line, excess)
101
 
    """
102
 
    newline_pos = -1
103
 
    bytes = ''
104
 
    while newline_pos == -1:
105
 
        new_bytes = read_bytes_func(1)
106
 
        bytes += new_bytes
107
 
        if new_bytes == '':
108
 
            # Ran out of bytes before receiving a complete line.
109
 
            return bytes, ''
110
 
        newline_pos = bytes.find('\n')
111
 
    line = bytes[:newline_pos+1]
112
 
    excess = bytes[newline_pos+1:]
113
 
    return line, excess
114
 
 
115
 
 
116
 
class SmartMedium(object):
117
 
    """Base class for smart protocol media, both client- and server-side."""
118
 
 
119
 
    def __init__(self):
120
 
        self._push_back_buffer = None
121
 
 
122
 
    def _push_back(self, bytes):
123
 
        """Return unused bytes to the medium, because they belong to the next
124
 
        request(s).
125
 
 
126
 
        This sets the _push_back_buffer to the given bytes.
127
 
        """
128
 
        if self._push_back_buffer is not None:
129
 
            raise AssertionError(
130
 
                "_push_back called when self._push_back_buffer is %r"
131
 
                % (self._push_back_buffer,))
132
 
        if bytes == '':
133
 
            return
134
 
        self._push_back_buffer = bytes
135
 
 
136
 
    def _get_push_back_buffer(self):
137
 
        if self._push_back_buffer == '':
138
 
            raise AssertionError(
139
 
                '%s._push_back_buffer should never be the empty string, '
140
 
                'which can be confused with EOF' % (self,))
141
 
        bytes = self._push_back_buffer
142
 
        self._push_back_buffer = None
143
 
        return bytes
144
 
 
145
 
    def read_bytes(self, desired_count):
146
 
        """Read some bytes from this medium.
147
 
 
148
 
        :returns: some bytes, possibly more or less than the number requested
149
 
            in 'desired_count' depending on the medium.
150
 
        """
151
 
        if self._push_back_buffer is not None:
152
 
            return self._get_push_back_buffer()
153
 
        bytes_to_read = min(desired_count, _MAX_READ_SIZE)
154
 
        return self._read_bytes(bytes_to_read)
155
 
 
156
 
    def _read_bytes(self, count):
157
 
        raise NotImplementedError(self._read_bytes)
158
 
 
159
 
    def _get_line(self):
160
 
        """Read bytes from this request's response until a newline byte.
161
 
 
162
 
        This isn't particularly efficient, so should only be used when the
163
 
        expected size of the line is quite short.
164
 
 
165
 
        :returns: a string of bytes ending in a newline (byte 0x0A).
166
 
        """
167
 
        line, excess = _get_line(self.read_bytes)
168
 
        self._push_back(excess)
169
 
        return line
170
 
 
171
 
    def _report_activity(self, bytes, direction):
172
 
        """Notify that this medium has activity.
173
 
 
174
 
        Implementations should call this from all methods that actually do IO.
175
 
        Be careful that it's not called twice, if one method is implemented on
176
 
        top of another.
177
 
 
178
 
        :param bytes: Number of bytes read or written.
179
 
        :param direction: 'read' or 'write' or None.
180
 
        """
181
 
        ui.ui_factory.report_transport_activity(self, bytes, direction)
182
 
 
183
 
 
184
 
_bad_file_descriptor = (errno.EBADF,)
185
 
if sys.platform == 'win32':
186
 
    # Given on Windows if you pass a closed socket to select.select. Probably
187
 
    # also given if you pass a file handle to select.
188
 
    WSAENOTSOCK = 10038
189
 
    _bad_file_descriptor += (WSAENOTSOCK,)
190
 
 
191
 
 
192
 
class SmartServerStreamMedium(SmartMedium):
 
79
class SmartServerStreamMedium(object):
193
80
    """Handles smart commands coming over a stream.
194
81
 
195
82
    The stream may be a pipe connected to sshd, or a tcp socket, or an
198
85
    One instance is created for each connected client; it can serve multiple
199
86
    requests in the lifetime of the connection.
200
87
 
201
 
    The server passes requests through to an underlying backing transport,
 
88
    The server passes requests through to an underlying backing transport, 
202
89
    which will typically be a LocalTransport looking at the server's filesystem.
203
90
 
204
91
    :ivar _push_back_buffer: a str of bytes that have been read from the stream
207
94
        the stream.  See also the _push_back method.
208
95
    """
209
96
 
210
 
    _timer = time.time
211
 
 
212
 
    def __init__(self, backing_transport, root_client_path='/', timeout=None):
 
97
    def __init__(self, backing_transport, root_client_path='/'):
213
98
        """Construct new server.
214
99
 
215
100
        :param backing_transport: Transport for the directory served.
218
103
        self.backing_transport = backing_transport
219
104
        self.root_client_path = root_client_path
220
105
        self.finished = False
221
 
        if timeout is None:
222
 
            raise AssertionError('You must supply a timeout.')
223
 
        self._client_timeout = timeout
224
 
        self._client_poll_timeout = min(timeout / 10.0, 1.0)
225
 
        SmartMedium.__init__(self)
 
106
        self._push_back_buffer = None
 
107
 
 
108
    def _push_back(self, bytes):
 
109
        """Return unused bytes to the medium, because they belong to the next
 
110
        request(s).
 
111
 
 
112
        This sets the _push_back_buffer to the given bytes.
 
113
        """
 
114
        if self._push_back_buffer is not None:
 
115
            raise AssertionError(
 
116
                "_push_back called when self._push_back_buffer is %r"
 
117
                % (self._push_back_buffer,))
 
118
        if bytes == '':
 
119
            return
 
120
        self._push_back_buffer = bytes
 
121
 
 
122
    def _get_push_back_buffer(self):
 
123
        if self._push_back_buffer == '':
 
124
            raise AssertionError(
 
125
                '%s._push_back_buffer should never be the empty string, '
 
126
                'which can be confused with EOF' % (self,))
 
127
        bytes = self._push_back_buffer
 
128
        self._push_back_buffer = None
 
129
        return bytes
226
130
 
227
131
    def serve(self):
228
132
        """Serve requests until the client disconnects."""
233
137
            while not self.finished:
234
138
                server_protocol = self._build_protocol()
235
139
                self._serve_one_request(server_protocol)
236
 
        except errors.ConnectionTimeout, e:
237
 
            trace.note('%s' % (e,))
238
 
            trace.log_exception_quietly()
239
 
            self._disconnect_client()
240
 
            # We reported it, no reason to make a big fuss.
241
 
            return
242
140
        except Exception, e:
243
141
            stderr.write("%s terminating on exception %s\n" % (self, e))
244
142
            raise
245
 
        self._disconnect_client()
246
 
 
247
 
    def _stop_gracefully(self):
248
 
        """When we finish this message, stop looking for more."""
249
 
        trace.mutter('Stopping %s' % (self,))
250
 
        self.finished = True
251
 
 
252
 
    def _disconnect_client(self):
253
 
        """Close the current connection. We stopped due to a timeout/etc."""
254
 
        # The default implementation is a no-op, because that is all we used to
255
 
        # do when disconnecting from a client. I suppose we never had the
256
 
        # *server* initiate a disconnect, before
257
 
 
258
 
    def _wait_for_bytes_with_timeout(self, timeout_seconds):
259
 
        """Wait for more bytes to be read, but timeout if none available.
260
 
 
261
 
        This allows us to detect idle connections, and stop trying to read from
262
 
        them, without setting the socket itself to non-blocking. This also
263
 
        allows us to specify when we watch for idle timeouts.
264
 
 
265
 
        :return: Did we timeout? (True if we timed out, False if there is data
266
 
            to be read)
267
 
        """
268
 
        raise NotImplementedError(self._wait_for_bytes_with_timeout)
269
143
 
270
144
    def _build_protocol(self):
271
145
        """Identifies the version of the incoming request, and returns an
276
150
 
277
151
        :returns: a SmartServerRequestProtocol.
278
152
        """
279
 
        self._wait_for_bytes_with_timeout(self._client_timeout)
280
 
        if self.finished:
281
 
            # We're stopping, so don't try to do any more work
282
 
            return None
283
153
        bytes = self._get_line()
284
154
        protocol_factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
285
155
        protocol = protocol_factory(
287
157
        protocol.accept_bytes(unused_bytes)
288
158
        return protocol
289
159
 
290
 
    def _wait_on_descriptor(self, fd, timeout_seconds):
291
 
        """select() on a file descriptor, waiting for nonblocking read()
292
 
 
293
 
        This will raise a ConnectionTimeout exception if we do not get a
294
 
        readable handle before timeout_seconds.
295
 
        :return: None
296
 
        """
297
 
        t_end = self._timer() + timeout_seconds
298
 
        poll_timeout = min(timeout_seconds, self._client_poll_timeout)
299
 
        rs = xs = None
300
 
        while not rs and not xs and self._timer() < t_end:
301
 
            if self.finished:
302
 
                return
303
 
            try:
304
 
                rs, _, xs = select.select([fd], [], [fd], poll_timeout)
305
 
            except (select.error, socket.error) as e:
306
 
                err = getattr(e, 'errno', None)
307
 
                if err is None and getattr(e, 'args', None) is not None:
308
 
                    # select.error doesn't have 'errno', it just has args[0]
309
 
                    err = e.args[0]
310
 
                if err in _bad_file_descriptor:
311
 
                    return # Not a socket indicates read() will fail
312
 
                elif err == errno.EINTR:
313
 
                    # Interrupted, keep looping.
314
 
                    continue
315
 
                raise
316
 
        if rs or xs:
317
 
            return
318
 
        raise errors.ConnectionTimeout('disconnecting client after %.1f seconds'
319
 
                                       % (timeout_seconds,))
320
 
 
321
160
    def _serve_one_request(self, protocol):
322
161
        """Read one request from input, process, send back a response.
323
 
 
 
162
        
324
163
        :param protocol: a SmartServerRequestProtocol.
325
164
        """
326
 
        if protocol is None:
327
 
            return
328
165
        try:
329
166
            self._serve_one_request_unguarded(protocol)
330
167
        except KeyboardInterrupt:
336
173
        """Called when an unhandled exception from the protocol occurs."""
337
174
        raise NotImplementedError(self.terminate_due_to_error)
338
175
 
339
 
    def _read_bytes(self, desired_count):
 
176
    def _get_bytes(self, desired_count):
340
177
        """Get some bytes from the medium.
341
178
 
342
179
        :param desired_count: number of bytes we want to read.
343
180
        """
344
 
        raise NotImplementedError(self._read_bytes)
345
 
 
 
181
        raise NotImplementedError(self._get_bytes)
 
182
 
 
183
    def _get_line(self):
 
184
        """Read bytes from this request's response until a newline byte.
 
185
        
 
186
        This isn't particularly efficient, so should only be used when the
 
187
        expected size of the line is quite short.
 
188
 
 
189
        :returns: a string of bytes ending in a newline (byte 0x0A).
 
190
        """
 
191
        newline_pos = -1
 
192
        bytes = ''
 
193
        while newline_pos == -1:
 
194
            new_bytes = self._get_bytes(1)
 
195
            bytes += new_bytes
 
196
            if new_bytes == '':
 
197
                # Ran out of bytes before receiving a complete line.
 
198
                return bytes
 
199
            newline_pos = bytes.find('\n')
 
200
        line = bytes[:newline_pos+1]
 
201
        self._push_back(bytes[newline_pos+1:])
 
202
        return line
 
203
 
346
204
 
347
205
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
348
206
 
349
 
    def __init__(self, sock, backing_transport, root_client_path='/',
350
 
                 timeout=None):
 
207
    def __init__(self, sock, backing_transport, root_client_path='/'):
351
208
        """Constructor.
352
209
 
353
210
        :param sock: the socket the server will read from.  It will be put
354
211
            into blocking mode.
355
212
        """
356
213
        SmartServerStreamMedium.__init__(
357
 
            self, backing_transport, root_client_path=root_client_path,
358
 
            timeout=timeout)
 
214
            self, backing_transport, root_client_path=root_client_path)
359
215
        sock.setblocking(True)
360
216
        self.socket = sock
361
 
        # Get the getpeername now, as we might be closed later when we care.
362
 
        try:
363
 
            self._client_info = sock.getpeername()
364
 
        except socket.error:
365
 
            self._client_info = '<unknown>'
366
 
 
367
 
    def __str__(self):
368
 
        return '%s(client=%s)' % (self.__class__.__name__, self._client_info)
369
 
 
370
 
    def __repr__(self):
371
 
        return '%s.%s(client=%s)' % (self.__module__, self.__class__.__name__,
372
 
            self._client_info)
373
217
 
374
218
    def _serve_one_request_unguarded(self, protocol):
375
219
        while protocol.next_read_size():
376
 
            # We can safely try to read large chunks.  If there is less data
377
 
            # than MAX_SOCKET_CHUNK ready, the socket will just return a
378
 
            # short read immediately rather than block.
379
 
            bytes = self.read_bytes(osutils.MAX_SOCKET_CHUNK)
 
220
            bytes = self._get_bytes(4096)
380
221
            if bytes == '':
381
222
                self.finished = True
382
223
                return
383
224
            protocol.accept_bytes(bytes)
384
 
 
 
225
        
385
226
        self._push_back(protocol.unused_data)
386
227
 
387
 
    def _disconnect_client(self):
388
 
        """Close the current connection. We stopped due to a timeout/etc."""
389
 
        self.socket.close()
390
 
 
391
 
    def _wait_for_bytes_with_timeout(self, timeout_seconds):
392
 
        """Wait for more bytes to be read, but timeout if none available.
393
 
 
394
 
        This allows us to detect idle connections, and stop trying to read from
395
 
        them, without setting the socket itself to non-blocking. This also
396
 
        allows us to specify when we watch for idle timeouts.
397
 
 
398
 
        :return: None, this will raise ConnectionTimeout if we time out before
399
 
            data is available.
400
 
        """
401
 
        return self._wait_on_descriptor(self.socket, timeout_seconds)
402
 
 
403
 
    def _read_bytes(self, desired_count):
404
 
        return osutils.read_bytes_from_socket(
405
 
            self.socket, self._report_activity)
406
 
 
 
228
    def _get_bytes(self, desired_count):
 
229
        if self._push_back_buffer is not None:
 
230
            return self._get_push_back_buffer()
 
231
        # We ignore the desired_count because on sockets it's more efficient to
 
232
        # read 4k at a time.
 
233
        return self.socket.recv(4096)
 
234
    
407
235
    def terminate_due_to_error(self):
408
236
        # TODO: This should log to a server log file, but no such thing
409
237
        # exists yet.  Andrew Bennetts 2006-09-29.
411
239
        self.finished = True
412
240
 
413
241
    def _write_out(self, bytes):
414
 
        tstart = osutils.timer_func()
415
 
        osutils.send_all(self.socket, bytes, self._report_activity)
416
 
        if 'hpss' in debug.debug_flags:
417
 
            thread_id = thread.get_ident()
418
 
            trace.mutter('%12s: [%s] %d bytes to the socket in %.3fs'
419
 
                         % ('wrote', thread_id, len(bytes),
420
 
                            osutils.timer_func() - tstart))
 
242
        osutils.send_all(self.socket, bytes)
421
243
 
422
244
 
423
245
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
424
246
 
425
 
    def __init__(self, in_file, out_file, backing_transport, timeout=None):
 
247
    def __init__(self, in_file, out_file, backing_transport):
426
248
        """Construct new server.
427
249
 
428
250
        :param in_file: Python file from which requests can be read.
429
251
        :param out_file: Python file to write responses.
430
252
        :param backing_transport: Transport for the directory served.
431
253
        """
432
 
        SmartServerStreamMedium.__init__(self, backing_transport,
433
 
            timeout=timeout)
 
254
        SmartServerStreamMedium.__init__(self, backing_transport)
434
255
        if sys.platform == 'win32':
435
256
            # force binary mode for files
436
257
            import msvcrt
441
262
        self._in = in_file
442
263
        self._out = out_file
443
264
 
444
 
    def serve(self):
445
 
        """See SmartServerStreamMedium.serve"""
446
 
        # This is the regular serve, except it adds signal trapping for soft
447
 
        # shutdown.
448
 
        stop_gracefully = self._stop_gracefully
449
 
        signals.register_on_hangup(id(self), stop_gracefully)
450
 
        try:
451
 
            return super(SmartServerPipeStreamMedium, self).serve()
452
 
        finally:
453
 
            signals.unregister_on_hangup(id(self))
454
 
 
455
265
    def _serve_one_request_unguarded(self, protocol):
456
266
        while True:
457
 
            # We need to be careful not to read past the end of the current
458
 
            # request, or else the read from the pipe will block, so we use
459
 
            # protocol.next_read_size().
460
267
            bytes_to_read = protocol.next_read_size()
461
268
            if bytes_to_read == 0:
462
269
                # Finished serving this request.
463
270
                self._out.flush()
464
271
                return
465
 
            bytes = self.read_bytes(bytes_to_read)
 
272
            bytes = self._get_bytes(bytes_to_read)
466
273
            if bytes == '':
467
274
                # Connection has been closed.
468
275
                self.finished = True
470
277
                return
471
278
            protocol.accept_bytes(bytes)
472
279
 
473
 
    def _disconnect_client(self):
474
 
        self._in.close()
475
 
        self._out.flush()
476
 
        self._out.close()
477
 
 
478
 
    def _wait_for_bytes_with_timeout(self, timeout_seconds):
479
 
        """Wait for more bytes to be read, but timeout if none available.
480
 
 
481
 
        This allows us to detect idle connections, and stop trying to read from
482
 
        them, without setting the socket itself to non-blocking. This also
483
 
        allows us to specify when we watch for idle timeouts.
484
 
 
485
 
        :return: None, this will raise ConnectionTimeout if we time out before
486
 
            data is available.
487
 
        """
488
 
        if (getattr(self._in, 'fileno', None) is None
489
 
            or sys.platform == 'win32'):
490
 
            # You can't select() file descriptors on Windows.
491
 
            return
492
 
        return self._wait_on_descriptor(self._in, timeout_seconds)
493
 
 
494
 
    def _read_bytes(self, desired_count):
 
280
    def _get_bytes(self, desired_count):
 
281
        if self._push_back_buffer is not None:
 
282
            return self._get_push_back_buffer()
495
283
        return self._in.read(desired_count)
496
284
 
497
285
    def terminate_due_to_error(self):
517
305
    request.finished_reading()
518
306
 
519
307
    It is up to the individual SmartClientMedium whether multiple concurrent
520
 
    requests can exist. See SmartClientMedium.get_request to obtain instances
521
 
    of SmartClientMediumRequest, and the concrete Medium you are using for
 
308
    requests can exist. See SmartClientMedium.get_request to obtain instances 
 
309
    of SmartClientMediumRequest, and the concrete Medium you are using for 
522
310
    details on concurrency and pipelining.
523
311
    """
524
312
 
533
321
    def accept_bytes(self, bytes):
534
322
        """Accept bytes for inclusion in this request.
535
323
 
536
 
        This method may not be called after finished_writing() has been
 
324
        This method may not be be called after finished_writing() has been
537
325
        called.  It depends upon the Medium whether or not the bytes will be
538
326
        immediately transmitted. Message based Mediums will tend to buffer the
539
327
        bytes until finished_writing() is called.
570
358
    def _finished_reading(self):
571
359
        """Helper for finished_reading.
572
360
 
573
 
        finished_reading checks the state of the request to determine if
 
361
        finished_reading checks the state of the request to determine if 
574
362
        finished_reading is allowed, and if it is hands off to _finished_reading
575
363
        to perform the action.
576
364
        """
590
378
    def _finished_writing(self):
591
379
        """Helper for finished_writing.
592
380
 
593
 
        finished_writing checks the state of the request to determine if
 
381
        finished_writing checks the state of the request to determine if 
594
382
        finished_writing is allowed, and if it is hands off to _finished_writing
595
383
        to perform the action.
596
384
        """
611
399
        return self._read_bytes(count)
612
400
 
613
401
    def _read_bytes(self, count):
614
 
        """Helper for SmartClientMediumRequest.read_bytes.
 
402
        """Helper for read_bytes.
615
403
 
616
404
        read_bytes checks the state of the request to determing if bytes
617
405
        should be read. After that it hands off to _read_bytes to do the
618
406
        actual read.
619
 
 
620
 
        By default this forwards to self._medium.read_bytes because we are
621
 
        operating on the medium's stream.
622
407
        """
623
 
        return self._medium.read_bytes(count)
 
408
        raise NotImplementedError(self._read_bytes)
624
409
 
625
410
    def read_line(self):
626
 
        line = self._read_line()
627
 
        if not line.endswith('\n'):
628
 
            # end of file encountered reading from server
629
 
            raise errors.ConnectionReset(
630
 
                "Unexpected end of message. Please check connectivity "
631
 
                "and permissions, and report a bug if problems persist.")
 
411
        """Read bytes from this request's response until a newline byte.
 
412
        
 
413
        This isn't particularly efficient, so should only be used when the
 
414
        expected size of the line is quite short.
 
415
 
 
416
        :returns: a string of bytes ending in a newline (byte 0x0A).
 
417
        """
 
418
        # XXX: this duplicates SmartClientRequestProtocolOne._recv_tuple
 
419
        line = ''
 
420
        while not line or line[-1] != '\n':
 
421
            new_char = self.read_bytes(1)
 
422
            line += new_char
 
423
            if new_char == '':
 
424
                # end of file encountered reading from server
 
425
                raise errors.ConnectionReset(
 
426
                    "please check connectivity and permissions",
 
427
                    "(and try -Dhpss if further diagnosis is required)")
632
428
        return line
633
429
 
634
 
    def _read_line(self):
635
 
        """Helper for SmartClientMediumRequest.read_line.
636
 
 
637
 
        By default this forwards to self._medium._get_line because we are
638
 
        operating on the medium's stream.
639
 
        """
640
 
        return self._medium._get_line()
641
 
 
642
 
 
643
 
class _VfsRefuser(object):
644
 
    """An object that refuses all VFS requests.
645
 
 
646
 
    """
647
 
 
648
 
    def __init__(self):
649
 
        client._SmartClient.hooks.install_named_hook(
650
 
            'call', self.check_vfs, 'vfs refuser')
651
 
 
652
 
    def check_vfs(self, params):
653
 
        try:
654
 
            request_method = request.request_handlers.get(params.method)
655
 
        except KeyError:
656
 
            # A method we don't know about doesn't count as a VFS method.
657
 
            return
658
 
        if issubclass(request_method, vfs.VfsRequest):
659
 
            raise errors.HpssVfsRequestNotAllowed(params.method, params.args)
660
 
 
661
 
 
662
 
class _DebugCounter(object):
663
 
    """An object that counts the HPSS calls made to each client medium.
664
 
 
665
 
    When a medium is garbage-collected, or failing that when
666
 
    bzrlib.global_state exits, the total number of calls made on that medium
667
 
    are reported via trace.note.
668
 
    """
669
 
 
670
 
    def __init__(self):
671
 
        self.counts = weakref.WeakKeyDictionary()
672
 
        client._SmartClient.hooks.install_named_hook(
673
 
            'call', self.increment_call_count, 'hpss call counter')
674
 
        bzrlib.global_state.cleanups.add_cleanup(self.flush_all)
675
 
 
676
 
    def track(self, medium):
677
 
        """Start tracking calls made to a medium.
678
 
 
679
 
        This only keeps a weakref to the medium, so shouldn't affect the
680
 
        medium's lifetime.
681
 
        """
682
 
        medium_repr = repr(medium)
683
 
        # Add this medium to the WeakKeyDictionary
684
 
        self.counts[medium] = dict(count=0, vfs_count=0,
685
 
                                   medium_repr=medium_repr)
686
 
        # Weakref callbacks are fired in reverse order of their association
687
 
        # with the referenced object.  So we add a weakref *after* adding to
688
 
        # the WeakKeyDict so that we can report the value from it before the
689
 
        # entry is removed by the WeakKeyDict's own callback.
690
 
        ref = weakref.ref(medium, self.done)
691
 
 
692
 
    def increment_call_count(self, params):
693
 
        # Increment the count in the WeakKeyDictionary
694
 
        value = self.counts[params.medium]
695
 
        value['count'] += 1
696
 
        try:
697
 
            request_method = request.request_handlers.get(params.method)
698
 
        except KeyError:
699
 
            # A method we don't know about doesn't count as a VFS method.
700
 
            return
701
 
        if issubclass(request_method, vfs.VfsRequest):
702
 
            value['vfs_count'] += 1
703
 
 
704
 
    def done(self, ref):
705
 
        value = self.counts[ref]
706
 
        count, vfs_count, medium_repr = (
707
 
            value['count'], value['vfs_count'], value['medium_repr'])
708
 
        # In case this callback is invoked for the same ref twice (by the
709
 
        # weakref callback and by the atexit function), set the call count back
710
 
        # to 0 so this item won't be reported twice.
711
 
        value['count'] = 0
712
 
        value['vfs_count'] = 0
713
 
        if count != 0:
714
 
            trace.note(gettext('HPSS calls: {0} ({1} vfs) {2}').format(
715
 
                       count, vfs_count, medium_repr))
716
 
 
717
 
    def flush_all(self):
718
 
        for ref in list(self.counts.keys()):
719
 
            self.done(ref)
720
 
 
721
 
_debug_counter = None
722
 
_vfs_refuser = None
723
 
 
724
 
 
725
 
class SmartClientMedium(SmartMedium):
 
430
 
 
431
class SmartClientMedium(object):
726
432
    """Smart client is a medium for sending smart protocol requests over."""
727
433
 
728
 
    def __init__(self, base):
 
434
    def __init__(self):
729
435
        super(SmartClientMedium, self).__init__()
730
 
        self.base = base
731
436
        self._protocol_version_error = None
732
437
        self._protocol_version = None
733
438
        self._done_hello = False
734
 
        # Be optimistic: we assume the remote end can accept new remote
735
 
        # requests until we get an error saying otherwise.
736
 
        # _remote_version_is_before tracks the bzr version the remote side
737
 
        # can be based on what we've seen so far.
738
 
        self._remote_version_is_before = None
739
 
        # Install debug hook function if debug flag is set.
740
 
        if 'hpss' in debug.debug_flags:
741
 
            global _debug_counter
742
 
            if _debug_counter is None:
743
 
                _debug_counter = _DebugCounter()
744
 
            _debug_counter.track(self)
745
 
        if 'hpss_client_no_vfs' in debug.debug_flags:
746
 
            global _vfs_refuser
747
 
            if _vfs_refuser is None:
748
 
                _vfs_refuser = _VfsRefuser()
749
 
 
750
 
    def _is_remote_before(self, version_tuple):
751
 
        """Is it possible the remote side supports RPCs for a given version?
752
 
 
753
 
        Typical use::
754
 
 
755
 
            needed_version = (1, 2)
756
 
            if medium._is_remote_before(needed_version):
757
 
                fallback_to_pre_1_2_rpc()
758
 
            else:
759
 
                try:
760
 
                    do_1_2_rpc()
761
 
                except UnknownSmartMethod:
762
 
                    medium._remember_remote_is_before(needed_version)
763
 
                    fallback_to_pre_1_2_rpc()
764
 
 
765
 
        :seealso: _remember_remote_is_before
766
 
        """
767
 
        if self._remote_version_is_before is None:
768
 
            # So far, the remote side seems to support everything
769
 
            return False
770
 
        return version_tuple >= self._remote_version_is_before
771
 
 
772
 
    def _remember_remote_is_before(self, version_tuple):
773
 
        """Tell this medium that the remote side is older the given version.
774
 
 
775
 
        :seealso: _is_remote_before
776
 
        """
777
 
        if (self._remote_version_is_before is not None and
778
 
            version_tuple > self._remote_version_is_before):
779
 
            # We have been told that the remote side is older than some version
780
 
            # which is newer than a previously supplied older-than version.
781
 
            # This indicates that some smart verb call is not guarded
782
 
            # appropriately (it should simply not have been tried).
783
 
            trace.mutter(
784
 
                "_remember_remote_is_before(%r) called, but "
785
 
                "_remember_remote_is_before(%r) was called previously."
786
 
                , version_tuple, self._remote_version_is_before)
787
 
            if 'hpss' in debug.debug_flags:
788
 
                ui.ui_factory.show_warning(
789
 
                    "_remember_remote_is_before(%r) called, but "
790
 
                    "_remember_remote_is_before(%r) was called previously."
791
 
                    % (version_tuple, self._remote_version_is_before))
792
 
            return
793
 
        self._remote_version_is_before = version_tuple
794
439
 
795
440
    def protocol_version(self):
796
441
        """Find out if 'hello' smart request works."""
801
446
                medium_request = self.get_request()
802
447
                # Send a 'hello' request in protocol version one, for maximum
803
448
                # backwards compatibility.
804
 
                client_protocol = protocol.SmartClientRequestProtocolOne(medium_request)
 
449
                client_protocol = SmartClientRequestProtocolOne(medium_request)
805
450
                client_protocol.query_version()
806
451
                self._done_hello = True
807
452
            except errors.SmartProtocolError, e:
829
474
 
830
475
    def disconnect(self):
831
476
        """If this medium maintains a persistent connection, close it.
832
 
 
 
477
        
833
478
        The default implementation does nothing.
834
479
        """
835
 
 
836
 
    def remote_path_from_transport(self, transport):
837
 
        """Convert transport into a path suitable for using in a request.
838
 
 
839
 
        Note that the resulting remote path doesn't encode the host name or
840
 
        anything but path, so it is only safe to use it in requests sent over
841
 
        the medium from the matching transport.
842
 
        """
843
 
        medium_base = urlutils.join(self.base, '/')
844
 
        rel_url = urlutils.relative_url(medium_base, transport.base)
845
 
        return urlutils.unquote(rel_url)
846
 
 
 
480
        
847
481
 
848
482
class SmartClientStreamMedium(SmartClientMedium):
849
483
    """Stream based medium common class.
854
488
    receive bytes.
855
489
    """
856
490
 
857
 
    def __init__(self, base):
858
 
        SmartClientMedium.__init__(self, base)
 
491
    def __init__(self):
 
492
        SmartClientMedium.__init__(self)
859
493
        self._current_request = None
 
494
        # Be optimistic: we assume the remote end can accept new remote
 
495
        # requests until we get an error saying otherwise.  (1.2 adds some
 
496
        # requests that send bodies, which confuses older servers.)
 
497
        self._remote_is_at_least_1_2 = True
860
498
 
861
499
    def accept_bytes(self, bytes):
862
500
        self._accept_bytes(bytes)
869
507
 
870
508
    def _flush(self):
871
509
        """Flush the output stream.
872
 
 
 
510
        
873
511
        This method is used by the SmartClientStreamMediumRequest to ensure that
874
512
        all data for a request is sent, to avoid long timeouts or deadlocks.
875
513
        """
883
521
        """
884
522
        return SmartClientStreamMediumRequest(self)
885
523
 
886
 
    def reset(self):
887
 
        """We have been disconnected, reset current state.
888
 
 
889
 
        This resets things like _current_request and connected state.
890
 
        """
891
 
        self.disconnect()
892
 
        self._current_request = None
 
524
    def read_bytes(self, count):
 
525
        return self._read_bytes(count)
893
526
 
894
527
 
895
528
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
896
529
    """A client medium using simple pipes.
897
 
 
 
530
    
898
531
    This client does not manage the pipes: it assumes they will always be open.
899
532
    """
900
533
 
901
 
    def __init__(self, readable_pipe, writeable_pipe, base):
902
 
        SmartClientStreamMedium.__init__(self, base)
 
534
    def __init__(self, readable_pipe, writeable_pipe):
 
535
        SmartClientStreamMedium.__init__(self)
903
536
        self._readable_pipe = readable_pipe
904
537
        self._writeable_pipe = writeable_pipe
905
538
 
906
539
    def _accept_bytes(self, bytes):
907
540
        """See SmartClientStreamMedium.accept_bytes."""
908
 
        try:
909
 
            self._writeable_pipe.write(bytes)
910
 
        except IOError, e:
911
 
            if e.errno in (errno.EINVAL, errno.EPIPE):
912
 
                raise errors.ConnectionReset(
913
 
                    "Error trying to write to subprocess", e)
914
 
            raise
915
 
        self._report_activity(len(bytes), 'write')
 
541
        self._writeable_pipe.write(bytes)
916
542
 
917
543
    def _flush(self):
918
544
        """See SmartClientStreamMedium._flush()."""
919
 
        # Note: If flush were to fail, we'd like to raise ConnectionReset, etc.
920
 
        #       However, testing shows that even when the child process is
921
 
        #       gone, this doesn't error.
922
545
        self._writeable_pipe.flush()
923
546
 
924
547
    def _read_bytes(self, count):
925
548
        """See SmartClientStreamMedium._read_bytes."""
926
 
        bytes_to_read = min(count, _MAX_READ_SIZE)
927
 
        bytes = self._readable_pipe.read(bytes_to_read)
928
 
        self._report_activity(len(bytes), 'read')
929
 
        return bytes
930
 
 
931
 
 
932
 
class SSHParams(object):
933
 
    """A set of parameters for starting a remote bzr via SSH."""
934
 
 
 
549
        return self._readable_pipe.read(count)
 
550
 
 
551
 
 
552
class SmartSSHClientMedium(SmartClientStreamMedium):
 
553
    """A client medium using SSH."""
 
554
    
935
555
    def __init__(self, host, port=None, username=None, password=None,
936
 
            bzr_remote_path='bzr'):
937
 
        self.host = host
938
 
        self.port = port
939
 
        self.username = username
940
 
        self.password = password
941
 
        self.bzr_remote_path = bzr_remote_path
942
 
 
943
 
 
944
 
class SmartSSHClientMedium(SmartClientStreamMedium):
945
 
    """A client medium using SSH.
946
 
 
947
 
    It delegates IO to a SmartSimplePipesClientMedium or
948
 
    SmartClientAlreadyConnectedSocketMedium (depending on platform).
949
 
    """
950
 
 
951
 
    def __init__(self, base, ssh_params, vendor=None):
 
556
            vendor=None, bzr_remote_path=None):
952
557
        """Creates a client that will connect on the first use.
953
 
 
954
 
        :param ssh_params: A SSHParams instance.
 
558
        
955
559
        :param vendor: An optional override for the ssh vendor to use. See
956
560
            bzrlib.transport.ssh for details on ssh vendors.
957
561
        """
958
 
        self._real_medium = None
959
 
        self._ssh_params = ssh_params
960
 
        # for the benefit of progress making a short description of this
961
 
        # transport
962
 
        self._scheme = 'bzr+ssh'
963
 
        # SmartClientStreamMedium stores the repr of this object in its
964
 
        # _DebugCounter so we have to store all the values used in our repr
965
 
        # method before calling the super init.
966
 
        SmartClientStreamMedium.__init__(self, base)
 
562
        SmartClientStreamMedium.__init__(self)
 
563
        self._connected = False
 
564
        self._host = host
 
565
        self._password = password
 
566
        self._port = port
 
567
        self._username = username
 
568
        self._read_from = None
 
569
        self._ssh_connection = None
967
570
        self._vendor = vendor
968
 
        self._ssh_connection = None
969
 
 
970
 
    def __repr__(self):
971
 
        if self._ssh_params.port is None:
972
 
            maybe_port = ''
973
 
        else:
974
 
            maybe_port = ':%s' % self._ssh_params.port
975
 
        if self._ssh_params.username is None:
976
 
            maybe_user = ''
977
 
        else:
978
 
            maybe_user = '%s@' % self._ssh_params.username
979
 
        return "%s(%s://%s%s%s/)" % (
980
 
            self.__class__.__name__,
981
 
            self._scheme,
982
 
            maybe_user,
983
 
            self._ssh_params.host,
984
 
            maybe_port)
 
571
        self._write_to = None
 
572
        self._bzr_remote_path = bzr_remote_path
 
573
        if self._bzr_remote_path is None:
 
574
            symbol_versioning.warn(
 
575
                'bzr_remote_path is required as of bzr 0.92',
 
576
                DeprecationWarning, stacklevel=2)
 
577
            self._bzr_remote_path = os.environ.get('BZR_REMOTE_PATH', 'bzr')
985
578
 
986
579
    def _accept_bytes(self, bytes):
987
580
        """See SmartClientStreamMedium.accept_bytes."""
988
581
        self._ensure_connection()
989
 
        self._real_medium.accept_bytes(bytes)
 
582
        self._write_to.write(bytes)
990
583
 
991
584
    def disconnect(self):
992
585
        """See SmartClientMedium.disconnect()."""
993
 
        if self._real_medium is not None:
994
 
            self._real_medium.disconnect()
995
 
            self._real_medium = None
996
 
        if self._ssh_connection is not None:
997
 
            self._ssh_connection.close()
998
 
            self._ssh_connection = None
 
586
        if not self._connected:
 
587
            return
 
588
        self._read_from.close()
 
589
        self._write_to.close()
 
590
        self._ssh_connection.close()
 
591
        self._connected = False
999
592
 
1000
593
    def _ensure_connection(self):
1001
594
        """Connect this medium if not already connected."""
1002
 
        if self._real_medium is not None:
 
595
        if self._connected:
1003
596
            return
1004
597
        if self._vendor is None:
1005
598
            vendor = ssh._get_ssh_vendor()
1006
599
        else:
1007
600
            vendor = self._vendor
1008
 
        self._ssh_connection = vendor.connect_ssh(self._ssh_params.username,
1009
 
                self._ssh_params.password, self._ssh_params.host,
1010
 
                self._ssh_params.port,
1011
 
                command=[self._ssh_params.bzr_remote_path, 'serve', '--inet',
 
601
        self._ssh_connection = vendor.connect_ssh(self._username,
 
602
                self._password, self._host, self._port,
 
603
                command=[self._bzr_remote_path, 'serve', '--inet',
1012
604
                         '--directory=/', '--allow-writes'])
1013
 
        io_kind, io_object = self._ssh_connection.get_sock_or_pipes()
1014
 
        if io_kind == 'socket':
1015
 
            self._real_medium = SmartClientAlreadyConnectedSocketMedium(
1016
 
                self.base, io_object)
1017
 
        elif io_kind == 'pipes':
1018
 
            read_from, write_to = io_object
1019
 
            self._real_medium = SmartSimplePipesClientMedium(
1020
 
                read_from, write_to, self.base)
1021
 
        else:
1022
 
            raise AssertionError(
1023
 
                "Unexpected io_kind %r from %r"
1024
 
                % (io_kind, self._ssh_connection))
1025
 
        for hook in transport.Transport.hooks["post_connect"]:
1026
 
            hook(self)
 
605
        self._read_from, self._write_to = \
 
606
            self._ssh_connection.get_filelike_channels()
 
607
        self._connected = True
1027
608
 
1028
609
    def _flush(self):
1029
610
        """See SmartClientStreamMedium._flush()."""
1030
 
        self._real_medium._flush()
 
611
        self._write_to.flush()
1031
612
 
1032
613
    def _read_bytes(self, count):
1033
614
        """See SmartClientStreamMedium.read_bytes."""
1034
 
        if self._real_medium is None:
 
615
        if not self._connected:
1035
616
            raise errors.MediumNotConnected(self)
1036
 
        return self._real_medium.read_bytes(count)
 
617
        return self._read_from.read(count)
1037
618
 
1038
619
 
1039
620
# Port 4155 is the default port for bzr://, registered with IANA.
1040
 
BZR_DEFAULT_INTERFACE = None
 
621
BZR_DEFAULT_INTERFACE = '0.0.0.0'
1041
622
BZR_DEFAULT_PORT = 4155
1042
623
 
1043
624
 
1044
 
class SmartClientSocketMedium(SmartClientStreamMedium):
1045
 
    """A client medium using a socket.
1046
 
 
1047
 
    This class isn't usable directly.  Use one of its subclasses instead.
1048
 
    """
1049
 
 
1050
 
    def __init__(self, base):
1051
 
        SmartClientStreamMedium.__init__(self, base)
 
625
class SmartTCPClientMedium(SmartClientStreamMedium):
 
626
    """A client medium using TCP."""
 
627
    
 
628
    def __init__(self, host, port):
 
629
        """Creates a client that will connect on the first use."""
 
630
        SmartClientStreamMedium.__init__(self)
 
631
        self._connected = False
 
632
        self._host = host
 
633
        self._port = port
1052
634
        self._socket = None
1053
 
        self._connected = False
1054
635
 
1055
636
    def _accept_bytes(self, bytes):
1056
637
        """See SmartClientMedium.accept_bytes."""
1057
638
        self._ensure_connection()
1058
 
        osutils.send_all(self._socket, bytes, self._report_activity)
1059
 
 
1060
 
    def _ensure_connection(self):
1061
 
        """Connect this medium if not already connected."""
1062
 
        raise NotImplementedError(self._ensure_connection)
1063
 
 
1064
 
    def _flush(self):
1065
 
        """See SmartClientStreamMedium._flush().
1066
 
 
1067
 
        For sockets we do no flushing. For TCP sockets we may want to turn off
1068
 
        TCP_NODELAY and add a means to do a flush, but that can be done in the
1069
 
        future.
1070
 
        """
1071
 
 
1072
 
    def _read_bytes(self, count):
1073
 
        """See SmartClientMedium.read_bytes."""
1074
 
        if not self._connected:
1075
 
            raise errors.MediumNotConnected(self)
1076
 
        return osutils.read_bytes_from_socket(
1077
 
            self._socket, self._report_activity)
 
639
        osutils.send_all(self._socket, bytes)
1078
640
 
1079
641
    def disconnect(self):
1080
642
        """See SmartClientMedium.disconnect()."""
1084
646
        self._socket = None
1085
647
        self._connected = False
1086
648
 
1087
 
 
1088
 
class SmartTCPClientMedium(SmartClientSocketMedium):
1089
 
    """A client medium that creates a TCP connection."""
1090
 
 
1091
 
    def __init__(self, host, port, base):
1092
 
        """Creates a client that will connect on the first use."""
1093
 
        SmartClientSocketMedium.__init__(self, base)
1094
 
        self._host = host
1095
 
        self._port = port
1096
 
 
1097
649
    def _ensure_connection(self):
1098
650
        """Connect this medium if not already connected."""
1099
651
        if self._connected:
1100
652
            return
 
653
        self._socket = socket.socket()
 
654
        self._socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
1101
655
        if self._port is None:
1102
656
            port = BZR_DEFAULT_PORT
1103
657
        else:
1104
658
            port = int(self._port)
1105
659
        try:
1106
 
            sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
1107
 
                socket.SOCK_STREAM, 0, 0)
1108
 
        except socket.gaierror, (err_num, err_msg):
1109
 
            raise errors.ConnectionError("failed to lookup %s:%d: %s" %
1110
 
                    (self._host, port, err_msg))
1111
 
        # Initialize err in case there are no addresses returned:
1112
 
        err = socket.error("no address found for %s" % self._host)
1113
 
        for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
1114
 
            try:
1115
 
                self._socket = socket.socket(family, socktype, proto)
1116
 
                self._socket.setsockopt(socket.IPPROTO_TCP,
1117
 
                                        socket.TCP_NODELAY, 1)
1118
 
                self._socket.connect(sockaddr)
1119
 
            except socket.error, err:
1120
 
                if self._socket is not None:
1121
 
                    self._socket.close()
1122
 
                self._socket = None
1123
 
                continue
1124
 
            break
1125
 
        if self._socket is None:
 
660
            self._socket.connect((self._host, port))
 
661
        except socket.error, err:
1126
662
            # socket errors either have a (string) or (errno, string) as their
1127
663
            # args.
1128
664
            if type(err.args) is str:
1132
668
            raise errors.ConnectionError("failed to connect to %s:%d: %s" %
1133
669
                    (self._host, port, err_msg))
1134
670
        self._connected = True
1135
 
        for hook in transport.Transport.hooks["post_connect"]:
1136
 
            hook(self)
1137
 
 
1138
 
 
1139
 
class SmartClientAlreadyConnectedSocketMedium(SmartClientSocketMedium):
1140
 
    """A client medium for an already connected socket.
1141
 
    
1142
 
    Note that this class will assume it "owns" the socket, so it will close it
1143
 
    when its disconnect method is called.
1144
 
    """
1145
 
 
1146
 
    def __init__(self, base, sock):
1147
 
        SmartClientSocketMedium.__init__(self, base)
1148
 
        self._socket = sock
1149
 
        self._connected = True
1150
 
 
1151
 
    def _ensure_connection(self):
1152
 
        # Already connected, by definition!  So nothing to do.
1153
 
        pass
 
671
 
 
672
    def _flush(self):
 
673
        """See SmartClientStreamMedium._flush().
 
674
        
 
675
        For TCP we do no flushing. We may want to turn off TCP_NODELAY and 
 
676
        add a means to do a flush, but that can be done in the future.
 
677
        """
 
678
 
 
679
    def _read_bytes(self, count):
 
680
        """See SmartClientMedium.read_bytes."""
 
681
        if not self._connected:
 
682
            raise errors.MediumNotConnected(self)
 
683
        return self._socket.recv(count)
1154
684
 
1155
685
 
1156
686
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
1169
699
 
1170
700
    def _accept_bytes(self, bytes):
1171
701
        """See SmartClientMediumRequest._accept_bytes.
1172
 
 
 
702
        
1173
703
        This forwards to self._medium._accept_bytes because we are operating
1174
704
        on the mediums stream.
1175
705
        """
1178
708
    def _finished_reading(self):
1179
709
        """See SmartClientMediumRequest._finished_reading.
1180
710
 
1181
 
        This clears the _current_request on self._medium to allow a new
 
711
        This clears the _current_request on self._medium to allow a new 
1182
712
        request to be created.
1183
713
        """
1184
714
        if self._medium._current_request is not self:
1185
715
            raise AssertionError()
1186
716
        self._medium._current_request = None
1187
 
 
 
717
        
1188
718
    def _finished_writing(self):
1189
719
        """See SmartClientMediumRequest._finished_writing.
1190
720
 
1191
721
        This invokes self._medium._flush to ensure all bytes are transmitted.
1192
722
        """
1193
723
        self._medium._flush()
 
724
 
 
725
    def _read_bytes(self, count):
 
726
        """See SmartClientMediumRequest._read_bytes.
 
727
        
 
728
        This forwards to self._medium._read_bytes because we are operating
 
729
        on the mediums stream.
 
730
        """
 
731
        return self._medium._read_bytes(count)
 
732