Beschreibung
Verwenden Sie die chrome.sockets.tcpServer
API, um Serveranwendungen mit TCP-Verbindungen zu erstellen. Diese API ersetzt die bisherige TCP-Funktion der chrome.socket
API.
Manifest
Die folgenden Schlüssel müssen im Manifest deklariert werden, um diese API verwenden zu können.
"sockets"
Typen
AcceptErrorInfo
Attribute
-
resultCode
Zahl
Der Ergebniscode, der vom zugrunde liegenden Netzwerkaufruf zurückgegeben wurde.
-
socketId
Zahl
Die Server-Socket-ID.
AcceptInfo
Attribute
-
clientSocketId
Zahl
Die Client-Socket-ID, d.h. die Socket-ID der neu hergestellten Verbindung. Diese Socket-ID sollte nur mit Funktionen aus dem Namespace
chrome.sockets.tcp
verwendet werden. Beachten Sie, dass der Client-Socket anfänglich pausiert ist und von der Anwendung explizit wieder aktiviert werden muss, um mit dem Empfang von Daten zu beginnen. -
socketId
Zahl
Die Server-Socket-ID.
CreateInfo
Attribute
-
socketId
Zahl
Die ID des neu erstellten Server-Sockets. Beachten Sie, dass die von dieser API erstellten Socket-IDs nicht mit Socket-IDs kompatibel sind, die von anderen APIs erstellt wurden, z. B. der verworfenen
[
Socket](../socket/)
API.
SocketInfo
Attribute
-
localAddress
String optional
Enthält seine lokale IPv4/6-Adresse, wenn der Socket überwacht.
-
localPort
Nummer optional
Enthält seinen lokalen Port, wenn der Socket überwacht.
-
name
String optional
Anwendungsdefinierter String, der dem Socket zugeordnet ist.
-
pausiert
boolean
Flag, das angibt, ob Verbindungsanfragen für einen wartenden Socket über das Ereignis
onAccept
weitergeleitet oder im Rückstand der Warteschlange für die Überwachung in die Warteschlange gestellt werden.setPaused
ansehen. Der Standardwert lautet „false“. -
nichtflüchtige
boolean
Flag, das angibt, ob der Socket geöffnet bleibt, wenn die Ereignisseite der App entladen wird (siehe
SocketProperties.persistent
). Der Standardwert ist „false“. -
socketId
Zahl
Die Socket-ID.
SocketProperties
Attribute
-
name
String optional
Ein anwendungsdefinierter String, der dem Socket zugeordnet ist.
-
nichtflüchtige
Boolescher Wert optional
Flag, das angibt, ob der Socket geöffnet bleibt, wenn die Ereignisseite der App entladen wird (siehe App-Lebenszyklus verwalten). Der Standardwert ist „false“. Wenn die Anwendung geladen wird, können alle Sockets, die zuvor mit persistent=true geöffnet wurden, mit
getSockets
abgerufen werden.
Methoden
close()
chrome.sockets.tcpServer.close(
socketId: number,
callback?: function,
)
Trennt den Socket und zerstört ihn. Jeder erstellte Socket sollte nach der Verwendung geschlossen werden. Die Socket-ID ist nicht mehr gültig, sobald die Funktion aufgerufen wird. Der Socket wird jedoch nur dann garantiert, wenn der Callback aufgerufen wird.
Parameters
-
socketId
Zahl
Die Socket-ID.
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:() => void
Rückgaben
-
Promise<void>
Chrome 121 und höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
create()
chrome.sockets.tcpServer.create(
properties?: SocketProperties,
callback?: function,
)
Erstellt einen TCP-Server-Socket.
Parameters
-
Properties
SocketProperties optional
Die Socket-Eigenschaften (optional).
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:(createInfo: CreateInfo) => void
-
createInfo
Das Ergebnis der Socket-Erstellung.
-
Rückgaben
-
Promise<CreateInfo>
Chrome 121 und höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
disconnect()
chrome.sockets.tcpServer.disconnect(
socketId: number,
callback?: function,
)
Trennt den überwachenden Socket, d.h. es werden keine neuen Verbindungen mehr angenommen und die Adresse/der Port freigegeben, an den der Socket gebunden ist. Die Socket-ID bleibt gültig. Sie kann beispielsweise mit listen
verwendet werden, um Verbindungen an einem neuen Port und einer neuen Adresse zu akzeptieren.
Parameters
-
socketId
Zahl
Die Socket-ID.
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:() => void
Rückgaben
-
Promise<void>
Chrome 121 und höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
getInfo()
chrome.sockets.tcpServer.getInfo(
socketId: number,
callback?: function,
)
Ruft den Status des angegebenen Sockets ab.
Parameters
-
socketId
Zahl
Die Socket-ID.
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:(socketInfo: SocketInfo) => void
-
socketInfo
Objekt mit den Socket-Informationen.
-
Rückgaben
-
Promise<SocketInfo>
Chrome 121 und höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
getSockets()
chrome.sockets.tcpServer.getSockets(
callback?: function,
)
Ruft die Liste der aktuell geöffneten Sockets ab, die der Anwendung gehören.
Parameters
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:(socketInfos: SocketInfo[]) => void
-
socketInfos
Array eines Objekts mit Socket-Informationen.
-
Rückgaben
-
Promise<SocketInfo[]>
Chrome 121 und höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
listen()
chrome.sockets.tcpServer.listen(
socketId: number,
address: string,
port: number,
backlog?: number,
callback: function,
)
Wartet auf Verbindungen für den angegebenen Port und die angegebene Adresse. Wenn der Port oder die Adresse bereits verwendet wird, gibt der Callback einen Fehler an.
Parameters
-
socketId
Zahl
Die Socket-ID.
-
Adresse
String
Die Adresse des lokalen Computers.
-
Port
Zahl
Der Port des lokalen Computers. Wenn die Richtlinie auf
0
gesetzt ist, wird ein kostenloser Port dynamisch ausgewählt. Der dynamisch zugewiesene Port kann durch Aufrufen vongetInfo
ermittelt werden. -
Rückstand
Nummer optional
Länge der Überwachungswarteschlange des Sockets. Der Standardwert hängt vom Betriebssystem (SOMAXCONN) ab. Dadurch ist für die meisten Anwendungen eine angemessene Warteschlangenlänge gewährleistet.
-
callback
Funktion
Der Parameter
callback
sieht so aus:(result: number) => void
-
Ergebnis
Zahl
Der Ergebniscode, der vom zugrunde liegenden Netzwerkaufruf zurückgegeben wurde. Ein negativer Wert weist auf einen Fehler hin.
-
setPaused()
chrome.sockets.tcpServer.setPaused(
socketId: number,
paused: boolean,
callback?: function,
)
Aktiviert oder deaktiviert einen Überwachungs-Socket, der neue Verbindungen annimmt. Wenn der Dienst pausiert ist, akzeptiert ein wartender Socket neue Verbindungen, bis sein Rückstand (siehe listen
-Funktion) voll ist, und lehnt dann zusätzliche Verbindungsanfragen ab. onAccept
-Ereignisse werden nur ausgelöst, wenn die Pausierung des Sockets aufgehoben wird.
Parameters
-
socketId
Zahl
-
pausiert
boolean
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:() => void
Rückgaben
-
Promise<void>
Chrome 121 und höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
update()
chrome.sockets.tcpServer.update(
socketId: number,
properties: SocketProperties,
callback?: function,
)
Aktualisiert die Socket-Attribute.
Parameters
-
socketId
Zahl
Die Socket-ID.
-
Properties
Die zu aktualisierenden Attribute.
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:() => void
Rückgaben
-
Promise<void>
Chrome 121 und höherPromise-Objekte werden nur für Manifest V3 und höher unterstützt. Andere Plattformen müssen Callbacks verwenden.
Veranstaltungen
onAccept
chrome.sockets.tcpServer.onAccept.addListener(
callback: function,
)
Ereignis wird ausgelöst, wenn eine Verbindung zum Server-Socket hergestellt wurde.
Parameters
-
callback
Funktion
Der Parameter
callback
sieht so aus:(info: AcceptInfo) => void
-
Info
-
onAcceptError
chrome.sockets.tcpServer.onAcceptError.addListener(
callback: function,
)
Ereignis, das ausgelöst wird, wenn ein Netzwerkfehler aufgetreten ist, während die Laufzeit auf neue Verbindungen für die Socket-Adresse und den Port gewartet hat. Sobald dieses Ereignis ausgelöst wird, wird der Socket auf paused
gesetzt und es werden keine weiteren onAccept
-Ereignisse für diesen Socket ausgelöst, bis der Socket fortgesetzt wird.
Parameters
-
callback
Funktion
Der Parameter
callback
sieht so aus:(info: AcceptErrorInfo) => void
-
Info
-