wpi::net::uv::WorkReq Class Reference

Work request. More...

#include <wpi/net/uv/Work.hpp>

Inheritance diagram for wpi::net::uv::WorkReq:

Public Member Functions
	WorkReq ()
Loop &	GetLoop () const
Public Member Functions inherited from wpi::net::uv::RequestImpl< WorkReq, uv_work_t >
std::shared_ptr< WorkReq >	shared_from_this ()
uv_work_t *	GetRaw () noexcept
	Get the underlying request data structure.
Public Member Functions inherited from wpi::net::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.
const char *	GetTypeName () const noexcept
	Get the name of the type of the request.
bool	Cancel ()
	Cancel a pending request.
size_t	RawSize () const noexcept
	Return the size of the underlying request type.
uv_req_t *	GetRawReq () noexcept
	Get the underlying request data structure.
const uv_req_t *	GetRawReq () const noexcept
	Get the underlying request data structure.
virtual void	Keep () noexcept
	Keep this request in memory even if no outside shared_ptr references remain.
virtual std::shared_ptr< Request >	Release () noexcept
	No longer force holding this request in memory.
void	ReportError (int err)
	Report an error.

Public Attributes
wpi::util::sig::Signal	work
	Function(s) that will be run on the thread pool.
wpi::util::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.
Public Attributes inherited from wpi::net::uv::Request
std::function< void(Error)>	error
	Error callback.

Additional Inherited Members
Public Types inherited from wpi::net::uv::Request
using	Type = uv_req_type
Protected Member Functions inherited from wpi::net::uv::RequestImpl< WorkReq, uv_work_t >
	RequestImpl ()
	Constructor.
Protected Member Functions inherited from wpi::net::uv::Request
	Request (uv_req_t *uv_req)
	Constructor.

Detailed Description

Work request.

For use with QueueWork() function family.

Constructor & Destructor Documentation

WorkReq()

wpi::net::uv::WorkReq::WorkReq

(

)

Member Function Documentation

GetLoop()

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

inline

Member Data Documentation

afterWork

wpi::util::sig::Signal wpi::net::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.

work

wpi::util::sig::Signal wpi::net::uv::WorkReq::work

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

---

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

• wpi/net/uv/Work.hpp