Descrição

fsockopen(
    string $hostname,
    int $port = -1,
    int &$error_code = null,
    string &$error_message = null,
    ?float $timeout = null
): resource|false

Inicia uma conexão socket para o recurso especificado em hostname.

O PHP suporta destinos na Internet ou domínios Unix, conforme descrito em Lista de Transportes via Soquete Suportados. Uma lista dos transportes suportados pode ser encontrada utilizando-se a função stream_get_transports().

Por padrão, o socket será aberto em modo de bloqueio. Pode-se mudar para o modo de não-bloqueio utilizando-se a função stream_set_blocking().

A função stream_socket_client() é similar mas fornece um número maior de opções, incluindo conexão não bloqueada e a habilidade de fornecer um contexto de fluxo.

Parâmetros

hostname

Se o suporte Open SSL estiver instalado, pode-se prefixar o hostname com ssl:// ou tls:// para utilizar uma conexão SSL ou TLS sobre TCP/IP para conectar-se ao servidor remoto.

port

O número da porta. Pode ser omitido e ignorado com -1 para transportes que não usam portas, como unix://.

error_code

Se informado, guarda o número do erro do sistema que aconteceu na chamada de connect() no nível do sistema.

Se o valor retornado em error_code for 0 e a função retornou false, é uma indicação que o erro aconteceu antes da chamada a connect(). A causa mais provável é um problema na inicialização do socket.

error_message

A mensagem de erro como uma string.

timeout

Limite de tempo de conexão, em segundos. Quando igual a null, a configuração default_socket_timeout php.ini é usada.

Nota:
Se for necessário um limite de tempo para ler/escrever dados através do socket, use stream_set_timeout(), já que o parâmetro timeout de fsockopen() somente é aplicável enquanto o socket estiver conectando.

Valor Retornado

fsockopen() retorna um ponteiro de arquivo que pode ser usado em em conjunto com outras funções de arquivo (como fgets(), fgetss(), fwrite(), fclose() e feof()). Se a chamada falhar, ela retornará false.

Erros/Exceções

Dispara um E_WARNING se hostname não for um domínio válido.

Registro de Alterações

Versão	Descrição
8.0.0	`timeout` agora pode ser nulo.

Exemplos

Exemplo #1 Exemplo de fsockopen()

<?php
$fp = fsockopen("www.example.com", 80, $errno, $errstr, 30);
if (!$fp) {
    echo "$errstr ($errno)<br />\n";
} else {
    $out = "GET / HTTP/1.1\r\n";
    $out .= "Host: www.example.com\r\n";
    $out .= "Connection: Close\r\n\r\n";
    fwrite($fp, $out);
    while (!feof($fp)) {
        echo fgets($fp, 128);
    }
    fclose($fp);
}
?>

Exemplo #2 Utilizando conexão UDP

O exemplo abaixo mostra como obter a data e o horário do serviço UDP (porta 13) da própria máquina.

<?php
$fp = fsockopen("udp://127.0.0.1", 13, $errno, $errstr);
if (!$fp) {
    echo "ERRO: $errno - $errstr<br />\n";
} else {
    fwrite($fp, "\n");
    echo fread($fp, 26);
    fclose($fp);
}
?>

Notas

Nota:
Dependedendo do ambiente, o domínio Unix ou o limite opcional de tempo de conexão podem não estar disponíveis.

Aviso

Sockets UDP algumas vezes irão parecer que foram abertos sem erro, mesmo que o servidor remoto seja inalcançável. O erro só se tornará aparente quando dados são lidos ou escritos no socket. A razão disso é porque o UDP é um protocolo "sem conexão", o que significa que o sistema operacional não tenta estabelecer uma ligação para o socket até que ele realmente precise enviar ou receber dados.

Nota: Ao especificar um endereço IPv6 numérico (por exemplo, fe80::1), o IP deve ser colocado entre colchetes — por exemplo, tcp://[fe80::1]:80.

Veja Também

pfsockopen() - Abra uma conexão persistente de soquete de domínio Unix ou de Internet
stream_socket_client() - Abre conexão de socket de domínio Internet ou Unix
stream_set_blocking() - Definir modo de bloqueio/não-bloqueio em um fluxo
stream_set_timeout() - Define o limite de tempo em um fluxo
fgets() - Lê uma linha de um ponteiro de arquivo
fgetss() - Ler uma linha de um ponteiro de arquivo e retira as tags HTML
fwrite() - Escrita binary-safe em arquivos
fclose() - Fecha um ponteiro de arquivo aberto
feof() - Testa pelo fim-de-arquivo em um ponteiro de arquivo
socket_connect() - Inicia uma conexão em um soquete
A extensão Curl