Escuta uma conexão em um soquete

Descrição

socket_listen(Socket $socket, int $backlog = 0): bool

Após o soquete socket ter sido criado usando socket_create() e vinculado a um nome com socket_bind(), ele pode ser instruído a escutar conexões de entrada no socket.

socket_listen() é aplicável somente a soquetes do tipo SOCK_STREAM ou SOCK_SEQPACKET.

Parâmetros

socket: Uma instância de Socket criada com socket_create() ou socket_addrinfo_bind().
backlog: O parâmetro backlog (passivo) define um máximo de conexões de entrada que serão enfileiradas para processamento. Se uma solicitação de conexão chegar com a fila cheia, o cliente poderá receber um erro com uma indicação de ECONNREFUSED ou, se o protocolo subjacente suportar retransmissão, a solicitação poderá ser ignorada para que novas tentativas possam ser bem-sucedidas.

Note:
O número máximo passado para o parâmetro backlog depende muito da plataforma subjacente. No Linux, ele é truncado silenciosamente para SOMAXCONN. No win32, se for passado SOMAXCONN, o provedor de serviços subjacente responsável pelo soquete definirá o passivo para um valor máximo razoável. Não há nenhuma provisão padrão para descobrir o valor real do passivo nesta plataforma.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha. O código de erro pode ser recuperado com socket_last_error(). Este código pode ser passado para socket_strerror() para obter uma explicação textual do erro.

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

socket_accept() - Aceita uma conexão em um soquete
socket_bind() - Vincula um nome a um soquete
socket_connect() - Inicia uma conexão em um soquete
socket_create() - Cria um soquete (ponto de extremidade para comunição)
socket_strerror() - Retorna uma string descrevendo um erro no soquete
socket_addrinfo_bind() - Cria e vincula a um soquete a partir de uma informação de endereço