chrome.sockets.udp

คำอธิบาย

ใช้ chrome.sockets.udp API เพื่อส่งและรับข้อมูลผ่านเครือข่ายโดยใช้การเชื่อมต่อ UDP API นี้มีผลแทนฟังก์ชัน UDP ที่พบใน "Socket" API

ไฟล์ Manifest

คุณต้องประกาศคีย์ต่อไปนี้ในไฟล์ Manifest เพื่อใช้ API นี้

"sockets"

ประเภท

CreateInfo

พร็อพเพอร์ตี้

  • socketId

    ตัวเลข

    รหัสของซ็อกเก็ตที่สร้างขึ้นใหม่ โปรดทราบว่ารหัสซ็อกเก็ตที่สร้างจาก API นี้ไม่สามารถใช้ร่วมกับรหัสซ็อกเก็ตที่สร้างจาก API อื่นๆ เช่น [Socket](../socket/) API ที่เลิกใช้งานแล้ว

DnsQueryType

Chrome 103 ขึ้นไป

ค่ากำหนดการแปลง DNS ค่าเริ่มต้นคือ any และใช้การกำหนดค่าระบบปฏิบัติการปัจจุบันซึ่งอาจแสดงผล IPv4 หรือ IPv6 ipv4 จะบังคับ IPv4 และ ipv6 จะบังคับ IPv6

ค่าแจกแจง

"ทั้งหมด"

"ipv4"

"ipv6"

ReceiveErrorInfo

พร็อพเพอร์ตี้

  • resultCode

    ตัวเลข

    รหัสผลลัพธ์ที่แสดงผลจากการเรียกใช้ relvfrom() ที่สำคัญ

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

ReceiveInfo

พร็อพเพอร์ตี้

  • ข้อมูล

    อาร์เรย์บัฟเฟอร์

    เนื้อหาแพ็กเก็ต UDP (ตัดเป็นขนาดบัฟเฟอร์ปัจจุบัน)

  • remoteAddress

    สตริง

    ที่อยู่ของโฮสต์ที่เป็นมาจากแพ็กเก็ต

  • remotePort

    ตัวเลข

    พอร์ตของโฮสต์ที่เป็นแพ็กเก็ตมา

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

SendInfo

พร็อพเพอร์ตี้

  • bytesSent

    หมายเลข ไม่บังคับ

    จำนวนไบต์ที่ส่ง (หากผลลัพธ์ == 0)

  • resultCode

    ตัวเลข

    รหัสผลลัพธ์ที่แสดงผลจากการเรียกใช้เครือข่ายที่เกี่ยวข้อง ค่าลบหมายถึงข้อผิดพลาด

SocketInfo

พร็อพเพอร์ตี้

  • bufferSize

    หมายเลข ไม่บังคับ

    ขนาดของบัฟเฟอร์ที่ใช้รับข้อมูล หากไม่ได้ระบุขนาดบัฟเฟอร์อย่างชัดเจน จะไม่มีการระบุค่า

  • localAddress

    string ไม่บังคับ

    หากมีการเชื่อมโยงซ็อกเก็ตที่สำคัญ จะมีที่อยู่ IPv4/6 ในเครื่อง

  • localPort

    หมายเลข ไม่บังคับ

    หากมีการเชื่อมโยงซ็อกเก็ตพื้นฐาน จะมีพอร์ตในเครื่อง

  • ชื่อ

    string ไม่บังคับ

    สตริงที่แอปพลิเคชันกำหนดซึ่งเชื่อมโยงกับซ็อกเก็ต

  • หยุดชั่วคราว

    boolean

    การแจ้งที่ระบุว่าซ็อกเก็ตถูกบล็อกไม่ให้เริ่มการทำงานของเหตุการณ์ onReceive หรือไม่

  • ต่อเนื่อง

    boolean

    การแจ้งที่ระบุว่าเปิดซ็อกเก็ตทิ้งไว้หรือไม่เมื่อแอปพลิเคชันถูกระงับ (ดูSocketProperties.persistent)

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

SocketProperties

