Utilities

Classes
struct	uvco::UvHandleDeleter
class	uvco::LifetimeTracker< T >
class	uvco::FlagGuard
class	uvco::ZeroAtExit< T >

Typedefs
using	uvco::uv_status = int
	Result of a libuv operation, an errno error code.

Functions
void	uvco::allocator (uv_handle_t *, size_t sugg, uv_buf_t *buf)
	libuv allocator.
void	uvco::freeUvBuf (const uv_buf_t *buf)
template<typename R, typename F> requires std::is_invocable_r_v<R, F, std::string_view>
R	uvco::callWithNullTerminated (std::string_view view, F &&f)
template<typename Into, typename Handle>
Into *	uvco::getData (const Handle *handle)
	Obtain data pointer set on handle with nullptr check and type cast.
template<typename Into, typename Handle>
Into *	uvco::getDataOrNull (const Handle *handle)
template<typename Into, typename Request>
Into *	uvco::getRequestData (const Request *req)
	Obtain data pointer set on request with nullptr check and type cast.
template<typename Into, typename Request>
Into *	uvco::getRequestDataOrNull (const Request *req)
template<typename Handle, typename Data>
void	uvco::setData (Handle *handle, Data *data)
	Obtain data pointer set on request with type cast. Data may be nullptr.
template<typename Handle>
void	uvco::resetData (Handle *handle)
	Reset data pointer on handle to nullptr.
template<typename Request, typename Data>
void	uvco::setRequestData (Request *req, Data *data)
	Set data pointer on request.
template<typename Request>
void	uvco::resetRequestData (Request *req)
template<typename Handle>
bool	uvco::dataIsNull (Handle *handle)
	Check if handle data is null.
template<typename Request>
bool	uvco::requestDataIsNull (Request *req)
	Check if request data is null.

Variables
const bool	uvco::TRACK_LIFETIMES = true

Detailed Description

Typedef Documentation

uv_status

using uvco::uv_status = int

Result of a libuv operation, an errno error code.

Function Documentation

allocator()

void uvco::allocator	(	uv_handle_t *	,
		size_t	sugg,
		uv_buf_t *	buf )

libuv allocator.

                                                            {
  constexpr static size_t defaultSize = 4080;
  const size_t size = std::min(defaultSize, sugg);
  char *underlying = new char[size];
  buf->base = underlying;
  buf->len = size;
}

callWithNullTerminated()

template<typename R, typename F>
requires std::is_invocable_r_v<R, F, std::string_view>

R uvco::callWithNullTerminated	(	std::string_view	view,
		F &&	f )

                                                     {
  if (view.data()[view.size()] == '\0') {
    return f(view.data());
  }
  std::string str(view);
  return f(str.c_str());
}

dataIsNull()

template<typename Handle>

bool uvco::dataIsNull

(

Handle *

handle

)

Check if handle data is null.

                                                           {
  BOOST_ASSERT(handle != nullptr);
  return nullptr == uv_handle_get_data((const uv_handle_t *)handle);
}

freeUvBuf()

void uvco::freeUvBuf

(

const uv_buf_t *

buf

)

                                    {
  if (buf) {
    delete[] buf->base;
  }
}

getData()

template<typename Into, typename Handle>

Into * uvco::getData

(

const Handle *

handle

)

Obtain data pointer set on handle with nullptr check and type cast.

                                                                              {
  BOOST_ASSERT(handle != nullptr);
  const void *data = uv_handle_get_data((const uv_handle_t *)handle);
  BOOST_ASSERT(nullptr != data);
  return (Into *)data;
}

getDataOrNull()

template<typename Into, typename Handle>

Into * uvco::getDataOrNull

(

const Handle *

handle

)

Obtain data pointer set on handle with type cast. Returns nullptr if no data is set.

                                          {
  BOOST_ASSERT(handle != nullptr);
  const void *data = uv_handle_get_data((const uv_handle_t *)handle);
  return (Into *)data;
}

getRequestData()

template<typename Into, typename Request>

Into * uvco::getRequestData

(

const Request *

req

)

Obtain data pointer set on request with nullptr check and type cast.

                                         {
  BOOST_ASSERT(req != nullptr);
  const void *data = uv_req_get_data((const uv_req_t *)req);
  BOOST_ASSERT(nullptr != data);
  return (Into *)data;
}

getRequestDataOrNull()

template<typename Into, typename Request>

Into * uvco::getRequestDataOrNull

(

const Request *

req

)

Obtain data pointer set on request with type cast. Returns nullptr if data is nullptr.

                                               {
  BOOST_ASSERT(req != nullptr);
  const void *data = uv_req_get_data((const uv_req_t *)req);
  return (Into *)data;
}

requestDataIsNull()

template<typename Request>

bool uvco::requestDataIsNull

(

Request *

req

)

Check if request data is null.

                                                                 {
  return nullptr == uv_req_get_data((const uv_req_t *)req);
}

resetData()

template<typename Handle>

void uvco::resetData

(

Handle *

handle

)

Reset data pointer on handle to nullptr.

                                                          {
  BOOST_ASSERT(handle != nullptr);
  uv_handle_set_data((uv_handle_t *)handle, nullptr);
}

resetRequestData()

template<typename Request>

void uvco::resetRequestData

(

Request *

req

)

                                                                {
  BOOST_ASSERT(req != nullptr);
  uv_req_set_data((uv_req_t *)req, (void *)nullptr);
}

setData()

template<typename Handle, typename Data>

void uvco::setData	(	Handle *	handle,
		Data *	data )

Obtain data pointer set on request with type cast. Data may be nullptr.

                                         {
  BOOST_ASSERT(handle != nullptr);
  uv_handle_set_data((uv_handle_t *)handle, (void *)data);
}

setRequestData()

template<typename Request, typename Data>

void uvco::setRequestData	(	Request *	req,
		Data *	data )

Set data pointer on request.

                                              {
  BOOST_ASSERT(req != nullptr);
  uv_req_set_data((uv_req_t *)req, (void *)data);
}

Variable Documentation

TRACK_LIFETIMES

const bool uvco::TRACK_LIFETIMES = true