sshpp::Event Class Reference

Poll-loop integration seam around ssh_event. See docs/design/05 §5.5. More...

#include <event.hpp>

Public Member Functions
	Event ()
	~Event ()
	Event (Event &&) noexcept
Event &	operator= (Event &&) noexcept
	Event (const Event &)=delete
Result< void >	try_add_session (Session &)
Result< void >	try_remove_session (Session &)
Result< void >	try_poll (std::chrono::milliseconds timeout)
	SSH_OK / SSH_AGAIN(timeout) / SSH_ERROR.
native_event	native_handle () const noexcept

Detailed Description

Poll-loop integration seam around ssh_event. See docs/design/05 §5.5.

Constructor & Destructor Documentation

Event() [1/3]

SSHPP_INLINE sshpp::Event::Event

(

)

~Event()

SSHPP_INLINE sshpp::Event::~Event

(

)

Event() [2/3]

SSHPP_INLINE sshpp::Event::Event ( Event &&  other )

noexcept

Event() [3/3]

sshpp::Event::Event ( const Event &  )

delete

Member Function Documentation

operator=()

SSHPP_INLINE Event & sshpp::Event::operator= ( Event &&  other )

noexcept

try_add_session()

SSHPP_INLINE Result< void > sshpp::Event::try_add_session

(

Session &

session

)

try_remove_session()

SSHPP_INLINE Result< void > sshpp::Event::try_remove_session

(

Session &

session

)

try_poll()

SSHPP_INLINE Result< void > sshpp::Event::try_poll

(

std::chrono::milliseconds

timeout

)

SSH_OK / SSH_AGAIN(timeout) / SSH_ERROR.

native_handle()

native_event sshpp::Event::native_handle ( ) const

inlinenoexcept

---

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

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