chrome.sockets.tcp

Beschrijving

Gebruik de chrome.sockets.tcp API om gegevens via het netwerk te verzenden en te ontvangen met behulp van TCP-verbindingen. Deze API vervangt de TCP-functionaliteit die eerder werd gevonden in de chrome.socket API.

Manifest

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

"sockets"

Soorten

CreateInfo

Eigenschappen

  • socketId

    nummer

    De ID van de nieuw gemaakte socket. 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.

DnsQueryType

Chroom 103+

Voorkeuren voor DNS-resolutie. De standaardwaarde is any en gebruikt de huidige besturingssysteemconfiguratie die IPv4 of IPv6 kan retourneren. ipv4 dwingt IPv4 af, en ipv6 dwingt IPv6 af.

Enum

"elk"

"ipv4"

"ipv6"

ReceiveErrorInfo

Eigenschappen

  • resultaatCode

    nummer

    De resultaatcode die is geretourneerd door de onderliggende netwerkaanroep.

  • socketId

    nummer

    De socket-ID.

ReceiveInfo

Eigenschappen

  • gegevens

    ArrayBuffer

    De ontvangen gegevens, met een maximale grootte van bufferSize .

  • socketId

    nummer

    De socket-ID.

SecureOptions

Eigenschappen

SendInfo

Eigenschappen

  • bytesVerzonden

    nummer optioneel

    Het aantal verzonden bytes (als resultaat == 0)

  • resultaatCode

    nummer

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

SocketInfo

Eigenschappen

  • buffergrootte

    nummer optioneel

    De grootte van de buffer die wordt gebruikt om gegevens te ontvangen. Als er expliciet geen buffergrootte is opgegeven, wordt de waarde niet opgegeven.

  • aangesloten

    Booleaans

    Vlag die aangeeft of de socket is verbonden met een externe peer.

  • lokaalAdres

    tekenreeks optioneel

    Als de onderliggende socket is aangesloten, bevat deze het lokale IPv4/6-adres.

  • lokale poort

    nummer optioneel

    Als de onderliggende socket is aangesloten, bevat deze de lokale poort.

  • naam

    tekenreeks optioneel

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

  • gepauzeerd

    Booleaans

    Vlag die aangeeft of een aangesloten socket zijn peer blokkeert om meer gegevens te verzenden (zie setPaused ).

  • peerAdres

    tekenreeks optioneel

    Als de onderliggende socket is aangesloten, bevat deze het peer/IPv4/6-adres.

  • peerPort

    nummer optioneel

    Als de onderliggende socket is aangesloten, bevat deze de peer-poort.

  • volhardend

    Booleaans

    Vlag die aangeeft of de socket open blijft wanneer de toepassing wordt opgeschort (zie SocketProperties.persistent ).

  • socketId

    nummer

    De socket-ID.

SocketProperties

Eigenschappen

  • buffergrootte

    nummer optioneel

    De grootte van de buffer die wordt gebruikt om gegevens te ontvangen. De standaardwaarde is 4096.

  • naam

    tekenreeks optioneel

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

  • volhardend

    Booleaans 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 toepassing is geladen, kunnen alle sockets die eerder zijn geopend met persistent=true worden opgehaald met getSockets .

TLSVersionConstraints

Eigenschappen

  • maximaal

    tekenreeks optioneel

  • min

    tekenreeks optioneel

    De minimaal en maximaal acceptabele versies van TLS. Ondersteunde waarden zijn tls1.2 of tls1.3 .

    De waarden tls1 en tls1.1 worden niet langer ondersteund. Als min op een van deze waarden wordt ingesteld, wordt deze stilletjes vastgeklemd op tls1.2 . Als max is ingesteld op een van deze waarden, of op een andere niet-herkende waarde, wordt deze stilzwijgend genegeerd.

Methoden

close()

Belofte
chrome.sockets.tcp.close(
  socketId: number,
  callback?: function,
)

Sluit de socket en geeft het adres/poort vrij waaraan de socket is gebonden. Elk gecreëerd stopcontact moet na gebruik worden gesloten. Het socket-ID is niet langer geldig zodra de functie wordt aangeroepen. De socket wordt echter alleen gegarandeerd gesloten wanneer de callback wordt aangeroepen.

Parameters

  • socketId

    nummer

    De socket-ID.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 121+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

connect()

chrome.sockets.tcp.connect(
  socketId: number,
  peerAddress: string,
  peerPort: number,
  dnsQueryType?: DnsQueryType,
  callback: function,
)

Verbindt het stopcontact met een externe machine. Wanneer de connect met succes is voltooid, worden onReceive gebeurtenissen gegenereerd wanneer gegevens worden ontvangen van de peer. Als er een netwerkfout optreedt terwijl de runtime pakketten ontvangt, wordt er een onReceiveError gebeurtenis gegenereerd. Op dat moment zal er geen onReceive gebeurtenis meer worden gegenereerd voor deze socket totdat de resume wordt aangeroepen.

Parameters

  • socketId

    nummer

    De socket-ID.

  • peerAdres

    snaar

    Het adres van de externe machine. DNS-naam, IPv4- en IPv6-formaten worden ondersteund.

  • peerPort

    nummer

    De poort van de externe machine.

  • dnsQueryType

    DnsQueryType optioneel

    Chroom 103+

    De voorkeur voor adresresolutie.

  • terugbellen

    functie

    De callback parameter 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.

