on_ssh_channel_requested Event

Fired if the SSHChannelRequest was successful, any further processing for the channel request should be done here.

Syntax

class SSHClientSSHChannelRequestedEventParams(object):
  @property
  def channel_id() -> str: ...
  @property
  def request_type() -> str: ...
  @property
  def packet() -> bytes: ...

# In class SSHClient:
@property
def on_ssh_channel_requested() -> Callable[[SSHClientSSHChannelRequestedEventParams], None]: ...
@on_ssh_channel_requested.setter
def on_ssh_channel_requested(event_hook: Callable[[SSHClientSSHChannelRequestedEventParams], None]) -> None: ...

Remarks

The ssh_host may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the class. However, others may need the attention of the user to be dealt with properly within the scope of the application.

ChannelId identifies the channel receiving the request.

Type will contain the type of the request. These types are dependent upon the type of the channel. For example, a "session" channel executing a command on the remote shell may receive an "exit-status" request containing the return code of that command.

RequestData contains the remainder of the original SSH packet. If the request type has specific parameters, they can be parsed out of this data.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.