280 lines
13 KiB
HTML
280 lines
13 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.6"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>uvw: uvw::error_event Struct Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">uvw<span id="projectnumber"> 3.1.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceuvw.html">uvw</a></li><li class="navelem"><a class="el" href="structuvw_1_1error__event.html">error_event</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="structuvw_1_1error__event-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">uvw::error_event Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Error event.
|
|
<a href="structuvw_1_1error__event.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="emitter_8h_source.html">emitter.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a64a227b139846cb188d8ff426ac79f41"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1error__event.html#a64a227b139846cb188d8ff426ac79f41">what</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a64a227b139846cb188d8ff426ac79f41"><td class="mdescLeft"> </td><td class="mdescRight">Returns the error message for the given error code. <br /></td></tr>
|
|
<tr class="separator:a64a227b139846cb188d8ff426ac79f41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea5960a9b4f2e6069207bd803e3474d8"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1error__event.html#aea5960a9b4f2e6069207bd803e3474d8">name</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:aea5960a9b4f2e6069207bd803e3474d8"><td class="mdescLeft"> </td><td class="mdescRight">Returns the error name for the given error code. <br /></td></tr>
|
|
<tr class="separator:aea5960a9b4f2e6069207bd803e3474d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27768dc4d71ac80f40434d9ee1609a0c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1error__event.html#a27768dc4d71ac80f40434d9ee1609a0c">code</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a27768dc4d71ac80f40434d9ee1609a0c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the underlying error code, that is an error constant of <code>libuv</code>. <br /></td></tr>
|
|
<tr class="separator:a27768dc4d71ac80f40434d9ee1609a0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae13671678295b45be5ce08176e9cdd8a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1error__event.html#ae13671678295b45be5ce08176e9cdd8a">operator bool</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ae13671678295b45be5ce08176e9cdd8a"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the event contains a valid error code. <br /></td></tr>
|
|
<tr class="separator:ae13671678295b45be5ce08176e9cdd8a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a0ac19dc779909e62fba467774130b65c"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="structuvw_1_1error__event.html#a0ac19dc779909e62fba467774130b65c">translate</a> (int sys) noexcept</td></tr>
|
|
<tr class="memdesc:a0ac19dc779909e62fba467774130b65c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <code>libuv</code> error code equivalent to the given platform dependent error code. <br /></td></tr>
|
|
<tr class="separator:a0ac19dc779909e62fba467774130b65c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Error event. </p>
|
|
<p>Custom wrapper around error constants of <code>libuv</code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="emitter_8h_source.html#l00023">23</a> of file <a class="el" href="emitter_8h_source.html">emitter.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a27768dc4d71ac80f40434d9ee1609a0c" name="a27768dc4d71ac80f40434d9ee1609a0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27768dc4d71ac80f40434d9ee1609a0c">◆ </a></span>code()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int uvw::error_event::code </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the underlying error code, that is an error constant of <code>libuv</code>. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The underlying error code. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aea5960a9b4f2e6069207bd803e3474d8" name="aea5960a9b4f2e6069207bd803e3474d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aea5960a9b4f2e6069207bd803e3474d8">◆ </a></span>name()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char * uvw::error_event::name </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the error name for the given error code. </p>
|
|
<p>Leaks a few bytes of memory when you call it with an unknown error code.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The error name for the given error code. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae13671678295b45be5ce08176e9cdd8a" name="ae13671678295b45be5ce08176e9cdd8a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae13671678295b45be5ce08176e9cdd8a">◆ </a></span>operator bool()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uvw::error_event::operator bool </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if the event contains a valid error code. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0ac19dc779909e62fba467774130b65c" name="a0ac19dc779909e62fba467774130b65c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0ac19dc779909e62fba467774130b65c">◆ </a></span>translate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static int uvw::error_event::translate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>sys</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the <code>libuv</code> error code equivalent to the given platform dependent error code. </p>
|
|
<p>It returns:</p><ul>
|
|
<li>POSIX error codes on Unix (the ones stored in errno).</li>
|
|
<li>Win32 error codes on Windows (those returned by GetLastError() or WSAGetLastError()).</li>
|
|
</ul>
|
|
<p>If <code>sys</code> is already a <code>libuv</code> error code, it is simply returned.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sys</td><td>A platform dependent error code. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The <code>libuv</code> error code equivalent to the given platform dependent error code. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a64a227b139846cb188d8ff426ac79f41" name="a64a227b139846cb188d8ff426ac79f41"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a64a227b139846cb188d8ff426ac79f41">◆ </a></span>what()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char * uvw::error_event::what </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the error message for the given error code. </p>
|
|
<p>Leaks a few bytes of memory when you call it with an unknown error code.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The error message for the given error code. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>src/uvw/<a class="el" href="emitter_8h_source.html">emitter.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|