พร็อพเพอร์ตี้

  • bufferSize

    หมายเลข ไม่บังคับ

    ขนาดของบัฟเฟอร์ที่ใช้รับข้อมูล หากบัฟเฟอร์มีขนาดเล็กเกินกว่าที่จะรับแพ็กเก็ต UDP ได้ ข้อมูลจะสูญหาย ค่าเริ่มต้นคือ 4096

  • ชื่อ

    string ไม่บังคับ

    สตริงที่แอปพลิเคชันกำหนดซึ่งเชื่อมโยงกับซ็อกเก็ต

  • ต่อเนื่อง

    บูลีน ไม่บังคับ

    การแจ้งที่ระบุว่าซ็อกเก็ตเปิดอยู่หรือไม่เมื่อหน้าเหตุการณ์ของแอปพลิเคชันยกเลิกการโหลด (โปรดดูจัดการวงจรของแอป) ค่าเริ่มต้นคือ "false" เมื่อโหลดแอปพลิเคชันแล้ว คุณจะดึง Socket ที่เคยเปิดด้วย Persist=true ได้ด้วย getSockets

เมธอด

bind()

chrome.sockets.udp.bind(
  socketId: number,
  address: string,
  port: number,
  callback: function,
)

เชื่อมโยงที่อยู่ในเครื่องและพอร์ตสำหรับซ็อกเก็ต สำหรับซ็อกเก็ตไคลเอ็นต์ ขอแนะนำให้ใช้พอร์ต 0 เพื่อให้แพลตฟอร์มเลือกพอร์ตที่ว่าง

เมื่อการดำเนินการ bind เสร็จสมบูรณ์ ระบบจะเพิ่มเหตุการณ์ onReceive รายการเมื่อแพ็กเก็ต UDP มาถึงที่อยู่/พอร์ตที่ระบุไว้ เว้นแต่ว่าซ็อกเก็ตจะหยุดชั่วคราว

พารามิเตอร์

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

  • ที่อยู่

    สตริง

    ที่อยู่เครื่องของคุณเอง รองรับชื่อ DNS, รูปแบบ IPv4 และ IPv6 ใช้ "0.0.0.0" เพื่อยอมรับแพ็กเก็ตจากอินเทอร์เฟซเครือข่ายภายในทั้งหมดที่ใช้ได้

  • พอร์ต

    ตัวเลข

    พอร์ตของเครื่องภายใน ใช้ "0" เพื่อเชื่อมโยงกับพอร์ตฟรี

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

      รหัสผลลัพธ์ที่แสดงผลจากการเรียกใช้เครือข่ายที่เกี่ยวข้อง ค่าลบหมายถึงข้อผิดพลาด

close()

สัญญา 
chrome.sockets.udp.close(
  socketId: number,
  callback?: function,
)

ปิดซ็อกเก็ตและปล่อยที่อยู่/พอร์ตที่เชื่อมกับซ็อกเก็ตอยู่ ซ็อกเก็ตแต่ละรายการที่สร้างขึ้นควรปิดหลังจากการใช้งาน รหัสซ็อกเก็ตจะใช้ไม่ได้อีกต่อไปในทันทีที่เรียกใช้ฟังก์ชัน อย่างไรก็ตาม ซ็อกเก็ตจะปิดเมื่อมีการเรียกใช้ Callback เท่านั้น

พารามิเตอร์

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • คำมั่นสัญญา<โมฆะ>

    Chrome 121 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

create()

สัญญา 
chrome.sockets.udp.create(
  properties?: SocketProperties,
  callback?: function,
)

สร้างซ็อกเก็ต UDP ด้วยคุณสมบัติที่กำหนด

พารามิเตอร์

  • พร็อพเพอร์ตี้

    SocketProperties ไม่บังคับ

    คุณสมบัติของซ็อกเก็ต (ไม่บังคับ)

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      ผลลัพธ์ของการสร้างซ็อกเก็ต

การคืนสินค้า

  • Promise&lt;CreateInfo&gt;

    Chrome 121 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

getInfo()

สัญญา 
chrome.sockets.udp.getInfo(
  socketId: number,
  callback?: function,
)

เรียกดูสถานะของซ็อกเก็ตที่ระบุ

พารามิเตอร์

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      ออบเจ็กต์ที่มีข้อมูลซ็อกเก็ต

การคืนสินค้า

  • Promise&lt;SocketInfo&gt;

    Chrome 121 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

getJoinedGroups()

สัญญา 
chrome.sockets.udp.getJoinedGroups(
  socketId: number,
  callback?: function,
)

รับที่อยู่กลุ่มมัลติแคสต์ที่ซ็อกเก็ตเข้าร่วมอยู่ในปัจจุบัน

พารามิเตอร์

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (groups: string[]) => void

    • กลุ่ม

      สตริง[]

      อาร์เรย์ของกลุ่มที่ซ็อกเก็ตเข้าร่วม

การคืนสินค้า

  • Promise&lt;string[]&gt;

    Chrome 121 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

getSockets()

สัญญา 
chrome.sockets.udp.getSockets(
  callback?: function,
)

