sshpp::detail::SessionCore Class Reference

#include <session_core.hpp>

Public Member Functions
	SessionCore (native_session raw) noexcept
	~SessionCore ()
	SessionCore (const SessionCore &)=delete
SessionCore &	operator= (const SessionCore &)=delete
native_session	raw () const noexcept
std::recursive_mutex &	mutex () noexcept
bool	valid () const noexcept
void	replace (native_session raw) noexcept
	Replaces the underlying ssh_session (used by Session::try_reconnect()).
void	request_cancel () noexcept
void	clear_cancel () noexcept
bool	cancel_requested () const noexcept

Detailed Description

Non-copyable, non-movable; always heap-allocated and shared. Owns exactly one ssh_session and guarantees it outlives every Channel/Sftp/Scp derived from it. See docs/design/02 §2.2.

Constructor & Destructor Documentation

SessionCore() [1/2]

sshpp::detail::SessionCore::SessionCore ( native_session  raw )

inlineexplicitnoexcept

~SessionCore()

SSHPP_INLINE sshpp::detail::SessionCore::~SessionCore

(

)

SessionCore() [2/2]

sshpp::detail::SessionCore::SessionCore ( const SessionCore &  )

delete

Member Function Documentation

operator=()

SessionCore & sshpp::detail::SessionCore::operator= ( const SessionCore &  )

delete

raw()

native_session sshpp::detail::SessionCore::raw ( ) const

inlinenoexcept

mutex()

std::recursive_mutex & sshpp::detail::SessionCore::mutex ( )

inlinenoexcept

valid()

bool sshpp::detail::SessionCore::valid ( ) const

inlinenoexcept

replace()

SSHPP_INLINE void sshpp::detail::SessionCore::replace ( native_session  raw )

noexcept

Replaces the underlying ssh_session (used by Session::try_reconnect()).

request_cancel()

void sshpp::detail::SessionCore::request_cancel ( )

inlinenoexcept

clear_cancel()

void sshpp::detail::SessionCore::clear_cancel ( )

inlinenoexcept

cancel_requested()

bool sshpp::detail::SessionCore::cancel_requested ( ) const

inlinenoexcept

---

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

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