chrome.sockets.udp

Beschrijving

Gebruik de chrome.sockets.udp API om gegevens via het netwerk te verzenden en te ontvangen met behulp van UDP-verbindingen. Deze API vervangt de UDP-functionaliteit die voorheen beschikbaar was in de "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 wordt geretourneerd door de onderliggende recvfrom()-aanroep.

  • socketId

    nummer

    De socket-ID.

ReceiveInfo

Eigenschappen

  • gegevens

    ArrayBuffer

    De inhoud van het UDP-pakket (afgekapt tot de huidige buffergrootte).

  • externAdres

    snaar

    Het adres van de host waarvan het pakket afkomstig is.

  • externe poort

    nummer

    De poort van de host waarvan het pakket afkomstig is.

  • socketId

    nummer

    De socket-ID.

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.

  • lokaalAdres

    string optioneel

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

  • lokalePort

    nummer optioneel

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

  • naam

    string optioneel

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

  • pauzeerde

    booleaans

    Een vlag die aangeeft of de socket is geblokkeerd voor het verzenden van onReceive-gebeurtenissen.

  • 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. Als de buffer te klein is om het UDP-pakket te ontvangen, gaan er gegevens verloren. 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 .

Methoden

bind()

chrome.sockets.udp.bind(
  socketId: number,
  address: string,
  port: number,
  callback: function,
)
: void

Hiermee worden het lokale adres en de poort voor de socket gekoppeld. Voor een clientsocket wordt aangeraden poort 0 te gebruiken, zodat het platform een ​​vrije poort kan kiezen.

Zodra de bind bewerking succesvol is voltooid, worden onReceive gebeurtenissen geactiveerd wanneer UDP-pakketten aankomen op het opgegeven adres/poort, tenzij de socket is gepauzeerd.

Parameters

  • socketId

    nummer

    De socket-ID.

  • adres

    snaar

    Het adres van de lokale machine. DNS-naam, IPv4- en IPv6-formaten worden ondersteund. Gebruik "0.0.0.0" om pakketten van alle beschikbare lokale netwerkinterfaces te accepteren.

  • haven

    nummer

    De poort van de lokale machine. Gebruik "0" om een ​​vrije poort te koppelen.

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

close()

Belofte
chrome.sockets.udp.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-ID.

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

create()

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

Hiermee wordt een UDP-socket met de opgegeven eigenschappen aangemaakt.

Parameters

  • eigenschappen

    SocketProperties optioneel

    De socket-eigenschappen (optioneel).

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit:

    (createInfo: CreateInfo) => void

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

getInfo()

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

Haalt de status van de betreffende socket op.

Parameters

  • socketId

    nummer

    De socket-ID.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit:

    (socketInfo: SocketInfo) => void

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

getJoinedGroups()

Belofte
chrome.sockets.udp.getJoinedGroups(
  socketId: number,
  callback?: function,
)
: Promise<string[]>

Geeft de multicast-groepsadressen weer waaraan de socket momenteel is gekoppeld.

Parameters

  • socketId

    nummer

    De socket-ID.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit:

    (groups: string[]) => void

    • groepen

      snaar[]

      Een reeks groepen waaraan de socket is gekoppeld.

Retourneert

  • Promise<string[]>

    Chrome 121+

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

getSockets()

Belofte
chrome.sockets.udp.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

      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.

joinGroup()

chrome.sockets.udp.joinGroup(
  socketId: number,
  address: string,
  callback: function,
)
: void

Sluit zich aan bij de multicastgroep en begint pakketten van die groep te ontvangen. De socket moet aan een lokale poort gekoppeld zijn voordat deze methode kan worden aangeroepen.

Parameters

  • socketId

    nummer

    De socket-ID.

  • adres

    snaar

    Het groepsadres waaraan u wilt deelnemen. Domeinnamen worden niet ondersteund.

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

leaveGroup()

chrome.sockets.udp.leaveGroup(
  socketId: number,
  address: string,
  callback: function,
)
: void

Verlaat de multicastgroep waaraan u eerder bent toegevoegd met behulp van joinGroup . Deze functie hoeft u alleen aan te roepen als u de socket daarna wilt blijven gebruiken, aangezien het besturingssysteem dit automatisch doet wanneer de socket wordt gesloten.

