libsshpp v0.1.7
Modern C++17 wrapper for libssh
Loading...
Searching...
No Matches
Public Member Functions | List of all members
sshpp::server::ChannelHandler Class Reference

Per-channel request/data handling. See docs/design/08 §8.6. More...

#include <handlers.hpp>

Inheritance diagram for sshpp::server::ChannelHandler:
[legend]

Public Member Functions

virtual ~ChannelHandler ()=default
 
virtual bool on_pty_request (Channel &, std::string_view term, PtySize)
 
virtual bool on_pty_resize (Channel &, PtySize)
 
virtual bool on_shell_request (Channel &)
 
virtual bool on_exec_request (Channel &, std::string_view command)
 
virtual bool on_subsystem_request (Channel &, std::string_view name)
 
virtual bool on_env_request (Channel &, std::string_view name, std::string_view value)
 
virtual void on_x11_request (Channel &, bool single_connection, std::string_view auth_protocol, std::string_view auth_cookie, std::uint32_t screen_number)
 
virtual void on_signal (Channel &, std::string_view signal_name)
 
virtual std::size_t on_data (Channel &, ByteView, Stream)
 Return the number of bytes consumed (libssh re-delivers the remainder).
 
virtual void on_eof (Channel &)
 
virtual void on_close (Channel &)
 
virtual void on_writable (Channel &)
 Called when the channel's send window opens up again.
 

Detailed Description

Per-channel request/data handling. See docs/design/08 §8.6.

Constructor & Destructor Documentation

◆ ~ChannelHandler()

virtual sshpp::server::ChannelHandler::~ChannelHandler ( )
virtualdefault

Member Function Documentation

◆ on_pty_request()

SSHPP_INLINE bool sshpp::server::ChannelHandler::on_pty_request ( Channel &  ,
std::string_view  term,
PtySize   
)
virtual

◆ on_pty_resize()

SSHPP_INLINE bool sshpp::server::ChannelHandler::on_pty_resize ( Channel &  ,
PtySize   
)
virtual

◆ on_shell_request()

SSHPP_INLINE bool sshpp::server::ChannelHandler::on_shell_request ( Channel &  )
virtual

◆ on_exec_request()

SSHPP_INLINE bool sshpp::server::ChannelHandler::on_exec_request ( Channel &  ,
std::string_view  command 
)
virtual

Reimplemented in sshpp::server::CommandHandler.

◆ on_subsystem_request()

SSHPP_INLINE bool sshpp::server::ChannelHandler::on_subsystem_request ( Channel &  ,
std::string_view  name 
)
virtual

Reimplemented in sshpp::server::SftpSubsystemHandler.

◆ on_env_request()

SSHPP_INLINE bool sshpp::server::ChannelHandler::on_env_request ( Channel &  ,
std::string_view  name,
std::string_view  value 
)
virtual

◆ on_x11_request()

SSHPP_INLINE void sshpp::server::ChannelHandler::on_x11_request ( Channel &  ,
bool  single_connection,
std::string_view  auth_protocol,
std::string_view  auth_cookie,
std::uint32_t  screen_number 
)
virtual

◆ on_signal()

SSHPP_INLINE void sshpp::server::ChannelHandler::on_signal ( Channel &  ,
std::string_view  signal_name 
)
virtual

◆ on_data()

SSHPP_INLINE std::size_t sshpp::server::ChannelHandler::on_data ( Channel &  ,
ByteView  data,
Stream   
)
virtual

Return the number of bytes consumed (libssh re-delivers the remainder).

Reimplemented in sshpp::server::CommandHandler.

◆ on_eof()

SSHPP_INLINE void sshpp::server::ChannelHandler::on_eof ( Channel &  )
virtual

Reimplemented in sshpp::server::CommandHandler.

◆ on_close()

SSHPP_INLINE void sshpp::server::ChannelHandler::on_close ( Channel &  )
virtual

Reimplemented in sshpp::server::SftpSubsystemHandler.

◆ on_writable()

SSHPP_INLINE void sshpp::server::ChannelHandler::on_writable ( Channel &  )
virtual

Called when the channel's send window opens up again.

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