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 voorheen beschikbaar was 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 zojuist aangemaakte socket. Houd er rekening mee dat socket-ID's die met deze API worden aangemaakt, niet compatibel zijn met socket-ID's die met andere API's worden aangemaakt, zoals de verouderde [ socket ](../socket/) API.

DnsQueryType

Chrome 103+

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

Enum

"elk"

"ipv4"

"ipv6"

ReceiveErrorInfo

Eigenschappen

  • resultaatcode

    nummer

    De resultaatcode die is geretourneerd door de onderliggende netwerkoproep.

  • socketId

    nummer

    De socket-identificatie.

ReceiveInfo

Eigenschappen

  • gegevens

    ArrayBuffer

    De ontvangen gegevens hebben een maximale grootte van bufferSize .

  • socketId

    nummer

    De socket-identificatie.

SecureOptions

Eigenschappen

SendInfo

Eigenschappen

  • bytesSent

    nummer optioneel

    Het aantal verzonden bytes (indien resultaat == 0)

  • resultaatcode

    nummer

    De resultaatcode die is teruggestuurd door de onderliggende netwerkoproep. Een negatieve waarde duidt op een fout.

SocketInfo

Eigenschappen

  • bufferSize

    nummer optioneel

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

  • aangesloten

    booleaans

    Een vlag die aangeeft of de socket verbonden is met een externe tegenpartij.

  • lokaalAdres

    string optioneel

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

  • lokalePort

    nummer optioneel

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

  • naam

    string optioneel

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

  • pauzeerde

    booleaans

    Vlag die aangeeft of een verbonden socket voorkomt dat de tegenpartij meer gegevens verzendt (zie setPaused ).

  • peerAddress

    string optioneel

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

  • peerPort

    nummer optioneel

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

  • volhardend

    booleaans

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

  • socketId

    nummer

    De socket-identificatie.

SocketProperties

Eigenschappen

  • bufferSize

    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 afgesloten (zie Levenscyclus van de applicatie beheren ). De standaardwaarde is "false". Wanneer de applicatie wordt geladen, kunnen alle sockets die eerder met persistent=true zijn geopend, worden opgehaald met getSockets .

TLSVersionConstraints

Eigenschappen

  • max

    string optioneel

  • min

    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 beperkt tot tls1.2 . Als max is ingesteld op een van deze waarden, of een andere onbekende 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 vrij waaraan de socket is gekoppeld. Elke aangemaakte socket moet na gebruik worden gesloten. De socket-ID is niet langer geldig zodra de functie wordt aangeroepen. Het is echter gegarandeerd dat de socket pas wordt gesloten wanneer de callback wordt aangeroepen.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 121+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

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 geactiveerd wanneer gegevens van de tegenpartij worden ontvangen. Als er een netwerkfout optreedt terwijl de runtime pakketten ontvangt, wordt een onReceiveError -gebeurtenis geactiveerd. In dat geval worden er geen onReceive gebeurtenissen meer geactiveerd voor deze socket totdat de resume methode wordt aangeroepen.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • peerAddress

    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

    Chrome 103+

    De voorkeur voor adresresolutie.

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (result: number) => void

    • resultaat

      nummer

      De resultaatcode die is teruggestuurd door de onderliggende netwerkoproep. Een negatieve waarde duidt op een fout.

create()

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

Hiermee wordt een TCP-socket aangemaakt.

Parameters

  • eigenschappen

    SocketProperties optioneel

    De socket-eigenschappen (optioneel).

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      Het resultaat van het aanmaken van de socket.

Retourneert

  • Promise< CreateInfo >

    Chrome 121+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

disconnect()

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

Koppelt het stopcontact los.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 121+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getInfo()

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

Haalt de status van de betreffende socket op.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Object dat de socketinformatie bevat.

Retourneert

  • Promise< SocketInfo >

    Chrome 121+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getSockets()

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

Geeft een lijst weer van de momenteel geopende sockets die eigendom zijn van de applicatie.

Parameters

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo []

      Een array van objecten met socketinformatie.

Retourneert

  • Promise< SocketInfo []>

    Chrome 121+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

secure()

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

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

Parameters

  • socketId

    nummer

    Het bestaande, aangesloten stopcontact gebruiken.

  • opties

    SecureOptions optioneel

    Beperkingen en parameters voor de TLS-verbinding.

  • terugbelverzoek

    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,
): void

Verzendt gegevens via de opgegeven TCP-socket.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • gegevens

    ArrayBuffer

    De te verzenden gegevens.

  • terugbelverzoek

    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,
): void

Hiermee kunt u de keep-alive-functionaliteit voor een TCP-verbinding in- of uitschakelen.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • inschakelen

    booleaans

    Indien waar, schakel de keep-alive-functionaliteit in.

  • vertraging

    nummer optioneel

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

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (result: number) => void

    • resultaat

      nummer

      De resultaatcode die is teruggestuurd door de onderliggende netwerkoproep. Een negatieve waarde duidt op een fout.

setNoDelay()

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

Hiermee wordt TCP_NODELAY voor een TCP-verbinding ingesteld of gewist. Het Nagle-algoritme wordt uitgeschakeld wanneer TCP_NODELAY is ingesteld.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • geen vertraging

    booleaans

    Indien waar, wordt het algoritme van Nagle uitgeschakeld.

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (result: number) => void

    • resultaat

      nummer

      De resultaatcode die is teruggestuurd door de onderliggende netwerkoproep. Een negatieve waarde duidt op een fout.

setPaused()

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

Hiermee kan de applicatie berichten van de tegenpartij ontvangen of niet. De standaardwaarde is "false". Het pauzeren van een socket wordt doorgaans gebruikt door een applicatie om de hoeveelheid data die door de tegenpartij wordt verzonden te beperken. Wanneer een socket is gepauzeerd, wordt er geen onReceive gebeurtenis geactiveerd. Wanneer een socket is verbonden en de pauze is opgeheven, worden er weer onReceive gebeurtenissen geactiveerd wanneer er berichten worden ontvangen.

Parameters

  • socketId

    nummer

  • pauzeerde

    booleaans

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 121+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

update()

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

Werkt de socket-eigenschappen bij.

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • eigenschappen

    SocketProperties

    De eigenschappen die moeten worden bijgewerkt.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 121+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

Evenementen

onReceive

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

Deze gebeurtenis wordt geactiveerd wanneer er gegevens zijn ontvangen voor een bepaalde socket.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (info: ReceiveInfo) => void

onReceiveError

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

Deze gebeurtenis wordt geactiveerd wanneer er een netwerkfout optreedt terwijl de runtime wacht op gegevens op het socketadres en de poort. Zodra deze gebeurtenis is geactiveerd, wordt de socket paused en worden er geen onReceive gebeurtenissen meer voor deze socket geactiveerd.

Parameters