twisted.conch.endpoints._CommandChannel(SSHChannel)
class documentationtwisted.conch.endpoints
View Source
(View In Hierarchy)
A _CommandChannel
executes a command in a session channel and connects its input and output
to an IProtocol
provider.
Method | __init__ | |
Method | openFailed | When the request to open a new channel to run this command in fails,
fire the commandConnected deferred with a failure indicating
that. |
Method | channelOpen | When the request to open a new channel to run this command in succeeds,
issue an "exec" request to run the command. |
Method | dataReceived | When the command's stdout data arrives over the channel, deliver it to the protocol instance. |
Method | request_exit_status | When the server sends the command's exit status, record it for later delivery to the protocol. |
Method | request_exit_signal | When the server sends the command's exit status, record it for later delivery to the protocol. |
Method | closed | When the channel closes, deliver disconnection notification to the protocol. |
Instance Variable | _creator | See __init__ |
Instance Variable | _command | See __init__ |
Instance Variable | _protocolFactory | See __init__ |
Instance Variable | _commandConnected | See __init__ |
Instance Variable | _protocol | An IProtocol
provider created using _protocolFactory which is hooked up to
the running command's input and output streams. |
Method | _execFailure | When the request to execute the command in this channel fails, fire the
commandConnected deferred with a failure indicating this. |
Method | _execSuccess | No summary |
Inherited from SSHChannel:
Instance Variable | name | the name of the channel. (type: bytes ) |
Instance Variable | localWindowSize | the maximum size of the local window in bytes. (type: int ) |
Instance Variable | localWindowLeft | how many bytes are left in the local window. (type: int ) |
Instance Variable | localMaxPacket | the maximum size of packet we will accept in bytes. (type: int ) |
Instance Variable | remoteWindowLeft | how many bytes are left in the remote window. (type: int ) |
Instance Variable | remoteMaxPacket | the maximum size of a packet the remote side will accept in bytes. (type: int ) |
Instance Variable | conn | the connection this channel is multiplexed through. (type: SSHConnection ) |
Instance Variable | data | any data to send to the other size when the channel is requested. (type: bytes ) |
Instance Variable | avatar | an avatar for the logged-in user (if a server channel) |
Instance Variable | localClosed | True if we aren't accepting more data. (type: bool ) |
Instance Variable | remoteClosed | True if the other size isn't accepting more data. (type: bool ) |
Method | __str__ | Undocumented |
Method | __bytes__ | Return a byte string representation of the channel |
Method | logPrefix | Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines. |
Method | addWindowBytes | Called when bytes are added to the remote window. By default it clears the data buffers. |
Method | requestReceived | No summary |
Method | extReceived | Called when we receive extended data (usually standard error). |
Method | eofReceived | Called when the other side will send no more data. |
Method | closeReceived | Called when the other side has closed the channel. |
Method | write | Write some data to the channel. If there is not enough remote window available, buffer until it is. Otherwise, split the data into packets of length remoteMaxPacket and send them. |
Method | writeExtended | Send extended data to this channel. If there is not enough remote window available, buffer until there is. Otherwise, split the data into packets of length remoteMaxPacket and send them. |
Method | writeSequence | Part of the Transport interface. Write a list of strings to the channel. |
Method | loseConnection | Close the channel if there is no buferred data. Otherwise, note the request and return. |
Method | getPeer | See: ITransport.getPeer |
Method | getHost | See: ITransport.getHost |
Method | stopWriting | Called when the remote buffer is full, as a hint to stop writing. This can be ignored, but it can be helpful. |
Method | startWriting | Called when the remote buffer has more room, as a hint to continue writing. |
IProtocol
provider created using _protocolFactory
which is hooked up to
the running command's input and output streams.
Parameters | creator | The _ISSHConnectionCreator
provider which was used to get the connection which this channel exists on. (type: _ISSHConnectionCreator
provider) |
command | The command to be executed. (type: bytes ) | |
protocolFactory | A client factory to use to build a IProtocol
provider to use to associate with the running command. | |
commandConnected | A Deferred
to use to signal that execution of the command has failed or that it has
succeeded and the command is now running. (type: Deferred ) |
When the request to open a new channel to run this command in fails,
fire the commandConnected
deferred with a failure indicating
that.
When the request to open a new channel to run this command in succeeds,
issue an "exec"
request to run the command.
When the request to execute the command in this channel fails, fire the
commandConnected
deferred with a failure indicating this.
Parameters | reason | The cause of the command execution failure. (type: Failure ) |
When the request to execute the command in this channel succeeds, use
protocolFactory
to build a protocol to handle the command's
input and output and connect the protocol to a transport representing those
streams.
Also fire commandConnected
with the created protocol after
it is connected to its transport.
Parameters | ignored | The (ignored) result of the execute request |
When the command's stdout data arrives over the channel, deliver it to the protocol instance.
Parameters | data | The bytes from the command's stdout. (type: bytes ) |
When the server sends the command's exit status, record it for later delivery to the protocol.
Parameters | data | The network-order four byte representation of the exit status of the
command. (type: bytes ) |
When the server sends the command's exit status, record it for later delivery to the protocol.
Parameters | data | The network-order four byte representation of the exit signal of the
command. (type: bytes ) |
When the channel closes, deliver disconnection notification to the protocol.