Struct SSHServer 

pub struct SSHServer<'a> { /* private fields */ }

An async SSH server instance

The run() method runs the session to completion. progress() must be polled, and responses given to the events provided.

Once the client has opened sessions, those can be retrieved with stdio() and stdio_stderr() methods.

This is async executor agnostic.

Implementations

impl<'a> SSHServer<'a>

pub fn new(inbuf: &'a mut [u8], outbuf: &'a mut [u8]) -> Self

pub async fn run( &self, rsock: &mut impl Read, wsock: &mut impl Write, ) -> Result<()>

Runs the session to completion.

rsock and wsock are the SSH network channel (TCP port 22 or equivalent).

pub async fn progress<'g, 'f>( &'g self, ph: &'f mut ProgressHolder<'g, 'a, Server>, ) -> Result<ServEvent<'f, 'a>>

Returns an event from the SSH session.

Note that on return ProgressHolder holds a mutex over the session, so most other calls to SSHServer will block until the ProgressHolder is dropped.

pub async fn stdio(&self, ch: ChanHandle) -> Result<ChanInOut<'_>>

Returns a ChanInOut representing a channel.

ch is the ChanHandle returned after accepting a ServEvent::OpenSession event. If stderr is also needed, use stdio_stderr() instead.

pub async fn stdio_stderr( &self, ch: ChanHandle, ) -> Result<(ChanInOut<'_>, ChanOut<'_>)>

Retrieve the stdin/stdout/stderr streams.

See stdio().

Trait Implementations

impl<'a> Debug for SSHServer<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.