<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Returns numeric file descriptor of a socket, or stream</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventutil.getlastsocketerror.html">EventUtil::getLastSocketError</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventutil.getsocketname.html">EventUtil::getSocketName</a></div>
<div class="up"><a href="class.eventutil.html">EventUtil</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="eventutil.getsocketfd" class="refentry">
<div class="refnamediv">
<h1 class="refname">EventUtil::getSocketFd</h1>
<p class="verinfo">(PECL event >= 1.7.0)</p><p class="refpurpose"><span class="refname">EventUtil::getSocketFd</span> — <span class="dc-title">Returns numeric file descriptor of a socket, or stream</span></p>
</div>
<div class="refsect1 description" id="refsect1-eventutil.getsocketfd-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="modifier">static</span>
<span class="type">int</span>
<span class="methodname"><strong>EventUtil::getSocketFd</strong></span>
( <span class="methodparam">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
<code class="parameter">$socket</code>
</span>
)</div>
<p class="para rdfs-comment">
Returns numeric file descriptor of a socket or stream specified by
<em><code class="parameter">socket</code></em>
argument just like the
<em>Event</em>
extension does it internally for all methods accepting socket resource or
stream.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-eventutil.getsocketfd-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term">
<em><code class="parameter">socket</code></em>
</span>
<dd>
<p class="para">
Socket resource or stream.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-eventutil.getsocketfd-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success. Otherwise <strong><code>FALSE</code></strong>.
<span class="methodname"><strong>EventUtil::getSocketFd()</strong></span>
returns <strong><code>FALSE</code></strong> in case if it is whether failed to recognize the type of
the underlying file, or detected that the file descriptor associated with
<em><code class="parameter">socket</code></em>
is not valid.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventutil.getlastsocketerror.html">EventUtil::getLastSocketError</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventutil.getsocketname.html">EventUtil::getSocketName</a></div>
<div class="up"><a href="class.eventutil.html">EventUtil</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
