Getaddrinfo request type. More...

#include "request-dns.hpp"

Inheritance diagram for uv::getaddrinfo:

Public Types
using	uv_t = ::uv_getaddrinfo_t

using	on_request_t = std::function< void(getaddrinfo _request) >
	The function type of the callback called with the `getaddrinfo` request result once complete. More...

Public Types inherited from uv::request
using	uv_t = ::uv_req_t

using	on_destroy_t = std::function< void(void *_data) >
	The function type of the callback called when the request object is about to be destroyed.

Public Member Functions
	getaddrinfo (const getaddrinfo &)=default

getaddrinfo &	operator= (const getaddrinfo &)=default

	getaddrinfo (getaddrinfo &&) noexcept=default

getaddrinfo &	operator= (getaddrinfo &&) noexcept=default

on_request_t &	on_request () const noexcept

uv::loop	loop () const noexcept
	The libuv loop that started this `getaddrinfo` request and where completion will be reported. More...

const ::addrinfo *	addrinfo () const noexcept
	The pointer to a `struct addrinfo` containing the request result.

int	run (uv::loop &_loop, const char _hostname, const char _service, const ::addrinfo &_hints)
	Run the request. More...

int	run (uv::loop &_loop, const char _hostname, const char _service)
	Idem with empty `_hints`.

	operator const uv_t * () const noexcept

	operator uv_t * () noexcept

Public Member Functions inherited from uv::request
	request (const request &_that)

request &	operator= (const request &_that)

	request (request &&_that) noexcept

request &	operator= (request &&_that) noexcept

void	swap (request &_that) noexcept

std::uintptr_t	id () const noexcept

long	nrefs () const noexcept
	The current number of existing references to the same object as this request variable refers to.

int	uv_status () const noexcept
	The status value returned by the last executed libuv API function on this request.

on_destroy_t &	on_destroy () const noexcept

::uv_req_type	type () const noexcept
	The tag indicating a libuv type of the request. More...

const char *	type_name () const noexcept
	A string containing the name of the request type.

void *const &	data () const noexcept
	The pointer to the user-defined arbitrary data. libuv and uvcc does not use this field.

void *&	data () noexcept

int	cancel () noexcept
	Cancel a pending request. More...

	operator const uv_t * () const noexcept

	operator uv_t * () noexcept

	operator bool () const noexcept
	Equivalent to `(uv_status() >= 0)`.

Detailed Description

Getaddrinfo request type.

See also: libuv API documentation: DNS utility functions.

Definition at line 22 of file request-dns.hpp.

Member Typedef Documentation

◆ on_request_t

using uv::getaddrinfo::on_request_t = std::function< void(getaddrinfo _request) >

The function type of the callback called with the getaddrinfo request result once complete.

See also: libuv API documentation: uv_getaddrinfo_cb.

Definition at line 32 of file request-dns.hpp.

Member Function Documentation

◆ loop()

uv::loop uv::getaddrinfo::loop ( ) const

inlinenoexcept

The libuv loop that started this getaddrinfo request and where completion will be reported.

It is guaranteed that it will be a valid instance at least within the request callback.

Definition at line 112 of file request-dns.hpp.

◆ run()

int uv::getaddrinfo::run	(	uv::loop &	_loop,
		const char *	_hostname,
		const char *	_service,
		const ::addrinfo &	_hints
	)

inline

Run the request.

For supplying _hints argument the appropriate helper function for Network-related structures initialization can be utilized.

See also: libuv API documentation: uv_getaddrinfo().

Note: If the request callback is empty (has not been set), the request runs synchronously (and _loop parameter is ignored).

Definition at line 122 of file request-dns.hpp.

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

request-dns.hpp