Work request. More...

Inheritance diagram for wpi::uv::WorkReq:

Public Member Functions
	WorkReq ()

Loop &	GetLoop () const

Public Member Functions inherited from wpi::uv::RequestImpl< WorkReq, uv_work_t >
std::shared_ptr< WorkReq >	shared_from_this ()

std::shared_ptr< const WorkReq >	shared_from_this () const

uv_work_t *	GetRaw () noexcept
	Get the underlying request data structure. More...

const uv_work_t *	GetRaw () const noexcept
	Get the underlying request data structure. More...

Public Member Functions inherited from wpi::uv::Request
	Request (const Request &)=delete

	Request (Request &&)=delete

Request &	operator= (const Request &)=delete

Request &	operator= (Request &&)=delete

virtual	~Request () noexcept=default

Type	GetType () const noexcept
	Get the type of the request. More...

const char *	GetTypeName () const noexcept
	Get the name of the type of the request. More...

bool	Cancel ()
	Cancel a pending request. More...

size_t	RawSize () const noexcept
	Return the size of the underlying request type. More...

uv_req_t *	GetRawReq () noexcept
	Get the underlying request data structure. More...

const uv_req_t *	GetRawReq () const noexcept
	Get the underlying request data structure. More...

virtual void	Keep () noexcept
	Keep this request in memory even if no outside shared_ptr references remain. More...

virtual std::shared_ptr< Request >	Release () noexcept
	No longer force holding this request in memory. More...

void	ReportError (int err)
	Report an error. More...

Public Attributes
sig::Signal	work
	Function(s) that will be run on the thread pool. More...

sig::Signal	afterWork
	Function(s) that will be run on the loop thread after the work on the thread pool has been completed by the work callback. More...

Public Attributes inherited from wpi::uv::Request
std::function< void(Error)>	error
	Error callback. More...

Additional Inherited Members
Public Types inherited from wpi::uv::Request
using	Type = uv_req_type

Protected Member Functions inherited from wpi::uv::RequestImpl< WorkReq, uv_work_t >
	RequestImpl ()
	Constructor. More...

Protected Member Functions inherited from wpi::uv::Request
	Request (uv_req_t *uv_req)
	Constructor. More...

Detailed Description

Work request.

For use with QueueWork() function family.

Constructor & Destructor Documentation

wpi::uv::WorkReq::WorkReq ( )

Loop & wpi::uv::WorkReq::GetLoop ( ) const

inline

sig::Signal wpi::uv::WorkReq::afterWork

Function(s) that will be run on the loop thread after the work on the thread pool has been completed by the work callback.

sig::Signal wpi::uv::WorkReq::work

Function(s) that will be run on the thread pool.

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