Struct thrussh::client::Session

pub struct Session(_);

The type of a client session.

Methods

impl Session

fn flush(&mut self) -> Result<(), Error>

Flush the temporary cleartext buffer into the encryption buffer. This does not flush to the socket.

fn config(&self) -> &Config

Retrieves the configuration of this session.

fn auth_user(&self) -> &str

Retrieves the current user.

fn disconnect(
    &mut self,
    reason: Disconnect,
    description: &str,
    language_tag: &str
)

Sends a disconnect message.

fn is_authenticated(&self) -> bool

Whether the client is authenticated.

fn is_disconnected(&self) -> bool

Whether the client is disconnected.

fn channel_is_open(&self, channel: ChannelId) -> bool

Check whether a channel has been confirmed.

fn has_auth_method(&self) -> bool

Tests whether we need an authentication method (for instance if the last attempt failed).

fn valid_auth_methods(&self) -> Option<MethodSet>

Returns the set of authentication methods that can continue, or None if this is not valid.

fn channel_eof(&mut self, channel: ChannelId)

Send EOF to a channel

fn request_pty(
    &mut self,
    channel: ChannelId,
    want_reply: bool,
    term: &str,
    col_width: u32,
    row_height: u32,
    pix_width: u32,
    pix_height: u32,
    terminal_modes: &[(Pty, u32)]
)

Request a pseudo-terminal with the given characteristics.

fn request_x11(
    &mut self,
    channel: ChannelId,
    want_reply: bool,
    single_connection: bool,
    x11_authentication_protocol: &str,
    x11_authentication_cookie: &str,
    x11_screen_number: u32
)

Request X11 forwarding through an already opened X11 channel. See RFC4254 for security issues related to cookies.

fn set_env(
    &mut self,
    channel: ChannelId,
    want_reply: bool,
    variable_name: &str,
    variable_value: &str
)

Set a remote environment variable.

fn request_shell(&mut self, want_reply: bool, channel: ChannelId)

Request a remote shell.

fn exec(&mut self, channel: ChannelId, want_reply: bool, command: &str)

Execute a remote program (will be passed to a shell). This can be used to implement scp (by calling a remote scp and tunneling to its standard input).

fn signal(&mut self, channel: ChannelId, signal: Sig)

Signal a remote process.

fn request_subsystem(
    &mut self,
    want_reply: bool,
    channel: ChannelId,
    name: &str
)

Request the start of a subsystem with the given name.

fn window_change(
    &mut self,
    channel: ChannelId,
    col_width: u32,
    row_height: u32,
    pix_width: u32,
    pix_height: u32
)

Inform the server that our window size has changed.

fn tcpip_forward(&mut self, want_reply: bool, address: &str, port: u32)

Request the forwarding of a remote port to the client. The server will then open forwarding channels (which cause the client to call .channel_open_forwarded_tcpip()).

fn cancel_tcpip_forward(&mut self, want_reply: bool, address: &str, port: u32)

Cancel a previous forwarding request.

fn data(
    &mut self,
    channel: ChannelId,
    extended: Option<u32>,
    data: &[u8]
) -> Result<usize, Error>

Send data to a channel. The number of bytes added to the "sending pipeline" (to be processed by the event loop) is returned.