Part of twisted.conch.ssh.channel View Source View In Hierarchy
Known subclasses: twisted.conch.client.agent.SSHAgentForwardingChannel, twisted.conch.scripts.cftp.SSHSession, twisted.conch.scripts.conch.SSHSession, twisted.conch.scripts.tkconch.SSHSession, twisted.conch.ssh.forwarding.SSHConnectForwardingChannel, twisted.conch.ssh.forwarding.SSHListenForwardingChannel, twisted.conch.ssh.session.SSHSession
Implements interfaces: twisted.internet.interfaces.ITransport
| Instance Variables | name | the name of the channel.
(type: str
) |
| localWindowSize | the maximum size of the local window in bytes.
(type: int
) | |
| localWindowLeft | how many bytes are left in the local window.
(type: int
) | |
| localMaxPacket | the maximum size of packet we will accept in bytes.
(type: int
) | |
| remoteWindowLeft | how many bytes are left in the remote window.
(type: int
) | |
| remoteMaxPacket | the maximum size of a packet the remote side will accept in bytes.
(type: int
) | |
| conn | the connection this channel is multiplexed through.
(type: SSHConnection
) | |
| data | any data to send to the other size when the channel is requested.
(type: str
) | |
| avatar | an avatar for the logged-in user (if a server channel) | |
| localClosed | True if we aren't accepting more data.
(type: bool
) | |
| remoteClosed | True if the other size isn't accepting more data.
(type: bool
) |
| Method | __init__ | Undocumented |
| Method | __str__ | Undocumented |
| Method | logPrefix | Override this method to insert custom logging behavior. Its |
| Method | channelOpen | Called when the channel is opened. specificData is any data that the |
| Method | openFailed | Called when the the open failed for some reason. |
| Method | addWindowBytes | Called when bytes are added to the remote window. By default it clears |
| Method | requestReceived | Called when a request is sent to this channel. By default it delegates |
| Method | dataReceived | Called when we receive data. |
| 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 | closed | Called when the channel is closed. This means that both our side and |
| Method | write | Write some data to the channel. If there is not enough remote window |
| Method | writeExtended | Send extended data to this channel. If there is not enough remote |
| Method | writeSequence | Part of the Transport interface. Write a list of strings to the |
| Method | loseConnection | Close the channel if there is no buferred data. Otherwise, note the |
| Method | getPeer | Return a tuple describing the other side of the connection. |
| Method | getHost | Return a tuple describing our side of the connection. |
| Method | stopWriting | Called when the remote buffer is full, as a hint to stop writing. |
| Method | startWriting | Called when the remote buffer has more room, as a hint to continue |
| Parameters | specificData | (type: str
) |
| Parameters | reason | (type: error.ConchError
) |
| Parameters | bytes | (type: int
) |
| Parameters | requestType | (type: str
) |
| data | (type: str
) | |
| Returns | (type: bool
) | |
| Parameters | data | (type: str
) |
| Parameters | dataType | (type: int
) |
| data | (type: str
) |
| Parameters | data | (type: str
) |
| Parameters | dataType | (type: int
) |
| data | (type: str
) |
| Parameters | data | (type: list of str
) |
| Returns | (type: tuple
) | |
| Returns | (type: tuple
) | |