chrome.sockets.tcpServer

Descrição

Use a API chrome.sockets.tcpServer para criar aplicativos de servidor usando conexões TCP. Essa API substitui a funcionalidade TCP anteriormente encontrada na API chrome.socket.

Manifesto

As chaves a seguir precisam ser declaradas no manifesto para usar essa API.

"sockets"

Tipos

AcceptErrorInfo

Propriedades

  • resultCode

    number

    O código de resultado retornado da chamada de rede subjacente.

  • socketId

    number

    O identificador de soquete do servidor.

AcceptInfo

Propriedades

  • clientSocketId

    number

    O identificador de soquete do cliente, ou seja, o identificador de soquete da conexão recém-estabelecida. Esse identificador de soquete só pode ser usado com funções do namespace chrome.sockets.tcp. Observe que o soquete do cliente é inicialmente pausado e precisa ser retomado explicitamente pelo aplicativo para começar a receber dados.

  • socketId

    number

    O identificador de soquete do servidor.

CreateInfo

Propriedades

  • socketId

    number

    O ID do soquete de servidor recém-criado. Os IDs de soquete criados com base nessa API não são compatíveis com os de outras APIs, como a API [socket](../socket/) descontinuada.

SocketInfo

Propriedades

  • localAddress

    string opcional

    Se o soquete está escutando, contém o endereço IPv4/6 local.

  • localPort

    número opcional

    Se o soquete está escutando, contém a porta local dele.

  • nome

    string opcional

    String definida pelo aplicativo associada ao soquete.

  • pausado

    booleano

    Sinalização que indica se as solicitações de conexão em um soquete de detecção são despachadas pelo evento onAccept ou enfileiradas no backlog da fila de detecção. Consulte os setPaused. O valor padrão é "false".

  • persistente

    booleano

    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

  • nome

    string opcional

    Uma string definida pelo aplicativo associada ao soquete.

  • persistente

    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()

Promessa 
chrome.sockets.tcpServer.close(
  socketId: number,
  callback?: function,
)

Desconecta e destrói o soquete. Cada soquete criado precisa ser fechado após o uso. O ID do soquete não será mais válido assim que a função for chamada. No entanto, o soquete será fechado somente quando o callback for invocado.

Parâmetros

  • socketId

    number

    O identificador do soquete.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 121 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

create()

Promessa 
chrome.sockets.tcpServer.create(
  properties?: SocketProperties,
  callback?: function,
)

Cria um soquete de servidor TCP.

Parâmetros

  • properties

    SocketProperties opcional

    Propriedades do soquete (opcional).

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      Resultado da criação do soquete.

Retorna

  • Promise&lt;CreateInfo&gt;

    Chrome 121 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

disconnect()

Promessa 
chrome.sockets.tcpServer.disconnect(
  socketId: number,
  callback?: function,
)

Desconecta o soquete de detecção, ou seja, para de aceitar novas conexões, e libera o endereço/porta a que o soquete está vinculado. O identificador de soquete permanece válido, por exemplo, ela pode ser usada com listen para aceitar conexões em uma nova porta e endereço.

Parâmetros

  • socketId

    number

    O identificador do soquete.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 121 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getInfo()

Promessa 
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 opcional

    O parâmetro callback tem esta aparência: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Objeto que contém as informações do soquete.

Retorna

  • Promise&lt;SocketInfo&gt;

    Chrome 121 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getSockets()

Promessa 
chrome.sockets.tcpServer.getSockets(
  callback?: function,
)

Recupera a lista de soquetes abertos no momento de propriedade do aplicativo.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      Matriz de objeto que contém informações do soquete.

Retorna

  • Promise&lt;SocketInfo[]&gt;

    Chrome 121 ou versões mais recentes

    As promessas só têm suporte no Manifesto 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 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 definida como 0, uma porta livre é escolhida dinamicamente. A porta alocada dinamicamente pode ser encontrada chamando getInfo.

  • lista de pendências

    número opcional

    Comprimento da fila de detecção do soquete. O valor padrão depende do sistema operacional (SOMAXCONN), o que garante um tamanho 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()

Promessa 
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. Em seguida, recusa outras solicitações de conexão. Os eventos onAccept são gerados apenas quando o soquete é retomado.

Parâmetros

  • socketId

    number

  • pausado

    booleano

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 121 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

update()

Promessa 
chrome.sockets.tcpServer.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

Atualiza as propriedades do soquete.

Parâmetros

  • socketId

    number

    O identificador do soquete.

  • properties

    SocketProperties

    As propriedades a serem atualizadas.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 121 ou versões mais recentes

    As promessas só têm suporte no Manifesto 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 tiver sido feita com o soquete do servidor.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (info: AcceptInfo) => void

onAcceptError

chrome.sockets.tcpServer.onAcceptError.addListener(
  callback: function,
)

Evento gerado quando ocorreu um erro de rede enquanto o ambiente de execução aguardava novas conexões no endereço e na porta do soquete. Quando esse evento for gerado, o soquete será definido como paused e nenhum evento onAccept será gerado para ele até que o soquete seja retomado.

Parâmetros