Als u de groep verlaat, voorkomt u dat de router multicast-datagrammen naar de lokale host verzendt, ervan uitgaande dat geen enkel ander proces op de host nog lid is van de groep.

Parameters

  • socketId

    nummer

    De socket-ID.

  • adres

    snaar

    Het groepsadres dat u wilt achterlaten. Domeinnamen worden niet ondersteund.

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

send()

chrome.sockets.udp.send(
  socketId: number,
  data: ArrayBuffer,
  address: string,
  port: number,
  dnsQueryType?: DnsQueryType,
  callback: function,
)
: void

Verzendt gegevens via de opgegeven socket naar het opgegeven adres en poort. De socket moet aan een lokale poort gekoppeld zijn voordat deze methode kan worden aangeroepen.

Parameters

  • socketId

    nummer

    De socket-ID.

  • gegevens

    ArrayBuffer

    De te verzenden gegevens.

  • adres

    snaar

    Het adres van de externe machine.

  • haven

    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:

    (sendInfo: SendInfo) => void

setBroadcast()

Chrome 44+
chrome.sockets.udp.setBroadcast(
  socketId: number,
  enabled: boolean,
  callback: function,
)
: void

Hiermee kunt u broadcastpakketten op deze socket in- of uitschakelen.

Parameters

  • socketId

    nummer

    De socket-ID.

  • ingeschakeld

    booleaans

    true om broadcastpakketten in te schakelen, false om ze uit te schakelen.

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit:

    (result: number) => void

    • resultaat

      nummer

      De resultaatcode die is geretourneerd door de onderliggende netwerkoproep.

setMulticastLoopbackMode()

chrome.sockets.udp.setMulticastLoopbackMode(
  socketId: number,
  enabled: boolean,
  callback: function,
)
: void

Hiermee wordt ingesteld of multicastpakketten die vanaf de host naar de multicastgroep worden verzonden, terug naar de host worden gestuurd.

Opmerking: het gedrag van setMulticastLoopbackMode verschilt enigszins tussen Windows en Unix-achtige systemen. De inconsistentie treedt alleen op wanneer er meer dan één applicatie op dezelfde host lid is van dezelfde multicastgroep, maar verschillende instellingen heeft voor de multicast-loopbackmodus. Op Windows ontvangen applicaties met loopback uitgeschakeld geen loopbackpakketten; op Unix-achtige systemen verzenden applicaties met loopback uitgeschakeld geen loopbackpakketten naar andere applicaties op dezelfde host. Zie MSDN: https://learn.microsoft.com/en-us/windows/win32/winsock/ip-multicast-2

Voor het aanroepen van deze methode zijn geen multicast-rechten vereist.

Parameters

  • socketId

    nummer

    De socket-ID.

  • ingeschakeld

    booleaans

    Geef aan of de loopback-modus moet worden ingeschakeld.

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

setMulticastTimeToLive()

chrome.sockets.udp.setMulticastTimeToLive(
  socketId: number,
  ttl: number,
  callback: function,
)
: void

Hiermee wordt de time-to-live ingesteld voor multicastpakketten die naar de multicastgroep worden verzonden.

Voor het aanroepen van deze methode zijn geen multicast-rechten vereist.

Parameters

  • socketId

    nummer

    De socket-ID.

  • ttl

    nummer

    De waarde van de resterende levensduur.

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

Hiermee wordt een socket gepauzeerd of hervat. Een gepauzeerde socket kan geen onReceive gebeurtenissen verzenden.

Parameters

  • socketId

    nummer

    De socket-ID.

  • pauzeerde

    booleaans

    Vlag om aan te geven of de weergave gepauzeerd of hervat moet worden.

  • 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.udp.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)
: Promise<void>

Werkt de socket-eigenschappen bij.

Parameters

  • socketId

    nummer

    De socket-ID.

  • eigenschappen

    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.udp.onReceive.addListener(
  callback: function,
)

Deze gebeurtenis wordt geactiveerd wanneer een UDP-pakket is ontvangen voor de betreffende socket.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit:

    (info: ReceiveInfo) => void

onReceiveError

chrome.sockets.udp.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 gepauzeerd en worden er geen verdere onReceive gebeurtenissen meer voor deze socket geactiveerd totdat de socket weer actief is.

