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 que antes era encontrada na API chrome.socket.

Manifesto

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

"sockets"

Tipos

AcceptErrorInfo

Propriedades

  • resultCode

    número

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

  • socketId

    número

    O identificador do soquete de servidor.

AcceptInfo

Propriedades

  • clientSocketId

    número

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

  • socketId

    número

    O identificador do soquete de servidor.

CreateInfo

Propriedades

  • socketId

    número

    O ID do soquete de servidor recém-criado. Os IDs de soquete criados com essa API não são compatíveis com os IDs de soquete 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 optional

    Se o soquete estiver detectando, contém a porta local.

  • 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 enviadas pelo evento onAccept ou colocadas na fila de detecção. Consulte os setPaused. O valor padrão é "false".

  • permanente

    booleano

    Sinalização que indica se o soquete permanece aberto quando a página de evento do aplicativo é descarregada (consulte SocketProperties.persistent). O valor padrão é "false".

  • socketId

    número

    O identificador do soquete.

SocketProperties

Propriedades

  • nome

    string opcional

    Uma string definida pelo aplicativo associada ao soquete.

  • permanente

    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 é "false". 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,
): Promise<void>

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

Parâmetros

  • socketId

    número

    O identificador do soquete.

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    () => void

Retorna

  • Promessa<void>

    Chrome 121+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

create()

Promessa 
chrome.sockets.tcpServer.create(
  properties?: SocketProperties,
  callback?: function,
): Promise<CreateInfo>

Cria um soquete de servidor TCP.

Parâmetros

  • propriedades

    SocketProperties opcional

    As propriedades do soquete (opcional).

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      O resultado da criação do soquete.

Retorna

  • Promise<CreateInfo>

    Chrome 121+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

disconnect()

Promessa 
chrome.sockets.tcpServer.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

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

Parâmetros

  • socketId

    número

    O identificador do soquete.

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    () => void

Retorna

  • Promessa<void>

    Chrome 121+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getInfo()

Promessa 
chrome.sockets.tcpServer.getInfo(
  socketId: number,
  callback?: function,
): Promise<SocketInfo>

Recupera o estado do soquete fornecido.

Parâmetros

  • socketId

    número

    O identificador do soquete.

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

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

Retorna

  • Promise<SocketInfo>

    Chrome 121+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getSockets()

Promessa 
chrome.sockets.tcpServer.getSockets(
  callback?: function,
): Promise<SocketInfo[]>

Recupera a lista de soquetes abertos no momento que pertencem ao aplicativo.

Parâmetros

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

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

Retorna

  • Promise<SocketInfo[]>

    Chrome 121+

    As promessas só são compatíveis 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,
): void

Detecta conexões na porta e no endereço especificados. Se a porta/endereço estiver em uso, o callback vai indicar uma falha.

Parâmetros

  • socketId

    número

    O identificador do soquete.

  • endereço

    string

    O endereço da máquina local.

  • porta

    número

    A porta da máquina local. Quando definido como 0, uma porta livre é escolhida dinamicamente. A porta alocada dinamicamente pode ser encontrada chamando getInfo.

  • backlog

    número optional

    Comprimento da fila de escuta do soquete. O valor padrão depende do sistema operacional (SOMAXCONN), que garante um tamanho de fila razoável para a maioria dos aplicativos.

  • callback

    função

    O parâmetro callback é semelhante a: 

    (result: number) => void

    • resultado

      número

      O código de resultado retornado da chamada de rede. Um valor negativo indica um erro.

setPaused()

Promessa 
chrome.sockets.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
): Promise<void>

Ativa ou desativa um soquete de detecção para aceitar novas conexões. 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. Os eventos onAccept são gerados apenas quando o soquete é retomado.

Parâmetros

  • socketId

    número

  • pausado

    booleano

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    () => void

Retorna

  • Promessa<void>

    Chrome 121+

    As promessas só são compatíveis com o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

update()

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

Atualiza as propriedades do soquete.

Parâmetros

  • socketId

    número

    O identificador do soquete.

  • propriedades

    SocketProperties

    As propriedades a serem atualizadas.

  • callback

    função optional

    O parâmetro callback é semelhante a: 

    () => void

Retorna

  • Promessa<void>

    Chrome 121+

    As promessas só são compatíveis 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 é feita com o soquete de servidor.

Parâmetros

  • callback

    função

    O parâmetro callback é semelhante a: 

    (info: AcceptInfo) => void

onAcceptError

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

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

Parâmetros