sshpp::LocalForward Class Reference

#include <forwarding.hpp>

Classes
struct	Options

Public Member Functions
	LocalForward (Session &, Options)
	~LocalForward ()
	LocalForward (const LocalForward &)=delete
LocalForward &	operator= (const LocalForward &)=delete
Result< void >	try_start ()
void	stop () noexcept
bool	running () const noexcept
TcpEndpoint	local_endpoint () const noexcept
ForwardStats	stats () const noexcept
Result< void >	try_run_until_stopped ()
	Drives the accept loop on the calling thread instead of spawning one.

Detailed Description

ssh -L equivalent: local TCP listener -> one channel per accepted connection. Connections are served one at a time (see the scope note at the top of this file).

Constructor & Destructor Documentation

LocalForward() [1/2]

SSHPP_INLINE sshpp::LocalForward::LocalForward	(	Session &	session,
		Options	opts
	)

~LocalForward()

SSHPP_INLINE sshpp::LocalForward::~LocalForward

(

)

LocalForward() [2/2]

sshpp::LocalForward::LocalForward ( const LocalForward &  )

delete

Member Function Documentation

operator=()

LocalForward & sshpp::LocalForward::operator= ( const LocalForward &  )

delete

try_start()

SSHPP_INLINE Result< void > sshpp::LocalForward::try_start

(

)

stop()

SSHPP_INLINE void sshpp::LocalForward::stop ( )

noexcept

running()

bool sshpp::LocalForward::running ( ) const

inlinenoexcept

local_endpoint()

SSHPP_INLINE TcpEndpoint sshpp::LocalForward::local_endpoint ( ) const

noexcept

stats()

SSHPP_INLINE ForwardStats sshpp::LocalForward::stats ( ) const

noexcept

try_run_until_stopped()

SSHPP_INLINE Result< void > sshpp::LocalForward::try_run_until_stopped

(

)

Drives the accept loop on the calling thread instead of spawning one.

---

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

• include/sshpp/forwarding.hpp
• include/sshpp/detail/forwarding.ipp