socket_read

(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)

socket_read — Lê um máximo de bytes de um soquete

Descrição

socket_read(Socket $socket, int $length, int $mode = PHP_BINARY_READ): string|false

A função socket_read() lê da instância Socket, o socket criado pelas funções socket_create() ou socket_accept().

Parâmetros

socket

Uma instância de Socket criada com socket_create() ou socket_accept().

length

O número máximo de bytes lidos é especificado pelo parâmetro length. De outra forma, podem ser usados os caracteres \r, \n, ou \0 para encerrar a leitura (dependendo do parâmetro mode, veja abaixo).

mode

O parâmetro opcional mode é uma constante nomeada:

  • PHP_BINARY_READ (Padrão) - usa a função de sistema recv(). Segura para ler dados binários.
  • PHP_NORMAL_READ - a leitura é interrompida em \n ou \r.

Valor Retornado

socket_read() retorna os dados como uma string em caso de sucesso, ou false em caso de erro (inclusive se o servidor remoto tiver fechado a conexão). O código de erro pode ser recuperado com socket_last_error(). Este código pode ser passado para socket_strerror() para obter uma representação textual do erro.

Note:

socket_read() retorna uma string de comprimento zero ("") quando não houver mais dados para leitura.

Registro de Alterações

Versão Descrição
8.0.0 O parâmetro socket agora espera uma instância de Socket; anteriormente, um resource era esperado.

Veja Também