Parameters

,

Beschrijving

Gebruik de chrome.sockets.udp API om gegevens via het netwerk te verzenden en te ontvangen met behulp van UDP-verbindingen. Deze API vervangt de UDP-functionaliteit die voorheen beschikbaar was in de "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 wordt geretourneerd door de onderliggende recvfrom()-aanroep.

  • socketId

    nummer

    De socket-ID.

ReceiveInfo

Eigenschappen

  • gegevens

    ArrayBuffer

    De inhoud van het UDP-pakket (afgekapt tot de huidige buffergrootte).

  • externAdres

    snaar

    Het adres van de host waarvan het pakket afkomstig is.

  • externe poort

    nummer

    De poort van de host waarvan het pakket afkomstig is.

  • socketId

    nummer

    De socket-ID.

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.

  • lokaalAdres

    string optioneel

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

  • lokalePort

    nummer optioneel

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

  • naam

    string optioneel

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

  • pauzeerde

    booleaans

    Een vlag die aangeeft of de socket is geblokkeerd voor het verzenden van onReceive-gebeurtenissen.

  • 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. Als de buffer te klein is om het UDP-pakket te ontvangen, gaan er gegevens verloren. 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 .

Methoden

bind()

chrome.sockets.udp.bind(
  socketId: number,
  address: string,
  port: number,
  callback: function,
)
: void

Hiermee worden het lokale adres en de poort voor de socket gekoppeld. Voor een clientsocket wordt aangeraden poort 0 te gebruiken, zodat het platform een ​​vrije poort kan kiezen.

Zodra de bind bewerking succesvol is voltooid, worden onReceive gebeurtenissen geactiveerd wanneer UDP-pakketten aankomen op het opgegeven adres/poort, tenzij de socket is gepauzeerd.

Parameters

  • socketId

    nummer

    De socket-ID.

  • adres

    snaar

    Het adres van de lokale machine. DNS-naam, IPv4- en IPv6-formaten worden ondersteund. Gebruik "0.0.0.0" om pakketten van alle beschikbare lokale netwerkinterfaces te accepteren.

  • haven

    nummer

    De poort van de lokale machine. Gebruik "0" om een ​​vrije poort te koppelen.

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

close()

Belofte
chrome.sockets.udp.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-ID.

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

create()

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

Hiermee wordt een UDP-socket met de opgegeven eigenschappen aangemaakt.

Parameters

  • eigenschappen

    SocketProperties optioneel

    De socket-eigenschappen (optioneel).

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit:

    (createInfo: CreateInfo) => void

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

getInfo()

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

Haalt de status van de betreffende socket op.

Parameters

  • socketId

    nummer

    De socket-ID.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit:

    (socketInfo: SocketInfo) => void

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

getJoinedGroups()

Belofte
chrome.sockets.udp.getJoinedGroups(
  socketId: number,
  callback?: function,
)
: Promise<string[]>

Geeft de multicast-groepsadressen weer waaraan de socket momenteel is gekoppeld.

Parameters

  • socketId

    nummer

    De socket-ID.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit:

    (groups: string[]) => void

    • groepen

      snaar[]

      Een reeks groepen waaraan de socket is gekoppeld.

Retourneert

  • Promise<string[]>

    Chrome 121+

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

getSockets()

Belofte
chrome.sockets.udp.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

      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.

joinGroup()

chrome.sockets.udp.joinGroup(
  socketId: number,
  address: string,
  callback: function,
)
: void

Sluit zich aan bij de multicastgroep en begint pakketten van die groep te ontvangen. De socket moet aan een lokale poort gekoppeld zijn voordat deze methode kan worden aangeroepen.

Parameters

  • socketId

    nummer

    De socket-ID.

  • adres

    snaar

    Het groepsadres waaraan u wilt deelnemen. Domeinnamen worden niet ondersteund.

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

leaveGroup()

chrome.sockets.udp.leaveGroup(
  socketId: number,
  address: string,
  callback: function,
)
: void

Verlaat de multicastgroep waaraan u eerder bent toegevoegd met behulp van joinGroup . Deze functie hoeft u alleen aan te roepen als u de socket daarna wilt blijven gebruiken, aangezien het besturingssysteem dit automatisch doet wanneer de socket wordt gesloten.

Als u de groep verlaat, voorkomt u dat de router multicast-datagrammen naar de lokale host verzendt, ervan uitgaande dat geen enkel ander proces op de host nog lid is van de groep.

Parameters

  • socketId

    nummer

    De socket-ID.

  • adres

    snaar

    Het groepsadres dat u wilt achterlaten. Domeinnamen worden niet ondersteund.

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

send()

chrome.sockets.udp.send(
  socketId: number,
  data: ArrayBuffer,
  address: string,
  port: number,
  dnsQueryType?: DnsQueryType,
  callback: function,
)
: void

Verzendt gegevens via de opgegeven socket naar het opgegeven adres en poort. De socket moet aan een lokale poort gekoppeld zijn voordat deze methode kan worden aangeroepen.

Parameters

  • socketId

    nummer

    De socket-ID.

  • gegevens

    ArrayBuffer

    De te verzenden gegevens.

  • adres

    snaar

    Het adres van de externe machine.

  • haven

    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:

    (sendInfo: SendInfo) => void

setBroadcast()

Chrome 44+
chrome.sockets.udp.setBroadcast(
  socketId: number,
  enabled: boolean,
  callback: function,
)
: void

Hiermee kunt u broadcastpakketten op deze socket in- of uitschakelen.

Parameters

  • socketId

    nummer

    De socket-ID.

  • ingeschakeld

    booleaans

    true om broadcastpakketten in te schakelen, false om ze uit te schakelen.

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit:

    (result: number) => void

    • resultaat

      nummer

      De resultaatcode die is geretourneerd door de onderliggende netwerkoproep.

setMulticastLoopbackMode()

chrome.sockets.udp.setMulticastLoopbackMode(
  socketId: number,
  enabled: boolean,
  callback: function,
)
: void

Hiermee wordt ingesteld of multicastpakketten die vanaf de host naar de multicastgroep worden verzonden, terug naar de host worden gestuurd.

Opmerking: het gedrag van setMulticastLoopbackMode verschilt enigszins tussen Windows en Unix-achtige systemen. De inconsistentie treedt alleen op wanneer er meer dan één applicatie op dezelfde host lid is van dezelfde multicastgroep, maar verschillende instellingen heeft voor de multicast-loopbackmodus. Op Windows ontvangen applicaties met loopback uitgeschakeld geen loopbackpakketten; op Unix-achtige systemen verzenden applicaties met loopback uitgeschakeld geen loopbackpakketten naar andere applicaties op dezelfde host. Zie MSDN: https://learn.microsoft.com/en-us/windows/win32/winsock/ip-multicast-2

Voor het aanroepen van deze methode zijn geen multicast-rechten vereist.

Parameters

  • socketId

    nummer

    De socket-ID.

  • ingeschakeld

    booleaans

    Geef aan of de loopback-modus moet worden ingeschakeld.

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

setMulticastTimeToLive()

chrome.sockets.udp.setMulticastTimeToLive(
  socketId: number,
  ttl: number,
  callback: function,
)
: void

Hiermee wordt de time-to-live ingesteld voor multicastpakketten die naar de multicastgroep worden verzonden.

Voor het aanroepen van deze methode zijn geen multicast-rechten vereist.

Parameters

  • socketId

    nummer

    De socket-ID.

  • ttl

    nummer

    De waarde van de resterende levensduur.

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

Hiermee wordt een socket gepauzeerd of hervat. Een gepauzeerde socket kan geen onReceive gebeurtenissen verzenden.

Parameters

  • socketId

    nummer

    De socket-ID.

  • pauzeerde

    booleaans

    Vlag om aan te geven of de weergave gepauzeerd of hervat moet worden.

  • 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.udp.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)
: Promise<void>

Werkt de socket-eigenschappen bij.

Parameters

  • socketId

    nummer

    De socket-ID.

  • eigenschappen

    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.udp.onReceive.addListener(
  callback: function,
)

Deze gebeurtenis wordt geactiveerd wanneer een UDP-pakket is ontvangen voor de betreffende socket.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit:

    (info: ReceiveInfo) => void

onReceiveError

chrome.sockets.udp.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 gepauzeerd en worden er geen verdere onReceive gebeurtenissen meer voor deze socket geactiveerd totdat de socket weer actief is.

Parameters