socket_getpeername

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

socket_getpeername — Consulta o lado remoto do soquete fornecido

Descrição

socket_getpeername(Socket $socket, string &$address, int &$port = null): bool

Consulta o lado remoto de um determinado soquete, o que pode resultar em servidor/porta ou em um caminho do sistema de arquivos Unix, dependendo do seu tipo.

Parâmetros

socket

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

address

Se o soquete fornecido for do tipo AF_INET ou AF_INET6, socket_getpeername() retornará o endereço IP dos pares (remotos) em notação apropriada (por exemplo, 127.0.0.1 ou fe80::1) no parâmetro address e, se o parâmetro opcional port estiver presente, retornará também a porta associada.

Se o soquete fornecido for do tipo AF_UNIX, socket_getpeername() retornará o caminho do sistema de arquivos Unix (por exemplo, /var/run/daemon.sock) no parâmetro address.

port

Se fornecida, esta variável conterá a porta associada ao endereço informado em address.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha. socket_getpeername() pode também retornar false se o tipo de soquete não for AF_INET, AF_INET6 ou AF_UNIX. Neste caso, o último código de erro de soquete NÃO É atualizado.

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.

Notas

Note:

socket_getpeername() não deve ser usada com soquetes AF_UNIX criados com socket_accept(). Somente soquetes criados com socket_connect() ou um soquete de servidor primário após uma chamada a socket_bind() retornarão valores significativos.

Note:

Para que socket_getpeername() retorne um valor significativo, o soquete ao qual ele é aplicado deve, obviamente, ser aquele para o qual o conceito de "par" faça sentido.

Veja Também

  • socket_getsockname() - Consulta o lado local do soquete fornecido, o que pode resultar em servidor/porta ou em um caminho do sistema de arquivos Unix, dependendo do seu tipo
  • socket_last_error() - Retorna o último erro no soquete
  • socket_strerror() - Retorna uma string descrevendo um erro no soquete