Files
archived-doc-pt-br/reference/sockets/functions/socket-set-block.xml
leonardolara 4f8b0072ed update rev tag
2024-09-17 14:35:37 -03:00

124 lines
3.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 14dc7c47365f2b71f6c907a5ba5bccf42534d5a9 Maintainer: leonardolara Status: ready -->
<refentry xml:id="function.socket-set-block" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>socket_set_block</refname>
<refpurpose>Define o modo de bloqueio em um soquete</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>socket_set_block</methodname>
<methodparam><type>Socket</type><parameter>socket</parameter></methodparam>
</methodsynopsis>
<para>
A função <function>socket_set_block</function> remove o sinalizador
<constant>O_NONBLOCK</constant> no soquete especificado pelo
parâmetro <parameter>socket</parameter>.
</para>
<para>
Quando uma operação (ex.: receber, enviar, conectar, aceitar, ...) é executada em
um soquete bloqueante, o script pausará sua execução até receber
um sinal ou poder realizar a operação.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>socket</parameter></term>
<listitem>
<para>
Uma instância de <classname>Socket</classname> criada com <function>socket_create</function>
ou <function>socket_accept</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&sockets.changelog.socket-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemplo de <function>socket_set_block</function></title>
<programlisting role="php">
<![CDATA[
<?php
$socket = socket_create_listen(1223);
socket_set_block($socket);
socket_accept($socket);
?>
]]>
</programlisting>
<para>
Este exemplo cria um soquete de escuta em todas as interfaces na porta 1223 e
define o soquete para o modo <constant>O_BLOCK</constant>.
<function>socket_accept</function> irá travar até que haja uma conexão
para aceitar.
</para>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>socket_set_nonblock</function></member>
<member><function>socket_set_option</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->