Descrição
Use a API chrome.sockets.tcpServer
para criar aplicativos de servidor usando conexões TCP. Essa API substitui a funcionalidade TCP encontrada anteriormente na API chrome.socket
.
Manifesto
Tipos
AcceptErrorInfo
Propriedades
-
resultCode
number
O código de resultado retornado da chamada de rede subjacente.
-
socketId
number
O identificador do soquete do servidor.
AcceptInfo
Propriedades
-
clientSocketId
number
O identificador de soquete do cliente, ou seja, o identificador do soquete da conexão recém-estabelecida. Esse identificador de soquete deve ser usado apenas com funções do namespace
chrome.sockets.tcp
. Observe que o soquete do cliente está inicialmente pausado e precisa ser explicitamente retomado pelo aplicativo para começar a receber os dados. -
socketId
number
O identificador do soquete do servidor.
CreateInfo
Propriedades
-
socketId
number
O ID do soquete do servidor recém-criado. Os IDs de soquete criados com base nessa API não são compatíveis com aqueles criados com outras APIs, como a API
[
socket](../socket/)
, que foi descontinuada.
SocketInfo
Propriedades
-
localAddress
string opcional
Se o soquete estiver detectando, contém o endereço IPv4/6 local.
-
localPort
número opcional
Se o soquete estiver ouvindo, contém a porta local.
-
name
string opcional
String definida pelo aplicativo associada ao soquete.
-
pausado
boolean
Sinalização que indica se as solicitações de conexão em um soquete de detecção são despachadas pelo evento
onAccept
ou colocadas na fila de backlog da fila de detecção. Consulte ossetPaused
. O valor padrão é "false". -
permanentes
boolean
Sinalização que indica se o soquete permanece aberto quando a página de eventos do aplicativo é descarregada (consulte
SocketProperties.persistent
). O valor padrão é "false". -
socketId
number
O identificador do soquete.
SocketProperties
Propriedades
-
name
string opcional
Uma string definida pelo aplicativo associada ao soquete.
-
permanentes
booleano opcional
Sinalização que indica se o soquete permanece aberto quando a página de eventos do aplicativo é descarregada (consulte Gerenciar o ciclo de vida do app). O valor padrão é "falso". Quando o aplicativo é carregado, todos os soquetes abertos anteriormente com persistent=true podem ser buscados com
getSockets
.
Métodos
close()
chrome.sockets.tcpServer.close(
socketId: number,
callback?: function,
)
Desconecta e destrói o soquete. Cada soquete criado deve ser fechado após o uso. O ID do soquete deixa de ser válido assim que a função é chamada. No entanto, há a garantia de que o soquete será fechado somente quando o callback for invocado.
Parâmetros
-
socketId
number
O identificador do soquete.
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 121 ou mais recentePromessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.
create()
chrome.sockets.tcpServer.create(
properties?: SocketProperties,
callback?: function,
)
Cria um soquete de servidor TCP.
Parâmetros
-
properties
SocketProperties opcional
As propriedades do soquete (opcional).
-
callback
função optional
O parâmetro
callback
tem esta aparência:(createInfo: CreateInfo) => void
-
createInfo
O resultado da criação do soquete.
-
Retorna
-
Promise<CreateInfo>
Chrome 121 ou mais recentePromessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.
disconnect()
chrome.sockets.tcpServer.disconnect(
socketId: number,
callback?: function,
)
Desconecta o soquete de detecção, ou seja, deixa de aceitar novas conexões, e libera o endereço/porta a que o soquete está vinculado. O identificador de soquete continua válido, por exemplo, pode ser usado com listen
para aceitar conexões em uma nova porta e endereço.
Parâmetros
-
socketId
number
O identificador do soquete.
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 121 ou mais recentePromessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.
getInfo()
chrome.sockets.tcpServer.getInfo(
socketId: number,
callback?: function,
)
Recupera o estado do soquete especificado.
Parâmetros
-
socketId
number
O identificador do soquete.
-
callback
função optional
O parâmetro
callback
tem esta aparência:(socketInfo: SocketInfo) => void
-
socketInfo
Objeto contendo as informações do soquete.
-
Retorna
-
Promise<SocketInfo>
Chrome 121 ou mais recentePromessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.
getSockets()
chrome.sockets.tcpServer.getSockets(
callback?: function,
)
Recupera a lista de soquetes abertos no momento pertencentes ao aplicativo.
Parâmetros
-
callback
função optional
O parâmetro
callback
tem esta aparência:(socketInfos: SocketInfo[]) => void
-
socketInfos
Matriz de objeto que contém informações sobre o soquete.
-
Retorna
-
Promise<SocketInfo[]>
Chrome 121 ou mais recentePromessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.
listen()
chrome.sockets.tcpServer.listen(
socketId: number,
address: string,
port: number,
backlog?: number,
callback: function,
)
Detecta conexões na porta e no endereço especificados. Se a porta/o endereço estiver em uso, o callback vai indicar uma falha.
Parâmetros
-
socketId
number
O identificador do soquete.
-
endereço
string
O endereço da máquina local.
-
porta
number
A porta da máquina local. Quando definido como
0
, uma porta livre é escolhida dinamicamente. A porta alocada dinamicamente pode ser encontrada chamandogetInfo
. -
lista de pendências
número opcional
Comprimento da fila de detecção do soquete. O valor padrão depende do sistema operacional (SOMAXCONN), que garante um comprimento de fila razoável para a maioria dos aplicativos.
-
callback
função
O parâmetro
callback
tem esta aparência:(result: number) => void
-
resultado
number
O código de resultado retornado da chamada de rede subjacente. Um valor negativo indica um erro.
-
setPaused()
chrome.sockets.tcpServer.setPaused(
socketId: number,
paused: boolean,
callback?: function,
)
Ativa ou desativa a aceitação de novas conexões por um soquete de detecção. Quando pausado, um soquete de detecção aceita novas conexões até que o backlog (consulte a função listen
) esteja cheio e, em seguida, recusa outras solicitações de conexão. Eventos onAccept
são gerados somente quando o soquete é retomado.
Parâmetros
-
socketId
number
-
pausado
boolean
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 121 ou mais recentePromessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.
update()
chrome.sockets.tcpServer.update(
socketId: number,
properties: SocketProperties,
callback?: function,
)
Atualiza as propriedades do soquete.
Parâmetros
-
socketId
number
O identificador do soquete.
-
properties
Propriedades a serem atualizadas.
-
callback
função optional
O parâmetro
callback
tem esta aparência:() => void
Retorna
-
Promise<void>
Chrome 121 ou mais recentePromessas são compatíveis apenas com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.
Eventos
onAccept
chrome.sockets.tcpServer.onAccept.addListener(
callback: function,
)
Evento gerado quando uma conexão é estabelecida com o soquete do servidor.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(info: AcceptInfo) => void
-
informações
-
onAcceptError
chrome.sockets.tcpServer.onAcceptError.addListener(
callback: function,
)
Evento gerado quando ocorre um erro de rede enquanto o tempo de execução aguarda novas conexões no endereço e na porta do soquete. Quando esse evento é gerado, o soquete é definido como paused
e nenhum outro evento onAccept
é gerado para esse soquete até que ele seja retomado.
Parâmetros
-
callback
função
O parâmetro
callback
tem esta aparência:(info: AcceptErrorInfo) => void
-
informações
-