This page is part of the documentation for the Chrome Apps platform, which was deprecated in 2020. It remains supported for Enterprise and Education customers on ChromeOS until at least Jan 2025. Learn more about migrating your app.

Deze pagina is vertaald door de Cloud Translation API.

chrome.sockets.tcpServer

Beschrijving

Gebruik de chrome.sockets.tcpServer API om servertoepassingen te maken 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

AcceptErrorInfo

Eigenschappen

resultaatCode
nummer
De resultaatcode die is geretourneerd door de onderliggende netwerkaanroep.
socketId
nummer
De server-socket-ID.

AcceptInfo

Eigenschappen

clientSocketId
nummer
De client-socket-ID, dwz de socket-ID van de nieuw tot stand gebrachte verbinding. Deze socket-ID mag alleen worden gebruikt met functies uit de naamruimte chrome.sockets.tcp . Houd er rekening mee dat de client-socket aanvankelijk is gepauzeerd en expliciet door de toepassing moet worden hervat om gegevens te kunnen ontvangen.
socketId
nummer
De server-socket-ID.

CreateInfo

Eigenschappen

socketId
nummer
De ID van de nieuw gemaakte serversocket. 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.

SocketInfo

Eigenschappen

lokaal adres
tekenreeks optioneel
Als de socket luistert, bevat deze het lokale IPv4/6-adres.
lokale poort
nummer optioneel
Als de socket luistert, 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 verbindingsaanvragen op een luisterende socket worden verzonden via de onAccept gebeurtenis of in de wachtrij worden geplaatst in de luisterwachtrijachterstand. Zie setPaused . De standaardwaarde is "false".
volhardend
Booleaans
Vlag die aangeeft of de socket open blijft wanneer de gebeurtenispagina van de toepassing wordt verwijderd (zie SocketProperties.persistent ). De standaardwaarde is "false".
socketId
nummer
De socket-ID.

SocketProperties

Eigenschappen

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 .

Methoden

close()

Belofte

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

Verbreekt de verbinding en vernietigt het stopcontact. Elk gecreëerd stopcontact moet na gebruik worden gesloten. Het socket-ID is niet meer geldig zodra de functie wordt aangeroepen. De socket wordt echter alleen gegarandeerd gesloten wanneer de callback wordt aangeroepen.

Parameters

socketId
nummer
De socket-ID.
Bel terug
functie optioneel
De callback parameter ziet er als volgt uit:
```
()=>void
```

Geeft terug

Beloof <nietig>
Chroom 121+
Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

create()

Belofte

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

Creëert een TCP-serversocket.

Parameters

eigenschappen
SocketProperties optioneel
De socketeigenschappen (optioneel).
Bel terug
functie optioneel
De callback parameter ziet er als volgt uit:
```
(createInfo: CreateInfo)=>void
```
- creëerInfo
  CreëerInfo
  Het resultaat van het maken van sockets.

Geeft terug

Beloof < CreateInfo >
Chroom 121+
Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

disconnect()

Belofte

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

Verbreekt de verbinding met de luisteraansluiting, dwz stopt met het accepteren van nieuwe verbindingen en geeft het adres/poort vrij waaraan de aansluiting is gebonden. De socket-ID blijft geldig en kan bijvoorbeeld worden gebruikt bij listen om verbindingen op een nieuwe poort en een nieuw adres te accepteren.

Parameters

socketId
nummer
De socket-ID.
Bel terug
functie optioneel
De callback parameter ziet er als volgt uit:
```
()=>void
```

Geeft terug

Beloof <nietig>
Chroom 121+
Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getInfo()

Belofte

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

Haalt de status van de gegeven socket op.

Parameters

socketId
nummer
De socket-ID.
Bel terug
functie optioneel
De callback parameter ziet er als volgt uit:
```
(socketInfo: SocketInfo)=>void
```
- stopcontactInfo
  SocketInfo
  Object dat de socketinformatie bevat.

Geeft terug

Beloof het < SocketInfo >
Chroom 121+
Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getSockets()

Belofte

chrome.sockets.tcpServer.getSockets(
  callback?: function,
)

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

Parameters

Bel terug
functie optioneel
De callback parameter ziet er als volgt uit:
```
(socketInfos: SocketInfo[])=>void
```
- socketInfo
  SocketInfo []
  Array van objecten met socketinformatie.

Geeft terug

Beloof het < SocketInfo []>
Chroom 121+
Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

listen()

chrome.sockets.tcpServer.listen(
  socketId: number,
  address: string,
  port: number,
  backlog?: number,
  callback: function,
)

Luistert naar verbindingen op de opgegeven poort en adres. Als de poort/het adres in gebruik is, duidt de callback op een fout.

Parameters

socketId
nummer
De socket-ID.
adres
snaar
Het adres van de lokale machine.
haven
nummer
De poort van de lokale machine. Indien ingesteld op 0 , wordt er dynamisch een vrije poort gekozen. De dynamisch toegewezen poort kan worden gevonden door getInfo aan te roepen.
achterstand
nummer optioneel
Lengte van de luisterwachtrij van de socket. De standaardwaarde is afhankelijk van het besturingssysteem (SOMAXCONN), dat voor de meeste toepassingen een redelijke wachtrijlengte garandeert.
Bel terug
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.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

Schakelt in of uit dat een luisteraansluiting nieuwe verbindingen accepteert. Wanneer gepauzeerd, accepteert een luistersocket nieuwe verbindingen totdat de achterstand (zie listen ) vol is en weigert vervolgens aanvullende verbindingsverzoeken. onAccept gebeurtenissen worden alleen gegenereerd als de socket niet meer wordt gepauzeerd.

Parameters

socketId
nummer
gepauzeerd
Booleaans
Bel terug
functie optioneel
De callback parameter ziet er als volgt uit:
```
()=>void
```

Geeft terug

Beloof <nietig>
Chroom 121+
Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

update()

Belofte

chrome.sockets.tcpServer.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.
Bel terug
functie optioneel
De callback parameter ziet er als volgt uit:
```
()=>void
```

Geeft terug

Beloof <nietig>
Chroom 121+
Beloftes worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

Evenementen

onAccept

chrome.sockets.tcpServer.onAccept.addListener(
  callback: function,
)

Gebeurtenis die optreedt wanneer er verbinding is gemaakt met de serversocket.

Parameters

Bel terug
functie
De callback parameter ziet er als volgt uit:
```
(info: AcceptInfo)=>void
```
- informatie
  AccepteerInfo

onAcceptError

chrome.sockets.tcpServer.onAcceptError.addListener(
  callback: function,
)

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

Parameters

Bel terug
functie
De callback parameter ziet er als volgt uit:
```
(info: AcceptErrorInfo)=>void
```
- informatie
  AccepteerErrorInfo