wpi::uv::Signal Class Reference

Signal handle. More...

#include <wpinet/uv/Signal.h>

Inheritance diagram for wpi::uv::Signal:

Public Member Functions
	Signal (const private_init &)
	~Signal () noexcept override=default
void	Start (int signum)
	Start watching for the given signal. More...
void	StartOneshot (int signum)
	Start watching for the given signal. More...
void	Stop ()
	Stop watching for the signal. More...
int	GetSignal () const
	Get the signal being monitored. More...
Public Member Functions inherited from wpi::uv::HandleImpl< Signal, uv_signal_t >
std::shared_ptr< Signal >	shared_from_this ()
std::shared_ptr< const Signal >	shared_from_this () const
uv_signal_t *	GetRaw () const noexcept
	Get the underlying handle data structure. More...
Public Member Functions inherited from wpi::uv::Handle
	Handle (const Handle &)=delete
	Handle (Handle &&)=delete
Handle &	operator= (const Handle &)=delete
Handle &	operator= (Handle &&)=delete
virtual	~Handle () noexcept
Type	GetType () const noexcept
	Get the type of the handle. More...
std::string_view	GetTypeName () const noexcept
	Get the name of the type of the handle. More...
std::shared_ptr< Loop >	GetLoop () const noexcept
	Get the loop where this handle runs. More...
Loop &	GetLoopRef () const noexcept
	Get the loop where this handle runs. More...
bool	IsActive () const noexcept
	Check if the handle is active. More...
bool	IsClosing () const noexcept
	Check if a handle is closing or closed. More...
void	Close () noexcept
	Request handle to be closed. More...
void	SetLoopClosing (bool loopClosing) noexcept
	Set if the loop is closing. More...
bool	IsLoopClosing () const noexcept
	Get the loop closing status. More...
void	Reference () noexcept
	Reference the given handle. More...
void	Unreference () noexcept
	Unreference the given handle. More...
bool	HasReference () const noexcept
	Check if the given handle is referenced. More...
size_t	RawSize () const noexcept
	Return the size of the underlying handle type. More...
uv_handle_t *	GetRawHandle () const noexcept
	Get the underlying handle data structure. More...
void	SetBufferAllocator (std::function< Buffer(size_t)> alloc, std::function< void(Buffer &)> dealloc)
	Set the functions used for allocating and releasing buffers. More...
void	FreeBuf (Buffer &buf) const noexcept
	Free a buffer. More...
template<typename T = void>
std::shared_ptr< T >	GetData () const
	Gets user-defined data. More...
void	SetData (std::shared_ptr< void > data)
	Sets user-defined data. More...
void	SetLogger (Logger *logger)
	Sets logger. More...
Logger *	GetLogger () const
	Gets logger. More...
void	ReportError (int err) const
	Report an error. More...

Static Public Member Functions
static std::shared_ptr< Signal >	Create (Loop &loop)
	Create a signal handle. More...
static std::shared_ptr< Signal >	Create (const std::shared_ptr< Loop > &loop)
	Create a signal handle. More...

Public Attributes
sig::Signal< int >	signal
	Signal generated when a signal occurs. More...
Public Attributes inherited from wpi::uv::Handle
sig::Signal< Error >	error
	Error signal. More...
sig::Signal	closed
	Closed signal. More...

Additional Inherited Members
Public Types inherited from wpi::uv::Handle
using	Type = uv_handle_type
Protected Member Functions inherited from wpi::uv::HandleImpl< Signal, uv_signal_t >
	HandleImpl ()
Protected Member Functions inherited from wpi::uv::Handle
	Handle (uv_handle_t *uv_handle)
void	Keep () noexcept
void	Release () noexcept
void	ForceClosed () noexcept
template<typename F , typename... Args>
bool	Invoke (F &&f, Args &&... args) const
Static Protected Member Functions inherited from wpi::uv::Handle
static void	AllocBuf (uv_handle_t *handle, size_t size, uv_buf_t *buf)
static void	DefaultFreeBuf (Buffer &buf)

Detailed Description

Signal handle.

Constructor & Destructor Documentation

Signal()

wpi::uv::Signal::Signal ( const private_init &  )

inlineexplicit

~Signal()

wpi::uv::Signal::~Signal ( )

overridedefaultnoexcept

Member Function Documentation

Create() [1/2]

static std::shared_ptr< Signal > wpi::uv::Signal::Create ( const std::shared_ptr< Loop > &  loop )

inlinestatic

Create a signal handle.

Parameters

loop	Loop object where this handle runs.

Create() [2/2]

static std::shared_ptr< Signal > wpi::uv::Signal::Create ( Loop &  loop )

static

Create a signal handle.

Parameters

loop	Loop object where this handle runs.

GetSignal()

int wpi::uv::Signal::GetSignal ( ) const

inline

Get the signal being monitored.

Returns

Signal number.

Start()

void wpi::uv::Signal::Start

(

int

signum

)

Start watching for the given signal.

Parameters

signum

Signal to watch for.

StartOneshot()

void wpi::uv::Signal::StartOneshot

(

int

signum

)

Start watching for the given signal.

Same as Start() but the signal handler is reset the moment the signal is received.

Parameters

signum

Signal to watch for.

Stop()

void wpi::uv::Signal::Stop ( )

inline

Stop watching for the signal.

Member Data Documentation

signal

sig::Signal<int> wpi::uv::Signal::signal

Signal generated when a signal occurs.

---

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

• wpinet/uv/Signal.h