chrome.sockets.tcpServer

Beschrijving

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

AcceptErrorInfo

Eigenschappen

  • resultaatcode

    nummer

    De resultaatcode die is geretourneerd door de onderliggende netwerkoproep.

  • socketId

    nummer

    De server socket-identificatie.

AcceptInfo

Eigenschappen

  • clientSocketId

    nummer

    De client socket-ID, oftewel de socket-ID van de zojuist tot stand gebrachte verbinding. Deze socket-ID mag alleen worden gebruikt met functies uit de namespace chrome.sockets.tcp . Houd er rekening mee dat de client socket in eerste instantie gepauzeerd is en expliciet door de applicatie moet worden gedepauzeerd om gegevens te kunnen ontvangen.

  • socketId

    nummer

    De server socket-identificatie.

CreateInfo

Eigenschappen

  • socketId

    nummer

    De ID van de zojuist aangemaakte serversocket. 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.

SocketInfo

Eigenschappen

  • lokaalAdres

    string optioneel

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

  • lokalePort

    nummer optioneel

    Als de socket luistert, 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 verbindingsverzoeken op een luisterende socket worden verzonden via de onAccept -gebeurtenis of in de wachtrij van de luisteraar worden geplaatst. Zie setPaused . De standaardwaarde is "false".

  • volhardend

    booleaans

    Vlag die aangeeft of de socket open blijft wanneer de gebeurtenispagina van de applicatie wordt afgesloten (zie SocketProperties.persistent ). De standaardwaarde is "false".

  • socketId

    nummer

    De socket-identificatie.

SocketProperties

Eigenschappen

  • 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

close()

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

Verbreekt de verbinding en vernietigt de socket. 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.

create()

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

Hiermee wordt een TCP-serversocket 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.tcpServer.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

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

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

listen()

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

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

Parameters

  • socketId

    nummer

    De socket-identificatie.

  • adres

    snaar

    Het adres van de lokale machine.

  • haven

    nummer

    De poort van de lokale machine. Indien ingesteld op 0 , wordt dynamisch een vrije poort gekozen. De dynamisch toegewezen poort kan worden achterhaald door getInfo aan te roepen.

  • achterstand

    nummer optioneel

    De lengte van de wachtrij van de socket. De standaardwaarde is afhankelijk van het besturingssysteem (SOMAXCONN), wat zorgt voor een redelijke wachtrijlengte voor de meeste toepassingen.

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

Hiermee kunt u een luisterende socket in- of uitschakelen, zodat deze geen nieuwe verbindingen meer kan accepteren. Wanneer een luisterende socket is gepauzeerd, accepteert deze nieuwe verbindingen totdat de wachtrij (zie de functie listen ) vol is. Daarna worden verdere verbindingsverzoeken geweigerd. onAccept -gebeurtenissen worden alleen geactiveerd wanneer de socket weer wordt geactiveerd.

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

onAccept

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

Deze gebeurtenis wordt geactiveerd wanneer een verbinding met de serversocket tot stand is gebracht.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (info: AcceptInfo) => void

onAcceptError

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

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

Parameters