b.s.m.SmartClientStreamMedium(SmartClientMedium) : class documentation

Part of bzrlib.smart.medium View In Hierarchy

Known subclasses: bzrlib.smart.medium.SmartClientSocketMedium, bzrlib.smart.medium.SmartSimplePipesClientMedium, bzrlib.smart.medium.SmartSSHClientMedium

Stream based medium common class.

SmartClientStreamMediums operate on a stream. All subclasses use a common SmartClientStreamMediumRequest for their requests, and should implement _accept_bytes and _read_bytes to allow the request objects to send and receive bytes.

Method __init__ Undocumented
Method accept_bytes Undocumented
Method __del__ The SmartClientStreamMedium knows how to close the stream when it is
Method get_request See SmartClientMedium.get_request().
Method _flush Flush the output stream.

Inherited from SmartClientMedium:

Method protocol_version Find out if 'hello' smart request works.
Method should_probe Should RemoteBzrDirFormat.probe_transport send a smart request on
Method disconnect If this medium maintains a persistent connection, close it.
Method remote_path_from_transport Convert transport into a path suitable for using in a request.
Method _is_remote_before Is it possible the remote side supports RPCs for a given version?
Method _remember_remote_is_before Tell this medium that the remote side is older the given version.

Inherited from SmartMedium (via SmartClientMedium):

Method read_bytes Read some bytes from this medium.
Method _push_back Return unused bytes to the medium, because they belong to the next
Method _get_push_back_buffer Undocumented
Method _read_bytes Undocumented
Method _get_line Read bytes from this request's response until a newline byte.
Method _report_activity Notify that this medium has activity.
def __init__(self, base):
def accept_bytes(self, bytes):
def __del__(self):
The SmartClientStreamMedium knows how to close the stream when it is finished with it.
def _flush(self):
Flush the output stream.

This method is used by the SmartClientStreamMediumRequest to ensure that all data for a request is sent, to avoid long timeouts or deadlocks.

def get_request(self):
See SmartClientMedium.get_request().

SmartClientStreamMedium always returns a SmartClientStreamMediumRequest for get_request.

API Documentation for Bazaar, generated by pydoctor at 2020-07-06 00:55:29.