chrome.sockets.tcpServer

Beschrijving

Gebruik de chrome.sockets.tcpServer API om servertoepassingen te maken met behulp van TCP-verbindingen. Deze API vervangt de TCP-functionaliteit die voorheen beschikbaar was in de chrome.socket API.

Manifest

De volgende sleutels moeten in het manifest worden gedeclareerd om deze API te gebruiken.

"sockets"

Typen

AcceptErrorInfo

Eigenschappen

  • resultaatcode

    nummer

    De resultaatcode die wordt geretourneerd door de onderliggende netwerkoproep.

  • socket-ID

    nummer

    De serversocket-ID.

AcceptInfo

Eigenschappen

  • clientSocketId

    nummer

    De client socket-ID, d.w.z. de socket-ID van de nieuw tot stand gebrachte verbinding. Deze socket-ID mag alleen worden gebruikt met functies uit de chrome.sockets.tcp -naamruimte. Let op: de client socket is in eerste instantie gepauzeerd en moet expliciet door de applicatie worden hervat om gegevens te kunnen ontvangen.

  • socket-ID

    nummer

    De serversocket-ID.

CreateInfo

Eigenschappen

  • socket-ID

    nummer

    De ID van de nieuw aangemaakte serversocket. Houd er rekening mee dat socket-ID's die met deze API zijn gemaakt, niet compatibel zijn met socket-ID's die met andere API's zijn gemaakt, zoals de verouderde [ socket ](../socket/) API.

SocketInfo

Eigenschappen

  • lokaalAdres

    string optioneel

    Als de socket luistert, bevat het het lokale IPv4/6-adres.

  • lokale poort

    nummer optioneel

    Als de socket luistert, bevat deze de lokale poort.

  • naam

    string optioneel

    Door de toepassing gedefinieerde tekenreeks die aan de socket is gekoppeld.

  • gepauzeerd

    Booleaanse

    Vlag die aangeeft of verbindingsaanvragen op een luisterende socket worden verzonden via de onAccept -gebeurtenis of in de wachtrij worden geplaatst in de luisterwachtrijbacklog. Zie setPaused . De standaardwaarde is "false".

  • volhardend

    Booleaanse

    Vlag die aangeeft of de socket open blijft wanneer de gebeurtenispagina van de applicatie wordt verwijderd (zie SocketProperties.persistent ). De standaardwaarde is "false".

  • socket-ID

    nummer

    De socket-identificatie.

SocketProperties

Eigenschappen

  • naam

    string optioneel

    Een door de applicatie gedefinieerde tekenreeks die aan de socket is gekoppeld.

  • volhardend

    boolean optioneel

    Vlag die aangeeft of de socket open blijft wanneer de gebeurtenispagina van de applicatie wordt verwijderd (zie App-levenscyclus beheren ). De standaardwaarde is 'false'. Wanneer de applicatie wordt geladen, kunnen alle sockets die eerder zijn geopend met persistent=true worden opgehaald met getSockets .

Methoden

close()

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

Verbreekt de verbinding en vernietigt de socket. Elke aangemaakte socket moet na gebruik worden gesloten. De socket-id is niet meer geldig zodra de functie wordt aangeroepen. De socket wordt echter gegarandeerd alleen gesloten wanneer de callback wordt aangeroepen.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 121+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

create()

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

Maakt een TCP-serversocket.

Parameters

  • eigenschappen

    SocketProperties optioneel

    De socket-eigenschappen (optioneel).

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      Het resultaat van de socketcreatie.

Retourneren

  • Belofte< CreateInfo >

    Chroom 121+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

disconnect()

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

Verbreekt de verbinding met de luisterende socket, d.w.z. stopt met het accepteren van nieuwe verbindingen en geeft het adres/de poort waaraan de socket is gekoppeld vrij. De socket-ID blijft geldig; deze kan bijvoorbeeld met listen worden gebruikt om verbindingen op een nieuwe poort en een nieuw adres te accepteren.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 121+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getInfo()

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

Haalt de status van de opgegeven socket op.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Object dat de socketinformatie bevat.

Retourneren

  • Belofte <SocketInfo>

    Chroom 121+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getSockets()

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

Haalt de lijst op met de sockets die momenteel geopend zijn en eigendom zijn van de toepassing.

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo []

      Een objectarray met socketinformatie.

Retourneren

  • Belofte< SocketInfo []>

    Chroom 121+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

listen()

chrome.sockets.tcpServer.listen(
  socketId: number,
  address: string,
  port: number,
  backlog?: number,
  callback: function,
): void

Luistert naar verbindingen op de opgegeven poort en het opgegeven adres. Als de poort/het opgegeven adres in gebruik is, geeft de callback een fout aan.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • adres

    snaar

    Het adres van de lokale machine.

  • haven

    nummer

    De poort van de lokale machine. Indien ingesteld op 0 , wordt dynamisch een vrije poort gekozen. De dynamisch toegewezen poort kan worden gevonden door getInfo aan te roepen.

  • achterstand

    nummer optioneel

    Lengte van de luisterwachtrij van de socket. De standaardwaarde is afhankelijk van het besturingssysteem (SOMAXCONN), wat voor de meeste toepassingen een redelijke wachtrijlengte garandeert.

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    (result: number) => void

    • resultaat

      nummer

      De resultaatcode die is geretourneerd door de onderliggende netwerkaanroep. Een negatieve waarde duidt op een fout.

setPaused()

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

Schakelt een luisterende socket in of uit om nieuwe verbindingen te accepteren. In pauzestand accepteert een luisterende socket nieuwe verbindingen totdat de backlog (zie listen ) vol is en weigert vervolgens verdere verbindingsaanvragen. onAccept gebeurtenissen worden alleen gegenereerd wanneer de socket weer actief is.

Parameters

  • socket-ID

    nummer

  • gepauzeerd

    Booleaanse

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 121+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

update()

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

Werkt de socket-eigenschappen bij.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • eigenschappen

    Socketeigenschappen

    De eigenschappen die bijgewerkt moeten worden.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 121+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

Evenementen

onAccept

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

Gebeurtenis die wordt gegenereerd wanneer er een verbinding is gemaakt met de serversocket.

Parameters

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    (info: AcceptInfo) => void

onAcceptError

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

Gebeurtenis gegenereerd wanneer er een netwerkfout optrad terwijl de runtime wachtte op nieuwe verbindingen op het socketadres en de poort. Zodra deze gebeurtenis is gegenereerd, wordt de socket paused en worden er geen onAccept gebeurtenissen meer gegenereerd voor deze socket totdat de socket wordt hervat.

Parameters