create()

Belofte
chrome.sockets.tcp.create(
  properties?: SocketProperties,
  callback?: function,
)

Creëert een TCP-socket.

Parameters

  • eigenschappen

    SocketProperties optioneel

    De socketeigenschappen (optioneel).

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (createInfo: CreateInfo) => void

    • creëerInfo

      CreëerInfo

      Het resultaat van het maken van sockets.

Retouren

  • Beloof < CreateInfo >

    Chroom 121+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

disconnect()

Belofte
chrome.sockets.tcp.disconnect(
  socketId: number,
  callback?: function,
)

Ontkoppelt het stopcontact.

Parameters

  • socketId

    nummer

    De socket-ID.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 121+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getInfo()

Belofte
chrome.sockets.tcp.getInfo(
  socketId: number,
  callback?: function,
)

Haalt de status van de gegeven socket op.

Parameters

  • socketId

    nummer

    De socket-ID.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (socketInfo: SocketInfo) => void

    • stopcontactInfo

      SocketInfo

      Object dat de socketinformatie bevat.

Retouren

  • Beloof het < SocketInfo >

    Chroom 121+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getSockets()

Belofte
chrome.sockets.tcp.getSockets(
  callback?: function,
)

Haalt de lijst op met momenteel geopende sockets die eigendom zijn van de applicatie.

Parameters

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (socketInfos: SocketInfo[]) => void

    • socketInfo

      SocketInfo []

      Array van objecten met socketinformatie.

Retouren

  • Beloof het < SocketInfo []>

    Chroom 121+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

secure()

chrome.sockets.tcp.secure(
  socketId: number,
  options?: SecureOptions,
  callback: function,
)

Start een TLS-clientverbinding via de verbonden TCP-clientsocket.

Parameters

  • socketId

    nummer

    Het bestaande, aangesloten stopcontact is te gebruiken.

  • opties

    SecureOptions optioneel

    Beperkingen en parameters voor de TLS-verbinding.

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    (result: number) => void

    • resultaat

      nummer

send()

chrome.sockets.tcp.send(
  socketId: number,
  data: ArrayBuffer,
  callback: function,
)

Verzendt gegevens over de opgegeven TCP-socket.

Parameters

  • socketId

    nummer

    De socket-ID.

  • gegevens

    ArrayBuffer

    De gegevens die moeten worden verzonden.

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    (sendInfo: SendInfo) => void

setKeepAlive()

chrome.sockets.tcp.setKeepAlive(
  socketId: number,
  enable: boolean,
  delay?: number,
  callback: function,
)

Schakelt de keep-alive-functionaliteit voor een TCP-verbinding in of uit.

Parameters

  • socketId

    nummer

    De socket-ID.

  • inschakelen

    Booleaans

    Als dit waar is, schakelt u de keep-alive-functionaliteit in.

  • vertraging

    nummer optioneel

    Stel de vertragingsseconden in tussen het laatste ontvangen datapakket en de eerste keepalive-sonde. Standaard is 0.

  • terugbellen

    functie

    De callback parameter 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.

setNoDelay()

chrome.sockets.tcp.setNoDelay(
  socketId: number,
  noDelay: boolean,
  callback: function,
)

Stelt TCP_NODELAY in of wist deze voor een TCP-verbinding. Het algoritme van Nagle wordt uitgeschakeld wanneer TCP_NODELAY is ingesteld.

Parameters

  • socketId

    nummer

    De socket-ID.

  • geenvertraging

    Booleaans

    Indien waar, wordt het algoritme van Nagle uitgeschakeld.

  • terugbellen

    functie

    De callback parameter 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.tcp.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

Schakelt in of uit dat de toepassing berichten van zijn peer ontvangt. De standaardwaarde is "false". Het pauzeren van een socket wordt doorgaans door een applicatie gebruikt om de gegevens die door de peer worden verzonden, te beperken. Wanneer een socket wordt gepauzeerd, wordt er geen onReceive gebeurtenis gegenereerd. Wanneer een socket is aangesloten en niet is gepauzeerd, worden onReceive gebeurtenissen opnieuw gegenereerd wanneer er berichten worden ontvangen.

Parameters

  • socketId

    nummer

  • gepauzeerd

    Booleaans

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 121+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

update()

Belofte
chrome.sockets.tcp.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

Werkt de socketeigenschappen bij.

Parameters

  • socketId

    nummer

    De socket-ID.

  • eigenschappen

    Socketeigenschappen

    De eigenschappen die moeten worden bijgewerkt.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 121+

    Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

Evenementen

onReceive

chrome.sockets.tcp.onReceive.addListener(
  callback: function,
)

Gebeurtenis die optreedt wanneer gegevens zijn ontvangen voor een bepaalde socket.

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    (info: ReceiveInfo) => void

onReceiveError

chrome.sockets.tcp.onReceiveError.addListener(
  callback: function,
)

Gebeurtenis opgetreden toen er een netwerkfout optrad terwijl de runtime wachtte op gegevens over het socketadres en de poort. Zodra deze gebeurtenis is gegenereerd, wordt de socket ingesteld op paused en worden er geen onReceive gebeurtenissen meer gegenereerd voor deze socket.

Parameters