<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sockets.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.socket-atmark.php',
    1 => 'socket_atmark',
    2 => 'Determina se o soquete est&aacute; na marca fora-de-banda',
  ),
  'up' => 
  array (
    0 => 'ref.sockets.php',
    1 => 'Fun&ccedil;&otilde;es de Socket',
  ),
  'prev' => 
  array (
    0 => 'function.socket-addrinfo-lookup.php',
    1 => 'socket_addrinfo_lookup',
  ),
  'next' => 
  array (
    0 => 'function.socket-bind.php',
    1 => 'socket_bind',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/sockets/functions/socket-atmark.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.socket-atmark" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">socket_atmark</h1>
  <p class="verinfo">(PHP 8 &gt;= 8.3.0, PHP 8)</p><p class="refpurpose"><span class="refname">socket_atmark</span> &mdash; <span class="dc-title">Determina se o soquete está na marca fora-de-banda</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.socket-atmark-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>socket_atmark</strong></span>(<span class="methodparam"><span class="type"><a href="class.socket.php" class="type Socket">Socket</a></span> <code class="parameter">$socket</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Determina se o soquete informado em <code class="parameter">socket</code> está na marca fora-de-banda.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.socket-atmark-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">socket</code></dt>
     <dd>
      <p class="para">
       Uma instância de <span class="classname"><a href="class.socket.php" class="classname">Socket</a></span> criada com <span class="function"><a href="function.socket-create.php" class="function">socket_create()</a></span>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.socket-atmark-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> em caso de sucesso ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.socket-atmark-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Usando <span class="function"><strong>socket_atmark()</strong></span> para verificar se o soquete está pronto para ler dados fora-de-banda</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$socketServer </span><span style="color: #007700">= </span><span style="color: #0000BB">socket_create</span><span style="color: #007700">( </span><span style="color: #0000BB">AF_INET</span><span style="color: #007700">, </span><span style="color: #0000BB">SOCK_STREAM</span><span style="color: #007700">, </span><span style="color: #0000BB">SOL_TCP </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">socket_set_option</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketServer</span><span style="color: #007700">, </span><span style="color: #0000BB">SOL_SOCKET</span><span style="color: #007700">, </span><span style="color: #0000BB">SO_REUSEADDR</span><span style="color: #007700">, </span><span style="color: #0000BB">1 </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">socket_bind</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketServer</span><span style="color: #007700">, </span><span style="color: #DD0000">'127.0.0.1' </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">socket_listen</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketServer </span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$socketClient </span><span style="color: #007700">= </span><span style="color: #0000BB">socket_create</span><span style="color: #007700">( </span><span style="color: #0000BB">AF_INET</span><span style="color: #007700">, </span><span style="color: #0000BB">SOCK_STREAM</span><span style="color: #007700">, </span><span style="color: #0000BB">SOL_TCP </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">socket_getsockname</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketServer</span><span style="color: #007700">, </span><span style="color: #0000BB">$stAddr</span><span style="color: #007700">, </span><span style="color: #0000BB">$uPort </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">socket_connect</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketClient</span><span style="color: #007700">, </span><span style="color: #0000BB">$stAddr</span><span style="color: #007700">, </span><span style="color: #0000BB">$uPort </span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$socket </span><span style="color: #007700">= </span><span style="color: #0000BB">socket_accept</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketServer </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">socket_shutdown</span><span style="color: #007700">( </span><span style="color: #0000BB">$socket</span><span style="color: #007700">, </span><span style="color: #0000BB">1 </span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$st </span><span style="color: #007700">= </span><span style="color: #DD0000">'Estes são dados normais.'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">socket_send</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketClient</span><span style="color: #007700">, </span><span style="color: #0000BB">$st</span><span style="color: #007700">, </span><span style="color: #0000BB">strlen</span><span style="color: #007700">( </span><span style="color: #0000BB">$st </span><span style="color: #007700">), </span><span style="color: #0000BB">0 </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$st </span><span style="color: #007700">= </span><span style="color: #DD0000">'!'</span><span style="color: #007700">; </span><span style="color: #FF8000"># TCP permite somente um byte de dados urgentes.<br /></span><span style="color: #0000BB">socket_send</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketClient</span><span style="color: #007700">, </span><span style="color: #0000BB">$st</span><span style="color: #007700">, </span><span style="color: #0000BB">strlen</span><span style="color: #007700">( </span><span style="color: #0000BB">$st </span><span style="color: #007700">), </span><span style="color: #0000BB">MSG_OOB </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$st </span><span style="color: #007700">= </span><span style="color: #DD0000">'Não tão urgente.'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">socket_send</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketClient</span><span style="color: #007700">, </span><span style="color: #0000BB">$st</span><span style="color: #007700">, </span><span style="color: #0000BB">strlen</span><span style="color: #007700">( </span><span style="color: #0000BB">$st </span><span style="color: #007700">), </span><span style="color: #0000BB">0 </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">socket_shutdown</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketClient </span><span style="color: #007700">);<br /><br />do {<br />    if ( </span><span style="color: #0000BB">socket_atmark</span><span style="color: #007700">( </span><span style="color: #0000BB">$socket </span><span style="color: #007700">) ) {<br />        </span><span style="color: #0000BB">$rc </span><span style="color: #007700">= </span><span style="color: #0000BB">socket_recv</span><span style="color: #007700">( </span><span style="color: #0000BB">$socket</span><span style="color: #007700">, </span><span style="color: #0000BB">$st</span><span style="color: #007700">, </span><span style="color: #0000BB">65536</span><span style="color: #007700">, </span><span style="color: #0000BB">MSG_OOB </span><span style="color: #007700">);<br />        echo </span><span style="color: #DD0000">"Dados urgentes recebidos: (</span><span style="color: #007700">{</span><span style="color: #0000BB">$rc</span><span style="color: #007700">}</span><span style="color: #DD0000">) </span><span style="color: #007700">{</span><span style="color: #0000BB">$st</span><span style="color: #007700">}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />    } else {<br />        </span><span style="color: #0000BB">$rc </span><span style="color: #007700">= </span><span style="color: #0000BB">socket_recv</span><span style="color: #007700">( </span><span style="color: #0000BB">$socket</span><span style="color: #007700">, </span><span style="color: #0000BB">$st</span><span style="color: #007700">, </span><span style="color: #0000BB">1024</span><span style="color: #007700">, </span><span style="color: #0000BB">0 </span><span style="color: #007700">);<br />        echo </span><span style="color: #DD0000">"Dados normais recebidos: (</span><span style="color: #007700">{</span><span style="color: #0000BB">$rc</span><span style="color: #007700">}</span><span style="color: #DD0000">) </span><span style="color: #007700">{</span><span style="color: #0000BB">$st</span><span style="color: #007700">}</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />    }<br />} while ( </span><span style="color: #0000BB">$rc </span><span style="color: #007700">&gt; </span><span style="color: #0000BB">0 </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">socket_close</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketServer </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">socket_close</span><span style="color: #007700">( </span><span style="color: #0000BB">$socketClient </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">socket_close</span><span style="color: #007700">( </span><span style="color: #0000BB">$socket </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Received normal data: (20) Estes são dados normais.
Received urgent data: (1) !
Received normal data: (14) Não tão urgente.
Received normal data: (0)</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.socket-atmark-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.socket-connect.php" class="function" rel="rdfs-seeAlso">socket_connect()</a> - Inicia uma conex&atilde;o em um soquete</span></li>
    <li><span class="function"><a href="function.socket-create.php" class="function" rel="rdfs-seeAlso">socket_create()</a> - Cria um soquete (ponto de extremidade para comuni&ccedil;&atilde;o)</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>