uvw 3.1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
uvw::request< T, U, E > Class Template Reference

Request base class. More...

#include <request.hpp>

Inheritance diagram for uvw::request< T, U, E >:
Inheritance graph
[legend]
Collaboration diagram for uvw::request< T, U, E >:
Collaboration graph
[legend]

Public Member Functions

int cancel ()
 Cancels a pending request.
 
std::size_t size () const noexcept
 Returns the size of the underlying request type.
 
- Public Member Functions inherited from uvw::resource< T, U, E... >
std::shared_ptr< R > data () const
 Gets user-defined data. uvw won't use this field in any case.
 
void data (std::shared_ptr< void > udata)
 Sets arbitrary data. uvw won't use this field in any case.
 
- Public Member Functions inherited from uvw::uv_type< U >
virtual int init ()
 Initializes the handle.
 
loopparent () 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.
 
- Public Member Functions inherited from uvw::emitter< T, E... >
void on (listener_t< U > f)
 Registers a long-lived listener with the event emitter.
 
void reset () noexcept
 Disconnects the listener for the given event type.
 
void reset () noexcept
 Disconnects all listeners.
 
bool has () const noexcept
 Checks if there is a listener registered for the specific event.
 

Detailed Description

template<typename T, typename U, typename... E>
class uvw::request< T, U, E >

Request base class.

Base type for all uvw request types.

Definition at line 19 of file request.hpp.

Member Function Documentation

◆ cancel()

template<typename T , typename U , typename... E>
int uvw::request< T, U, E >::cancel ( )
inline

Cancels a pending request.

This method fails if the request is executing or has finished executing.

See the official documentation for further details.

Returns
Underlying return value.

Definition at line 42 of file request.hpp.

◆ size()

template<typename T , typename U , typename... E>
std::size_t uvw::request< T, U, E >::size ( ) const
inlinenoexcept

Returns the size of the underlying request type.

Returns
The size of the underlying request type.

Definition at line 50 of file request.hpp.


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