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 yang mendasarinya.

  • 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 secara eksplisit berhenti dijeda 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 [socket](../socket/) API yang tidak digunakan lagi.

SocketInfo

Properti

  • localAddress

    string opsional

    Jika soket mendengarkan, berarti soket berisi alamat IPv4/6 lokalnya.

  • localPort

    nomor opsional

    Jika soket sedang mendengarkan, berarti soket itu berisi port lokalnya.

  • name

    string opsional

    String yang ditentukan aplikasi yang terkait dengan soket.

  • dijeda

    boolean

    Tanda yang menunjukkan apakah permintaan koneksi pada soket pemroses dikirim melalui peristiwa onAccept atau diantrekan di backlog antrean pemrosesan. Lihat setPaused. Nilai defaultnya adalah "false".

  • persisten

    boolean

    Tanda yang menunjukkan apakah soket tetap terbuka saat halaman peristiwa aplikasi dihapus muatannya (lihat SocketProperties.persistent). Nilai defaultnya adalah "false".

  • socketId

    angka

    ID soket.

SocketProperties

Properti

  • name

    string opsional

    String yang ditentukan aplikasi yang terkait dengan soket.

  • persisten

    boolean opsional

    Tanda yang menunjukkan apakah soket tetap terbuka saat halaman peristiwa aplikasi dihapus muatannya (lihat Mengelola Siklus Proses Aplikasi). Nilai defaultnya adalah "false". Saat aplikasi dimuat, setiap soket yang sebelumnya dibuka dengan persistent=true dapat diambil dengan getSockets.

Metode

close()

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

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

Parameter

  • socketId

    angka

    ID soket.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    ()=>void

Hasil

  • Promise<void>

    Chrome 121 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

create()

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

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 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

disconnect()

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

Memutuskan sambungan soket yang mendengarkan, yaitu berhenti menerima koneksi baru dan melepaskan alamat/port yang terikat dengan 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 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

getInfo()

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

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 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

getSockets()

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

Mengambil daftar soket yang saat ini terbuka yang 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 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

listen()

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

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 komputer lokal.

  • port

    angka

    Port komputer lokal. Jika ditetapkan ke 0, port bebas akan dipilih secara dinamis. Port yang dialokasikan secara dinamis dapat ditemukan dengan memanggil getInfo.

  • backlog

    nomor opsional

    Panjang antrean pemrosesan soket. Nilai defaultnya 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 yang mendasarinya. Nilai negatif menunjukkan error.

setPaused()

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

Mengaktifkan atau menonaktifkan soket yang memproses agar tidak menerima koneksi baru. Saat dijeda, soket pemroses 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 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

update()

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

Memperbarui properti soket.

Parameter

  • socketId

    angka

    ID soket.

  • properti

    SocketProperties

    Properti yang akan diperbarui.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    ()=>void

Hasil

  • Promise<void>

    Chrome 121 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

Peristiwa

onAccept

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

Peristiwa timbul ketika koneksi telah dibuat ke soket server.

Parameter

onAcceptError

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

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

Parameter