เรียกข้อมูลรายการซ็อกเก็ตที่เปิดในปัจจุบันซึ่งเป็นของแอปพลิเคชัน

พารามิเตอร์

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      อาร์เรย์ของออบเจ็กต์ที่มีข้อมูลซ็อกเก็ต

การคืนสินค้า

  • Promise&lt;SocketInfo[]&gt;

    Chrome 121 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

joinGroup()

chrome.sockets.udp.joinGroup(
  socketId: number,
  address: string,
  callback: function,
)

เข้าร่วมกลุ่มมัลติแคสต์และเริ่มรับแพ็กเก็ตจากกลุ่มนั้น ต้องผูกซ็อกเก็ตกับพอร์ตในเครื่องก่อนเรียกใช้วิธีการนี้

พารามิเตอร์

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

  • ที่อยู่

    สตริง

    อีเมลของกลุ่มที่จะเข้าร่วม ไม่รองรับชื่อโดเมน

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

      รหัสผลลัพธ์ที่แสดงผลจากการเรียกใช้เครือข่ายที่เกี่ยวข้อง ค่าลบหมายถึงข้อผิดพลาด

leaveGroup()

chrome.sockets.udp.leaveGroup(
  socketId: number,
  address: string,
  callback: function,
)

ออกจากกลุ่มมัลติแคสต์ที่เข้าร่วมไว้ก่อนหน้านี้โดยใช้ joinGroup วิธีนี้จะจำเป็นต่อการเรียกใช้ในกรณีที่คุณวางแผนที่จะใช้ซ็อกเก็ตต่อไป เนื่องจากระบบปฏิบัติการจะดำเนินการโดยอัตโนมัติเมื่อปิดซ็อกเก็ต

การออกจากกลุ่มจะป้องกันไม่ให้เราเตอร์ส่ง Multicast Datagram ไปยังโฮสต์ในเครื่อง โดยสมมติว่าไม่มีกระบวนการอื่นๆ ในโฮสต์ที่ยังคงเข้าร่วมกลุ่ม

พารามิเตอร์

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

  • ที่อยู่

    สตริง

    อีเมลของกลุ่มที่จะออก ไม่รองรับชื่อโดเมน

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

      รหัสผลลัพธ์ที่แสดงผลจากการเรียกใช้เครือข่ายที่เกี่ยวข้อง ค่าลบหมายถึงข้อผิดพลาด

send()

chrome.sockets.udp.send(
  socketId: number,
  data: ArrayBuffer,
  address: string,
  port: number,
  dnsQueryType?: DnsQueryType,
  callback: function,
)

ส่งข้อมูลบนซ็อกเก็ตไปยังที่อยู่และพอร์ตที่ระบุ ต้องผูกซ็อกเก็ตกับพอร์ตในเครื่องก่อนเรียกใช้วิธีการนี้

พารามิเตอร์

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

  • ข้อมูล

    อาร์เรย์บัฟเฟอร์

    ข้อมูลที่จะส่ง

  • ที่อยู่

    สตริง

    ที่อยู่ของเครื่องระยะไกล

  • พอร์ต

    ตัวเลข

    พอร์ตของเครื่องระยะไกล

  • dnsQueryType

    DnsQueryType ไม่บังคับ

    Chrome 103 ขึ้นไป

    ค่ากำหนดการแก้ไขปัญหาที่อยู่

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (sendInfo: SendInfo) => void

    • sendInfo

      SendInfo

      ผลลัพธ์ของเมธอด send

setBroadcast()

Chrome 44 ขึ้นไป 
chrome.sockets.udp.setBroadcast(
  socketId: number,
  enabled: boolean,
  callback: function,
)

เปิดหรือปิดใช้การออกอากาศแพ็กเก็ตบนซ็อกเก็ตนี้

พารามิเตอร์

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

  • เปิดใช้อยู่

    boolean

    true เพื่อเปิดใช้แพ็กเก็ตการออกอากาศ falseเพื่อปิดใช้

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

      รหัสผลลัพธ์ที่แสดงผลจากการเรียกใช้เครือข่ายที่เกี่ยวข้อง

setMulticastLoopbackMode()

chrome.sockets.udp.setMulticastLoopbackMode(
  socketId: number,
  enabled: boolean,
  callback: function,
)

ตั้งค่าว่าจะให้แพ็กเก็ตมัลติแคสต์ที่ส่งจากโฮสต์ไปยังกลุ่มมัลติแคสต์กลับไปยังโฮสต์หรือไม่

