Deskripsi
Gunakan chrome.sockets.udp
API untuk mengirim dan menerima data melalui jaringan menggunakan koneksi UDP. API ini menggantikan fungsi UDP yang sebelumnya ada di API "socket".
Manifes
Jenis
CreateInfo
Properti
-
socketId
angka
ID soket 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.
DnsQueryType
Preferensi resolusi DNS. Defaultnya adalah any
dan menggunakan konfigurasi OS saat ini yang mungkin menampilkan IPv4 atau IPv6. ipv4
memaksa IPv4, dan ipv6
memaksa IPv6.
Enum
"ipv4"
"ipv6"
ReceiveErrorInfo
Properti
-
resultCode
angka
Kode hasil yang ditampilkan dari panggilan recvfrom() yang mendasarinya.
-
socketId
angka
ID soket.
ReceiveInfo
Properti
-
data
ArrayBuffer
Konten paket UDP (dipotong sesuai ukuran buffer saat ini).
-
remoteAddress
string
Alamat host tempat paket berasal.
-
remotePort
angka
Port host tempat paket berasal.
-
socketId
angka
ID soket.
SendInfo
Properti
-
bytesSent
nomor opsional
Jumlah byte yang dikirim (jika hasil == 0)
-
resultCode
angka
Kode hasil yang ditampilkan dari panggilan jaringan yang mendasarinya. Nilai negatif menunjukkan error.
SocketInfo
Properti
-
bufferSize
nomor opsional
Ukuran buffer yang digunakan untuk menerima data. Jika tidak ada ukuran buffer yang ditentukan secara eksplisit, nilainya tidak akan diberikan.
-
localAddress
string opsional
Jika soket yang mendasarinya terikat, berisi alamat IPv4/6 lokalnya.
-
localPort
nomor opsional
Jika soket yang mendasarinya terikat, berisi port lokalnya.
-
name
string opsional
String yang ditentukan aplikasi yang terkait dengan soket.
-
dijeda
boolean
Tanda yang menunjukkan apakah soket diblokir agar tidak mengaktifkan peristiwa onReceive.
-
persisten
boolean
Tanda yang menunjukkan apakah soket dibiarkan terbuka saat aplikasi ditangguhkan (lihat
SocketProperties.persistent
). -
socketId
angka
ID soket.
SocketProperties
Properti
-
bufferSize
nomor opsional
Ukuran buffer yang digunakan untuk menerima data. Jika buffer terlalu kecil untuk menerima paket UDP, data akan hilang. Nilai defaultnya adalah 4096.
-
name
string opsional
String yang ditentukan aplikasi yang terkait dengan soket.
-
persisten
boolean opsional
Tanda yang menunjukkan apakah soket dibiarkan 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
bind()
chrome.sockets.udp.bind(
socketId: number,
address: string,
port: number,
callback: function,
)
Mengikat alamat lokal dan port untuk soket. Untuk soket klien, sebaiknya gunakan port 0 agar platform dapat memilih port bebas.
Setelah operasi bind
berhasil diselesaikan, peristiwa onReceive
akan dipicu saat paket UDP tiba di alamat/port yang ditentukan -- kecuali jika soket dijeda.
Parameter
-
socketId
angka
ID soket.
-
alamat
string
Alamat komputer lokal. Format nama DNS, IPv4, dan IPv6 didukung. Gunakan "0.0.0.0" untuk menerima paket dari semua antarmuka jaringan lokal yang tersedia.
-
port
angka
Port komputer lokal. Gunakan "0" untuk mengikat ke port gratis.
-
callback
fungsi
Parameter
callback
terlihat seperti:(result: number) => void
-
hasil
angka
Kode hasil yang ditampilkan dari panggilan jaringan yang mendasarinya. Nilai negatif menunjukkan error.
-
close()
chrome.sockets.udp.close(
socketId: number,
callback?: function,
)
Menutup soket dan melepaskan alamat/port yang terikat ke 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 baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
create()
chrome.sockets.udp.create(
properties?: SocketProperties,
callback?: function,
)
Membuat soket UDP dengan properti yang diberikan.
Parameter
-
properti
SocketProperties opsional
Properti soket (opsional).
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(createInfo: CreateInfo) => void
-
createInfo
Hasil pembuatan soket.
-
Hasil
-
Promise<CreateInfo>
Chrome 121 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
getInfo()
chrome.sockets.udp.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
Objek yang berisi informasi soket.
-
Hasil
-
Promise<SocketInfo>
Chrome 121 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
getJoinedGroups()
chrome.sockets.udp.getJoinedGroups(
socketId: number,
callback?: function,
)
Mendapatkan alamat grup multicast yang saat ini digabungkan dengan soket.
Parameter
-
socketId
angka
ID soket.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(groups: string[]) => void
-
grup
string[]
Array grup yang digabungkan soket.
-
Hasil
-
Promise<string[]>
Chrome 121 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
getSockets()
chrome.sockets.udp.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
Array objek yang berisi informasi soket.
-
Hasil
-
Promise<SocketInfo[]>
Chrome 121 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
joinGroup()
chrome.sockets.udp.joinGroup(
socketId: number,
address: string,
callback: function,
)
Bergabung dengan grup multicast dan mulai menerima paket dari grup tersebut. Soket harus terikat dengan port lokal sebelum memanggil metode ini.
Parameter
-
socketId
angka
ID soket.
-
alamat
string
Alamat grup untuk bergabung. Nama domain tidak didukung.
-
callback
fungsi
Parameter
callback
terlihat seperti:(result: number) => void
-
hasil
angka
Kode hasil yang ditampilkan dari panggilan jaringan yang mendasarinya. Nilai negatif menunjukkan error.
-
leaveGroup()
chrome.sockets.udp.leaveGroup(
socketId: number,
address: string,
callback: function,
)
Keluar dari grup multicast yang sebelumnya digabungkan menggunakan joinGroup
. Anda hanya perlu memanggilnya jika setelah itu Anda berencana untuk tetap menggunakan soket, karena hal ini akan dilakukan secara otomatis oleh OS saat soket ditutup.
Keluar dari grup akan mencegah router mengirim datagram multicast ke host lokal, dengan asumsi tidak ada proses lain di host yang masih bergabung ke grup.
Parameter
-
socketId
angka
ID soket.
-
alamat
string
Alamat grup yang akan keluar. Nama domain tidak didukung.
-
callback
fungsi
Parameter
callback
terlihat seperti:(result: number) => void
-
hasil
angka
Kode hasil yang ditampilkan dari panggilan jaringan yang mendasarinya. Nilai negatif menunjukkan error.
-
send()
chrome.sockets.udp.send(
socketId: number,
data: ArrayBuffer,
address: string,
port: number,
dnsQueryType?: DnsQueryType,
callback: function,
)
Mengirim data pada soket yang diberikan ke alamat dan port yang diberikan. Soket harus terikat dengan port lokal sebelum memanggil metode ini.
Parameter
-
socketId
angka
ID soket.
-
data
ArrayBuffer
Data yang akan dikirim.
-
alamat
string
Alamat perangkat jarak jauh.
-
port
angka
Port komputer jarak jauh.
-
dnsQueryType
DnsQueryType opsional
Chrome 103 dan yang lebih baruPreferensi resolusi alamat.
-
callback
fungsi
Parameter
callback
terlihat seperti:(sendInfo: SendInfo) => void
-
sendInfo
Hasil metode
send
.
-
setBroadcast()
chrome.sockets.udp.setBroadcast(
socketId: number,
enabled: boolean,
callback: function,
)
Mengaktifkan atau menonaktifkan paket siaran pada soket ini.
Parameter
-
socketId
angka
ID soket.
-
diaktifkan
boolean
true
untuk mengaktifkan paket siaran,false
untuk menonaktifkannya. -
callback
fungsi
Parameter
callback
terlihat seperti:(result: number) => void
-
hasil
angka
Kode hasil yang ditampilkan dari panggilan jaringan yang mendasarinya.
-
setMulticastLoopbackMode()
chrome.sockets.udp.setMulticastLoopbackMode(
socketId: number,
enabled: boolean,
callback: function,
)
Menetapkan apakah paket multicast yang dikirim dari host ke grup multicast akan di-loop kembali ke host.
Catatan: perilaku setMulticastLoopbackMode
sedikit berbeda antara sistem Windows dan Unix yang mirip. Inkonsistensi hanya terjadi jika ada lebih dari satu aplikasi pada host yang sama yang digabungkan ke grup multicast yang sama, tetapi memiliki setelan yang berbeda pada mode loopback multicast. Di Windows, aplikasi yang memiliki loopback nonaktif tidak akan MENERIMA paket loopback; sementara pada sistem yang menyerupai Unix, aplikasi yang memiliki loopback nonaktif tidak akan MENGIRIMKAN paket loopback ke aplikasi lain pada host yang sama. Lihat MSDN: http://goo.gl/6vqbj
Memanggil metode ini tidak memerlukan izin multicast.
Parameter
-
socketId
angka
ID soket.
-
diaktifkan
boolean
Tentukan apakah mode loopback diaktifkan atau tidak.
-
callback
fungsi
Parameter
callback
terlihat seperti:(result: number) => void
-
hasil
angka
Kode hasil yang ditampilkan dari panggilan jaringan yang mendasarinya. Nilai negatif menunjukkan error.
-
setMulticastTimeToLive()
chrome.sockets.udp.setMulticastTimeToLive(
socketId: number,
ttl: number,
callback: function,
)
Menetapkan waktu aktif paket multicast yang dikirim ke grup multicast.
Memanggil metode ini tidak memerlukan izin multicast.
Parameter
-
socketId
angka
ID soket.
-
ttl
angka
Nilai time to live.
-
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()
chrome.sockets.udp.setPaused(
socketId: number,
paused: boolean,
callback?: function,
)
Menjeda atau membatalkan jeda soket. Soket yang dijeda akan diblokir agar tidak mengaktifkan peristiwa onReceive
.
Parameter
-
socketId
angka
-
dijeda
boolean
Tanda untuk menunjukkan apakah akan menjeda atau membatalkan jeda.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 121 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
update()
chrome.sockets.udp.update(
socketId: number,
properties: SocketProperties,
callback?: function,
)
Memperbarui properti soket.
Parameter
-
socketId
angka
ID soket.
-
properti
Properti yang akan diperbarui.
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:() => void
Hasil
-
Promise<void>
Chrome 121 dan yang lebih baruPromise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.
Peristiwa
onReceive
chrome.sockets.udp.onReceive.addListener(
callback: function,
)
Peristiwa muncul saat paket UDP telah diterima untuk soket yang diberikan.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(info: ReceiveInfo) => void
-
info
-
onReceiveError
chrome.sockets.udp.onReceiveError.addListener(
callback: function,
)
Peristiwa dipicu saat terjadi error jaringan saat runtime menunggu data pada alamat soket dan port. Setelah peristiwa ini dipicu, soket akan dijeda dan tidak ada lagi peristiwa onReceive
yang akan dimunculkan untuk soket ini hingga soket dilanjutkan.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(info: ReceiveErrorInfo) => void
-
info
-