b.t.t.CheckJailRequest(request.SmartServerRequest) : class documentation

Part of bzrlib.tests.test_smart_request View In Hierarchy

Undocumented
Method __init__ Constructor.
Method do Mandatory extension point for SmartServerRequest subclasses.
Method do_chunk Called with each body chunk if the request has a streamed body.
Method do_end Called when the end of the request has been received.

Inherited from SmartServerRequest:

Method execute Public entry point to execute this request.
Method do_body Called if the client sends a body with the request.
Method setup_jail Undocumented
Method teardown_jail Undocumented
Method translate_client_path Translate a path received from a network client into a local
Method transport_from_client_path Get a backing transport corresponding to the location referred to by
Method _check_enabled Raises DisabledMethod if this method is disabled.
def __init__(self, *args):
Constructor.
Parametersbacking_transportthe base transport to be used when performing this request.
root_client_paththe client path that maps to the root of backing_transport. This is used to interpret relpaths received from the client. Clients will not be able to refer to paths above this root. If root_client_path is None, then no translation will be performed on client paths. Default is '/'.
jail_rootif specified, the root of the BzrDir.open jail to use instead of backing_transport.
def do(self):
Mandatory extension point for SmartServerRequest subclasses.

Subclasses must implement this.

This should return a SmartServerResponse if this command expects to receive no body.

def do_chunk(self, bytes):
Called with each body chunk if the request has a streamed body.

The do() method is still called, and must have returned None.

def do_end(self):
Called when the end of the request has been received.
API Documentation for Bazaar, generated by pydoctor at 2022-06-16 00:25:16.