หมายเหตุ: ลักษณะการทำงานของ setMulticastLoopbackMode จะแตกต่างกันเล็กน้อยระหว่างระบบ Windows และระบบที่คล้ายกับ Unix ความไม่สอดคล้องกันนี้จะเกิดขึ้นเฉพาะในกรณีที่มีแอปพลิเคชันมากกว่า 1 รายการในโฮสต์เดียวกันที่เข้าร่วมในกลุ่มมัลติแคสต์เดียวกันโดยมีการตั้งค่าที่แตกต่างกันในโหมด Loopback ของมัลติแคสต์ ใน Windows แอปพลิเคชันที่มีการปิด Loopback จะไม่รับแพ็กเก็ต Loopback ในขณะที่อยู่ในระบบที่คล้าย Unix แอปพลิเคชันที่มีการปิด Loopback จะไม่ส่งแพ็กเก็ต Loopback ไปยังแอปพลิเคชันอื่นในโฮสต์เดียวกัน ดู MSDN: http://goo.gl/6vqbj

การเรียกใช้วิธีนี้ไม่ต้องใช้สิทธิ์มัลติแคสต์

พารามิเตอร์

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

  • เปิดใช้อยู่

    boolean

    ระบุว่าจะเปิดใช้โหมด Loopback หรือไม่

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

      รหัสผลลัพธ์ที่แสดงผลจากการเรียกใช้เครือข่ายที่เกี่ยวข้อง ค่าลบหมายถึงข้อผิดพลาด

setMulticastTimeToLive()

chrome.sockets.udp.setMulticastTimeToLive(
  socketId: number,
  ttl: number,
  callback: function,
)

ตั้งค่า Time to Live ของแพ็กเก็ตมัลติแคสต์ที่ส่งไปยังกลุ่มมัลติแคสต์

การเรียกใช้วิธีนี้ไม่ต้องใช้สิทธิ์มัลติแคสต์

พารามิเตอร์

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

  • TTL

    ตัวเลข

    ค่า Time to Live

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

      รหัสผลลัพธ์ที่แสดงผลจากการเรียกใช้เครือข่ายที่เกี่ยวข้อง ค่าลบหมายถึงข้อผิดพลาด

setPaused()

สัญญา 
chrome.sockets.udp.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

หยุดชั่วคราวหรือยกเลิกการหยุดซ็อกเก็ตชั่วคราว ซ็อกเก็ตที่หยุดชั่วคราวถูกบล็อกไม่ให้เริ่มการทำงานของเหตุการณ์ onReceive

พารามิเตอร์

  • socketId

    ตัวเลข

  • หยุดชั่วคราว

    boolean

    แจ้งเพื่อระบุว่าจะหยุดชั่วคราวหรือยกเลิกการหยุดชั่วคราวหรือไม่

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • คำมั่นสัญญา<โมฆะ>

    Chrome 121 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

update()

สัญญา 
chrome.sockets.udp.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

อัปเดตคุณสมบัติของซ็อกเก็ต

พารามิเตอร์

  • socketId

    ตัวเลข

    รหัสซ็อกเก็ต

  • พร็อพเพอร์ตี้

    SocketProperties

    พร็อพเพอร์ตี้ที่จะอัปเดต

  • Callback

    ไม่บังคับ

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • คำมั่นสัญญา<โมฆะ>

    Chrome 121 ขึ้นไป

    Promise รองรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้ Callback

กิจกรรม

onReceive

chrome.sockets.udp.onReceive.addListener(
  callback: function,
)

เหตุการณ์เกิดขึ้นเมื่อได้รับแพ็กเก็ต UDP สำหรับซ็อกเก็ตที่ระบุ

พารามิเตอร์

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (info: ReceiveInfo) => void

onReceiveError

chrome.sockets.udp.onReceiveError.addListener(
  callback: function,
)

เหตุการณ์เกิดขึ้นเมื่อเกิดข้อผิดพลาดเกี่ยวกับเครือข่ายระหว่างที่รันไทม์รอข้อมูลเกี่ยวกับที่อยู่ซ็อกเก็ตและพอร์ต เมื่อเหตุการณ์เพิ่มขึ้น ซ็อกเก็ตจะหยุดชั่วคราวและจะไม่เพิ่มเหตุการณ์ onReceive สำหรับซ็อกเก็ตนี้อีกจนกว่าซ็อกเก็ตจะกลับมาทำงานอีกครั้ง

พารามิเตอร์

  • Callback

    ฟังก์ชัน

    พารามิเตอร์ callback มีลักษณะดังนี้ 

    (info: ReceiveErrorInfo) => void