chrome.sockets.tcpServer

Deskripsi

Gunakan chrome.sockets.tcpServer API untuk membuat aplikasi server menggunakan koneksi TCP. API ini menggantikan fungsi TCP yang sebelumnya ada di chrome.socket API.

Manifes

Kunci berikut harus dideklarasikan dalam manifes untuk menggunakan API ini.

"sockets"

Jenis

AcceptErrorInfo

Properti

  • resultCode

    angka

    Kode hasil yang ditampilkan dari panggilan jaringan pokok.

  • socketId

    angka

    ID soket server.

AcceptInfo

Properti

  • clientSocketId

    angka

    ID soket klien, yaitu ID soket dari koneksi yang baru dibuat. ID soket ini hanya boleh digunakan dengan fungsi dari namespace chrome.sockets.tcp. Perhatikan bahwa soket klien awalnya dijeda dan harus diaktifkan secara eksplisit oleh aplikasi untuk mulai menerima data.

  • socketId

    angka

    ID soket server.

CreateInfo

Properti

  • socketId

    angka

    ID soket server yang baru dibuat. Perhatikan bahwa ID soket yang dibuat dari API ini tidak kompatibel dengan ID soket yang dibuat dari API lain, seperti API [socket](../socket/) yang tidak digunakan lagi.

SocketInfo

Properti

  • localAddress

    string opsional

    Jika soket sedang memproses permintaan, berisi alamat IPv4/6 lokalnya.

  • localPort

    nomor opsional

    Jika soket sedang memproses, berisi port lokalnya.

  • nama

    string opsional

    String yang ditentukan aplikasi yang terkait dengan soket.

  • dijeda

    boolean

    Flag yang menunjukkan apakah permintaan koneksi pada soket pendengar dikirim melalui peristiwa onAccept atau diantrekan dalam backlog antrean pendengar. Lihat setPaused. Nilai defaultnya adalah "false".

  • persisten

    boolean

    Flag yang menunjukkan apakah soket tetap terbuka saat halaman peristiwa aplikasi dibatalkan pemuatannya (lihat SocketProperties.persistent). Nilai defaultnya adalah "false".

  • socketId

    angka

    ID soket.

SocketProperties

Properti

  • nama

    string opsional

    String yang ditentukan aplikasi yang terkait dengan soket.

  • persisten

    boolean opsional

    Flag yang menunjukkan apakah soket tetap terbuka saat halaman acara aplikasi dibatalkan pemuatannya (lihat Mengelola Siklus Proses Aplikasi). Nilai defaultnya adalah "false". Saat aplikasi dimuat, semua soket yang sebelumnya dibuka dengan persistent=true dapat diambil dengan getSockets.

Metode

close()

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

Memutuskan koneksi dan menghancurkan soket. Setiap soket yang dibuat harus ditutup setelah digunakan. ID soket tidak lagi valid segera setelah fungsi dipanggil. Namun, soket dijamin hanya akan ditutup saat callback dipanggil.

Parameter

  • socketId

    angka

    ID soket.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 121+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

create()

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

Membuat soket server TCP.

Parameter

  • properti

    SocketProperties opsional

    Properti soket (opsional).

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (createInfo: CreateInfo) => void

Hasil

  • Promise<CreateInfo>

    Chrome 121+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

disconnect()

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

Memutuskan soket pendengar, yaitu berhenti menerima koneksi baru dan melepaskan alamat/port yang terikat ke soket. ID soket tetap valid, misalnya, dapat digunakan dengan listen untuk menerima koneksi di port dan alamat baru.

Parameter

  • socketId

    angka

    ID soket.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 121+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getInfo()

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

Mengambil status soket yang diberikan.

Parameter

  • socketId

    angka

    ID soket.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Objek yang berisi informasi soket.

Hasil

  • Promise<SocketInfo>

    Chrome 121+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

getSockets()

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

Mengambil daftar soket yang saat ini terbuka dan dimiliki oleh aplikasi.

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      Array objek yang berisi informasi soket.

Hasil

  • Promise<SocketInfo[]>

    Chrome 121+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

listen()

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

Memproses koneksi pada port dan alamat yang ditentukan. Jika port/alamat sedang digunakan, callback akan menunjukkan kegagalan.

Parameter

  • socketId

    angka

    ID soket.

  • alamat

    string

    Alamat mesin lokal.

  • port

    angka

    Port mesin lokal. Jika disetel ke 0, port gratis akan dipilih secara dinamis. Port yang dialokasikan secara dinamis dapat ditemukan dengan memanggil getInfo.

  • backlog

    nomor opsional

    Panjang antrean pendengar soket. Nilai default bergantung pada Sistem Operasi (SOMAXCONN), yang memastikan panjang antrean yang wajar untuk sebagian besar aplikasi.

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (result: number) => void

    • hasil

      angka

      Kode hasil yang ditampilkan dari panggilan jaringan pokok. Nilai negatif menunjukkan error.

setPaused()

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

Mengaktifkan atau menonaktifkan soket pendengar agar menerima koneksi baru. Saat dijeda, soket pendengar menerima koneksi baru hingga backlog-nya (lihat fungsi listen) penuh, lalu menolak permintaan koneksi tambahan. Peristiwa onAccept hanya dipicu saat soket tidak dijeda.

Parameter

  • socketId

    angka

  • dijeda

    boolean

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 121+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

update()

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

Memperbarui properti socket.

Parameter

  • socketId

    angka

    ID soket.

  • properti

    SocketProperties

    Properti yang akan diperbarui.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    () => void

Hasil

  • Promise<void>

    Chrome 121+

    Promise hanya didukung untuk Manifest V3 dan yang lebih baru, platform lain harus menggunakan callback.

Acara

onAccept

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

Peristiwa yang muncul saat koneksi telah dibuat ke socket server.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti: 

    (info: AcceptInfo) => void

onAcceptError

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

Peristiwa yang dimunculkan saat terjadi error jaringan ketika runtime menunggu koneksi baru di alamat dan port soket. Setelah peristiwa ini dimunculkan, soket akan disetel ke paused dan tidak ada lagi peristiwa onAccept yang dimunculkan untuk soket ini hingga soket dilanjutkan.

Parameter