uvw::uv_type< U > Struct Template Reference

Wrapper class for underlying types. More...

#include <uv_type.hpp>

Inheritance diagram for uvw::uv_type< U >:

Public Member Functions
virtual int	init ()
	Initializes the handle.
loop &	parent () const noexcept
	Gets the loop from which the resource was originated.
const U *	raw () const noexcept
	Gets the underlying raw data structure.
U *	raw () noexcept
	Gets the underlying raw data structure.

Detailed Description

template<typename U>
struct uvw::uv_type< U >

Wrapper class for underlying types.

It acts mainly as a wrapper around data structures of the underlying library.

Definition at line 18 of file uv_type.hpp.

Member Function Documentation

init()

template<typename U >

virtual int uvw::uv_type< U >::init ( )

inlinevirtual

Initializes the handle.

Returns

Underlying return value.

Reimplemented in uvw::async_handle, uvw::check_handle, uvw::fs_event_handle, uvw::fs_poll_handle, uvw::idle_handle, uvw::pipe_handle, uvw::poll_handle, uvw::prepare_handle, uvw::process_handle, uvw::signal_handle, uvw::tcp_handle, uvw::timer_handle, uvw::tty_handle, and uvw::udp_handle.

Definition at line 32 of file uv_type.hpp.

parent()

template<typename U >

loop & uvw::uv_type< U >::parent ( ) const

inlinenoexcept

Gets the loop from which the resource was originated.

Returns

A reference to a loop instance.

Definition at line 40 of file uv_type.hpp.

raw() [1/2]

template<typename U >

const U * uvw::uv_type< U >::raw ( ) const

inlinenoexcept

Gets the underlying raw data structure.

This function should not be used, unless you know exactly what you are doing and what are the risks.
Going raw is dangerous, mainly because the lifetime management of a loop, a handle or a request is in charge to the library itself and users should not work around it.

Warning

Use this function at your own risk, but do not expect any support in case of bugs.

Returns

The underlying raw data structure.

Definition at line 59 of file uv_type.hpp.

raw() [2/2]

template<typename U >

U * uvw::uv_type< U >::raw ( )

inlinenoexcept

Gets the underlying raw data structure.

This function should not be used, unless you know exactly what you are doing and what are the risks.
Going raw is dangerous, mainly because the lifetime management of a loop, a handle or a request is in charge to the library itself and users should not work around it.

Warning

Use this function at your own risk, but do not expect any support in case of bugs.

Returns

The underlying raw data structure.

Definition at line 78 of file uv_type.hpp.

---

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

• src/uvw/uv_type.hpp