chrome.sockets.tcp

Beschrijving

Gebruik de chrome.sockets.tcp API om gegevens via het netwerk te verzenden en ontvangen 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

CreateInfo

Eigenschappen

  • socket-ID

    nummer

    De ID van de nieuw aangemaakte 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+

DNS-resolutievoorkeuren. De standaardinstelling is any en gebruikt de huidige besturingssysteemconfiguratie, die IPv4 of IPv6 kan retourneren. ipv4 forceert IPv4 en ipv6 forceert IPv6.

Enum

"elk"

"ipv4"

"ipv6"

ReceiveErrorInfo

Eigenschappen

  • resultaatcode

    nummer

    De resultaatcode die wordt geretourneerd door de onderliggende netwerkoproep.

  • socket-ID

    nummer

    De socket-identificatie.

ReceiveInfo

Eigenschappen

  • gegevens

    ArrayBuffer

    De ontvangen gegevens, met een maximale grootte van bufferSize .

  • socket-ID

    nummer

    De socket-identificatie.

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 geen expliciete buffergrootte is opgegeven, wordt de waarde niet opgegeven.

  • aangesloten

    Booleaanse

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

  • lokaalAdres

    string optioneel

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

  • lokale poort

    nummer optioneel

    Als de onderliggende socket verbonden is, 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 een verbonden socket zijn peer blokkeert om meer data te verzenden (zie setPaused ).

  • peerAdres

    string optioneel

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

  • peerPort

    nummer optioneel

    Als de onderliggende socket verbonden is, bevat deze de peerpoort.

  • volhardend

    Booleaanse

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

  • socket-ID

    nummer

    De socket-identificatie.

SocketProperties

Eigenschappen

  • buffergrootte

    nummer optioneel

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

  • 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 .

TLSVersionConstraints

Eigenschappen

  • maximaal

    string optioneel

  • mijn

    string 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 is ingesteld op een van deze waarden, wordt deze stilzwijgend vastgezet op tls1.2 . Als max is ingesteld op een van deze waarden, of een andere niet-herkende waarde, wordt deze stilzwijgend genegeerd.

Methoden

close()

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

Sluit de socket en geeft het adres/de poort waaraan de socket is gekoppeld vrij. Elke aangemaakte socket moet na gebruik worden gesloten. De socket-id is niet langer 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.

connect()

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

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

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • peerAdres

    snaar

    Het adres van de externe computer. DNS-naam, IPv4- en IPv6-indelingen worden ondersteund.

  • peerPort

    nummer

    De poort van de externe machine.

  • dnsQueryType

    DnsQueryType optioneel

    Chroom 103+

    De voorkeur voor adresresolutie.

  • 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.

create()

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

Maakt een TCP-socket.

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.tcp.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

Koppelt het stopcontact los.

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.tcp.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.tcp.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.

secure()

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

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

Parameters

  • socket-ID

    nummer

    Het bestaande, aangesloten stopcontact dat gebruikt moet worden.

  • opties

    SecureOptions optioneel

    Beperkingen en parameters voor de TLS-verbinding.

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    (result: number) => void

    • resultaat

      nummer

send()

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

Verzendt gegevens naar de opgegeven TCP-socket.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • gegevens

    ArrayBuffer

    De te verzenden gegevens.

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    (sendInfo: SendInfo) => void

setKeepAlive()

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

Hiermee schakelt u de keep-alive-functionaliteit voor een TCP-verbinding in of uit.

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • inschakelen

    Booleaanse

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

  • vertraging

    nummer optioneel

    Stel de vertraging in seconden in tussen het laatste ontvangen datapakket en de eerste keepalive-probe. De standaardwaarde is 0.

  • 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.

setNoDelay()

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

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

Parameters

  • socket-ID

    nummer

    De socket-identificatie.

  • geen vertraging

    Booleaanse

    Als deze optie waar is, wordt het algoritme van Nagle uitgeschakeld.

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

Hiermee schakelt u de applicatie in of uit om berichten van de peer te ontvangen. 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 gepauzeerd is, wordt er geen onReceive gebeurtenis gegenereerd. Wanneer een socket verbonden is en de pauze is hervat, worden er opnieuw onReceive gebeurtenissen gegenereerd wanneer er berichten worden ontvangen.

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.tcp.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

onReceive

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

Gebeurtenis die wordt gegenereerd wanneer gegevens voor een bepaalde socket zijn ontvangen.

Parameters

onReceiveError

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

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

Parameters