libsshpp v0.1.7
Modern C++17 wrapper for libssh
Loading...
Searching...
No Matches
sshpp::Shell Class Reference

#include <shell.hpp>

Classes

struct  Options
 

Public Member Functions

 Shell (Session &, Options options)
 
Result< void > try_start ()
 
Channelchannel () noexcept
 
Result< std::size_t > try_write (std::string_view data)
 
Result< std::string > try_read (std::chrono::milliseconds timeout, Stream stream=Stream::stdout_)
 
Result< void > try_resize (PtySize)
 
Result< void > try_send_signal (Signal)
 

Detailed Description

An interactive channel: pty + shell requests, then either manual try_write()/try_read() or (with LIBSSHPP_WITH_CONSOLE) a full terminal relay.

Constructor & Destructor Documentation

◆ Shell()

SSHPP_INLINE sshpp::Shell::Shell ( Session session,
Options  options 
)

Member Function Documentation

◆ try_start()

SSHPP_INLINE Result< void > sshpp::Shell::try_start ( )

◆ channel()

Channel & sshpp::Shell::channel ( )
inlinenoexcept

◆ try_write()

SSHPP_INLINE Result< std::size_t > sshpp::Shell::try_write ( std::string_view  data)

◆ try_read()

SSHPP_INLINE Result< std::string > sshpp::Shell::try_read ( std::chrono::milliseconds  timeout,
Stream  stream = Stream::stdout_ 
)

◆ try_resize()

SSHPP_INLINE Result< void > sshpp::Shell::try_resize ( PtySize  size)

◆ try_send_signal()

SSHPP_INLINE Result< void > sshpp::Shell::try_send_signal ( Signal  s)

The documentation for this class was generated from the following files: