Beschrijving
Gebruik de chrome.socket
API om gegevens via het netwerk te verzenden en te ontvangen via TCP- en UDP-verbindingen. Opmerking: Vanaf Chrome 33 is deze API verouderd ten gunste van de API's sockets.udp
, sockets.tcp
en sockets.tcpServer
.
Machtigingen
socket
Soorten
AcceptInfo
Eigenschappen
- resultaatCode
nummer
- socketId
nummer optioneel
De ID van de geaccepteerde socket.
CreateInfo
Eigenschappen
- socketId
nummer
De id van de nieuw gemaakte socket.
CreateOptions
NetworkInterface
Eigenschappen
- adres
snaar
Het beschikbare IPv4/6-adres.
- naam
snaar
De onderliggende naam van de adapter. Op *nix zal dit doorgaans "eth0", "lo", enz. zijn.
- voorvoegselLengte
nummer
De lengte van het voorvoegsel
ReadInfo
Eigenschappen
- gegevens
ArrayBuffer
- resultaatCode
nummer
De resultCode die is geretourneerd door de onderliggende read()-aanroep.
RecvFromInfo
Eigenschappen
- adres
snaar
Het adres van de externe machine.
- gegevens
ArrayBuffer
- haven
nummer
- resultaatCode
nummer
De resultCode die is geretourneerd door de onderliggende recvfrom()-aanroep.
SecureOptions
Eigenschappen
- tlsVersie
TLSVersionConstraints optioneel
SocketInfo
Eigenschappen
- aangesloten
Booleaans
Of het onderliggende stopcontact al dan niet is aangesloten.
Voor
tcp
sockets blijft dit waar, zelfs als de externe peer de verbinding heeft verbroken. Lezen of schrijven naar de socket kan dan resulteren in een fout, wat erop duidt dat deze socket moet worden losgekoppeld viadisconnect()
.Voor
udp
sockets geeft dit alleen aan of er een standaard extern adres is opgegeven voor het lezen en schrijven van pakketten. - lokaalAdres
tekenreeks optioneel
Als de onderliggende socket gebonden of verbonden is, bevat deze het lokale IPv4/6-adres.
- lokale poort
nummer optioneel
Als de onderliggende socket gebonden of verbonden is, bevat deze de lokale poort.
- peerAdres
tekenreeks optioneel
Als de onderliggende socket is aangesloten, bevat deze het IPv4/6-adres van de peer.
- peerPort
nummer optioneel
Als de onderliggende socket is aangesloten, bevat deze de poort van de aangesloten peer.
- socketType
Het type van de doorgegeven socket. Dit zal
tcp
ofudp
zijn.
SocketType
Enum
"tcp" "udp"
TLSVersionConstraints
Eigenschappen
- maximaal
tekenreeks optioneel
- min
tekenreeks optioneel
De minimaal en maximaal acceptabele versies van TLS. Ondersteunde waarden zijn
tls1.2
oftls1.3
.De waarden
tls1
entls1.1
worden niet langer ondersteund. Alsmin
op een van deze waarden wordt ingesteld, wordt deze stilletjes vastgeklemd optls1.2
. Alsmax
is ingesteld op een van deze waarden, of op een andere niet-herkende waarde, wordt deze stilzwijgend genegeerd.
WriteInfo
Eigenschappen
- bytesGeschreven
nummer
Het aantal verzonden bytes of een negatieve foutcode.
Methoden
accept()
chrome.socket.accept(
socketId: number,
callback: function,
)
Deze methode is alleen van toepassing op TCP-sockets. Registreert een callback-functie die moet worden aangeroepen wanneer een verbinding wordt geaccepteerd op deze luisterende server-socket. Luister moet eerst worden gebeld. Als er al een actieve accept callback is, wordt deze callback onmiddellijk aangeroepen met een fout als resultCode.
Parameters
- socketId
nummer
De socketId.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(acceptInfo: AcceptInfo) => void
- accepterenInfo
bind()
chrome.socket.bind(
socketId: number,
address: string,
port: number,
callback: function,
)
Bindt het lokale adres voor socket. Momenteel ondersteunt het geen TCP-socket.
Parameters
- socketId
nummer
De socketId.
- adres
snaar
Het adres van de lokale machine.
- haven
nummer
De poort van de lokale machine.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(result: number) => void
- resultaat
nummer
connect()
chrome.socket.connect(
socketId: number,
hostname: string,
port: number,
callback: function,
)
Verbindt de socket met de externe machine (voor een tcp
socket). Voor een udp
socket stelt dit het standaardadres in waarnaar pakketten worden verzonden en waarvandaan wordt gelezen voor read()
en write()
-aanroepen.
Parameters
- socketId
nummer
De socketId.
- hostnaam
snaar
De hostnaam of het IP-adres van de externe machine.
- haven
nummer
De poort van de externe machine.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(result: number) => void
- resultaat
nummer
create()
chrome.socket.create(
type: SocketType,
options?: CreateOptions,
callback?: function,
)
Creëert een socket van het opgegeven type die verbinding maakt met de opgegeven externe machine.
Parameters
- type
Het type socket dat moet worden gemaakt. Moet
tcp
ofudp
zijn. - opties
CreateOptions optioneel
De socket-opties.
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:(createInfo: CreateInfo) => void
- creëerInfo
Retouren
Beloof < CreateInfo >
Chroom 121+Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.
destroy()
chrome.socket.destroy(
socketId: number,
)
Vernietigt de socket. Elke gemaakte socket moet na gebruik worden vernietigd.
Parameters
- socketId
nummer
De socketId.
disconnect()
chrome.socket.disconnect(
socketId: number,
)
Ontkoppelt het stopcontact. Voor UDP-sockets is disconnect
een niet-bewerking, maar het is veilig om aan te roepen.
Parameters
- socketId
nummer
De socketId.
getInfo()
chrome.socket.getInfo(
socketId: number,
callback?: function,
)
Haalt de status van de gegeven socket op.
Parameters
- socketId
nummer
De socketId.
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:(result: SocketInfo) => void
- resultaat
Retouren
Beloof het < SocketInfo >
Chroom 121+Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.
getJoinedGroups()
chrome.socket.getJoinedGroups(
socketId: number,
callback: function,
)
Haal de multicast-groepsadressen op waar de socket momenteel lid van is.
Parameters
- socketId
nummer
De socketId.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(groups: string[]) => void
- groepen
snaar[]
getNetworkList()
chrome.socket.getNetworkList(
callback?: function,
)
Haalt informatie op over lokale adapters op dit systeem.
Parameters
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:(result: NetworkInterface[]) => void
- resultaat
Retouren
Beloof < NetwerkInterface []>
Chroom 121+Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.
joinGroup()
chrome.socket.joinGroup(
socketId: number,
address: string,
callback: function,
)
Sluit u aan bij de multicastgroep en begin pakketten van die groep te ontvangen. De socket moet van het UDP-type zijn en moet aan een lokale poort zijn gebonden voordat deze methode wordt aangeroepen.
Parameters
- socketId
nummer
De socketId.
- adres
snaar
Het groepsadres waaraan u wilt deelnemen. Domeinnamen worden niet ondersteund.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(result: number) => void
- resultaat
nummer
leaveGroup()
chrome.socket.leaveGroup(
socketId: number,
address: string,
callback: function,
)
Verlaat de multicastgroep waar u eerder lid van bent geworden met joinGroup
. Het is niet nodig om de multicastgroep te verlaten voordat u de socket vernietigt of afsluit. Dit wordt automatisch aangeroepen door het besturingssysteem.
Als u de groep verlaat, voorkomt u dat de router multicast-datagrammen naar de lokale host verzendt, ervan uitgaande dat er geen ander proces op de host nog bij de groep is aangesloten.
Parameters
- socketId
nummer
De socketId.
- adres
snaar
Het groepsadres om te vertrekken. Domeinnamen worden niet ondersteund.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(result: number) => void
- resultaat
nummer
listen()
chrome.socket.listen(
socketId: number,
address: string,
port: number,
backlog?: number,
callback: function,
)
Deze methode is alleen van toepassing op TCP-sockets. Luistert naar verbindingen op de opgegeven poort en adres. Dit maakt dit feitelijk tot een server-socket en client-socket-functies (verbinden, lezen, schrijven) kunnen niet langer op deze socket worden gebruikt.
Parameters
- socketId
nummer
De socketId.
- adres
snaar
Het adres van de lokale machine.
- haven
nummer
De poort van de lokale machine.
- achterstand
nummer optioneel
Lengte van de luisterwachtrij van de socket.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(result: number) => void
- resultaat
nummer
read()
chrome.socket.read(
socketId: number,
bufferSize?: number,
callback: function,
)
Leest gegevens van de opgegeven aangesloten socket.
Parameters
- socketId
nummer
De socketId.
- buffergrootte
nummer optioneel
De leesbuffergrootte.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(readInfo: ReadInfo) => void
- leesInfo
recvFrom()
chrome.socket.recvFrom(
socketId: number,
bufferSize?: number,
callback: function,
)
Ontvangt gegevens van de opgegeven UDP-socket.
Parameters
- socketId
nummer
De socketId.
- buffergrootte
nummer optioneel
De ontvangstbuffergrootte.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(recvFromInfo: RecvFromInfo) => void
- recvFromInfo
secure()
chrome.socket.secure(
socketId: number,
options?: SecureOptions,
callback: function,
)
Start een TLS-clientverbinding via een verbonden TCP-clientsocket.
Parameters
- socketId
nummer
Het aangesloten stopcontact dat u moet 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
sendTo()
chrome.socket.sendTo(
socketId: number,
data: ArrayBuffer,
address: string,
port: number,
callback: function,
)
Verzendt gegevens over de opgegeven UDP-socket naar het opgegeven adres en de opgegeven poort.
Parameters
- socketId
nummer
De socketId.
- gegevens
ArrayBuffer
De gegevens die moeten worden geschreven.
- adres
snaar
Het adres van de externe machine.
- haven
nummer
De poort van de externe machine.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(writeInfo: WriteInfo) => void
- schrijfInfo
setKeepAlive()
chrome.socket.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 socketId.
- 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: boolean) => void
- resultaat
Booleaans
setMulticastLoopbackMode()
chrome.socket.setMulticastLoopbackMode(
socketId: number,
enabled: boolean,
callback: function,
)
Stel in of multicastpakketten die van de host naar de multicastgroep worden verzonden, worden teruggestuurd naar de host.
Opmerking: het gedrag van setMulticastLoopbackMode
verschilt enigszins tussen Windows en Unix-achtige systemen. De inconsistentie doet zich alleen voor als er meer dan één applicatie op dezelfde host is aangesloten bij dezelfde multicastgroep, terwijl er verschillende instellingen zijn in de multicast-loopback-modus. Op Windows zullen de toepassingen waarbij loopback is uitgeschakeld de loopback-pakketten niet ONTVANGEN; terwijl op Unix-achtige systemen de applicaties waarbij loopback uitgeschakeld is, de loopback-pakketten niet naar andere applicaties op dezelfde host VERZENDEN. Zie MSDN: http://goo.gl/6vqbj
Voor het aanroepen van deze methode zijn geen multicast-machtigingen vereist.
Parameters
- socketId
nummer
De socketId.
- ingeschakeld
Booleaans
Geef aan of u de loopback-modus wilt inschakelen.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(result: number) => void
- resultaat
nummer
setMulticastTimeToLive()
chrome.socket.setMulticastTimeToLive(
socketId: number,
ttl: number,
callback: function,
)
Stel de time-to-live in van multicast-pakketten die naar de multicast-groep worden verzonden.
Voor het aanroepen van deze methode zijn geen multicast-machtigingen vereist.
Parameters
- socketId
nummer
De socketId.
- tl
nummer
De time-to-live-waarde.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(result: number) => void
- resultaat
nummer
setNoDelay()
chrome.socket.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 socketId.
- geenvertraging
Booleaans
Indien waar, wordt het algoritme van Nagle uitgeschakeld.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(result: boolean) => void
- resultaat
Booleaans
write()
chrome.socket.write(
socketId: number,
data: ArrayBuffer,
callback: function,
)
Schrijft gegevens op de gegeven aangesloten socket.
Parameters
- socketId
nummer
De socketId.
- gegevens
ArrayBuffer
De gegevens die moeten worden geschreven.
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(writeInfo: WriteInfo) => void
- schrijfInfo