chrome.sockets.tcpServer

Beschrijving

Gebruik de chrome.sockets.tcpServer API om server-apps te maken met TCP-verbindingen. Deze API vervangt de TCP-functionaliteit die eerder in de chrome.socket API zat.

Manifest

De volgende sleutels moeten in het manifest worden gedefinieerd om deze API te gebruiken.

"sockets"

Typen

AcceptErrorInfo

Eigenschappen

  • resultCode

    getal

    De resultaatcode die is geretourneerd door de onderliggende netwerkaanroep.

  • socketId

    getal

    De serversocket-ID.

AcceptInfo

Eigenschappen

  • clientSocketId

    getal

    De clientsocket-ID, d.w.z. de socket-ID van de nieuwe verbinding. Deze socket-ID mag alleen worden gebruikt met functies uit de naamruimte chrome.sockets.tcp. De clientsocket is in eerste instantie onderbroken en moet expliciet worden hervat door de app om gegevens te ontvangen.

  • socketId

    getal

    De serversocket-ID.

CreateInfo

Eigenschappen

  • socketId

    getal

    De ID van de nieuwe serversocket. Socket-ID's die zijn gemaakt met deze API, zijn niet compatibel met socket-ID's die zijn gemaakt met andere API's, zoals de beëindigde [socket](../socket/)-API.

SocketInfo

Eigenschappen

  • localAddress

    tekenreeks optioneel

    Als de socket luistert, bevat deze het lokale IPv4/6-adres.

  • localPort

    number optioneel

    Als de socket luistert, bevat deze de lokale poort.

  • name

    tekenreeks optioneel

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

  • onderbroken

    booleaans

    Markering die aangeeft of verbindingsverzoeken op een luistersocket worden verzonden via de gebeurtenis onAccept of in de wachtrij voor luisteren worden geplaatst. Zie setPaused. De standaardwaarde is false.

  • persistent

    booleaans

    Markering die aangeeft of de socket open blijft als de gebeurtenispagina van de app wordt verwijderd (zie SocketProperties.persistent). De standaardwaarde is 'false'.

  • socketId

    getal

    De socket-ID.

SocketProperties

Eigenschappen

  • name

    tekenreeks optioneel

    Een door de app gedefinieerde tekenreeks die aan de socket is gekoppeld.

  • persistent

    booleaans optioneel

    Markering die aangeeft of de socket open blijft als de gebeurtenispagina van de app wordt verwijderd (zie App-levenscyclus beheren). De standaardwaarde is false. Als de app wordt geladen, kunnen sockets die eerder zijn geopend met persistent=true, worden opgehaald met getSockets.

Methoden

close()

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

Verbreekt de verbinding en vernietigt de socket. Elke gemaakte socket moet na gebruik worden gesloten. De socket-ID is niet meer geldig zodra de functie wordt aangeroepen. De socket wordt gegarandeerd pas gesloten als de callback wordt aangeroepen.

Parameters

  • socketId

    getal

    De socket-ID.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 121 of hoger

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

create()

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

Maakt een TCP-serversocket.

Parameters

  • property's

    SocketProperties optioneel

    De socket-eigenschappen (optioneel).

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      Het resultaat van het maken van de socket.

Retourzendingen

  • Promise<CreateInfo>

    Chrome 121 of hoger

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

disconnect()

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

Verbreekt de verbinding met de luisterende socket, d.w.z. accepteert geen nieuwe verbindingen meer en geeft het adres/de poort vrij waaraan de socket is gebonden. De socket-ID blijft geldig, deze kan bijvoorbeeld worden gebruikt met listen om verbindingen op een nieuwe poort en een nieuw adres te accepteren.

Parameters

  • socketId

    getal

    De socket-ID.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 121 of hoger

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getInfo()

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

Haalt de status van de aangegeven socket op.

Parameters

  • socketId

    getal

    De socket-ID.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Object met de socketinformatie.

Retourzendingen

  • Promise<SocketInfo>

    Chrome 121 of hoger

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getSockets()

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

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

Parameters

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      Matrix van object met socketinformatie.

Retourzendingen

  • Promise<SocketInfo[]>

    Chrome 121 of hoger

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

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

Parameters

  • socketId

    getal

    De socket-ID.

  • adres

    tekenreeks

    Het adres van het lokale apparaat.

  • poort

    getal

    De poort van het lokale apparaat. Als je dit beleid instelt op 0, wordt er dynamisch een vrije poort gekozen. Je vindt de dynamisch toegewezen poort door getInfo aan te roepen.

  • backlog

    number optioneel

    De lengte van de luisterwachtrij van de socket. De standaardwaarde is afhankelijk van het besturingssysteem (SOMAXCONN), dat zorgt voor een redelijke wachtrijlengte voor de meeste apps.

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (result: number) => void

    • resultaat

      getal

      De resultaatcode die is geretourneerd door de onderliggende netwerkaanroep. Een negatieve waarde geeft een fout aan.

setPaused()

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

Hiermee zet je aan of uit dat een luistersocket nieuwe verbindingen accepteert. Als een luisterende socket is onderbroken, accepteert deze nieuwe verbindingen totdat de backlog (zie de functie listen) vol is. Daarna worden aanvullende verbindingsverzoeken geweigerd. onAccept-gebeurtenissen worden alleen geactiveerd als de socket wordt hervat.

Parameters

  • socketId

    getal

  • onderbroken

    booleaans

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 121 of hoger

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

update()

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

Updatet de socket-eigenschappen.

Parameters

  • socketId

    getal

    De socket-ID.

  • property's

    SocketProperties

    De eigenschappen die je wilt updaten.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 121 of hoger

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

Evenementen

onAccept

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

Gebeurtenis die wordt geactiveerd als er een verbinding is gemaakt met de serversocket.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (info: AcceptInfo) => void

onAcceptError

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

Gebeurtenis die wordt geactiveerd als er een netwerkfout optreedt terwijl de runtime wacht op nieuwe verbindingen op het socketadres en de poort. Zodra deze gebeurtenis wordt geactiveerd, wordt de socket ingesteld op paused en worden er geen onAccept-gebeurtenissen meer geactiveerd voor deze socket totdat de socket wordt hervat.

Parameters