chrome.sockets.udp

คำอธิบาย

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

ไฟล์ Manifest

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

"sockets"

ประเภท

CreateInfo

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

• socketId

  ตัวเลข

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

DnsQueryType

Chrome 103 ขึ้นไป

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

ค่าแจกแจง

"any"

"ipv4"

"ipv6"

ReceiveErrorInfo

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

• resultCode

  ตัวเลข

  รหัสผลลัพธ์ที่แสดงเมื่อเรียกใช้ recvfrom() ที่เกี่ยวข้อง

• socketId

  ตัวเลข

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

ReceiveInfo

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

• ข้อมูล

  ArrayBuffer

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

• remoteAddress

  สตริง

  ที่อยู่ของโฮสต์ที่ส่งแพ็กเก็ต

• remotePort

  ตัวเลข

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

• socketId

  ตัวเลข

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

SendInfo

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

• bytesSent

  ตัวเลข ไม่บังคับ

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

• resultCode

  ตัวเลข

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

SocketInfo

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

• bufferSize

  ตัวเลข ไม่บังคับ

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

• localAddress

  สตริง ไม่บังคับ

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

• localPort

  ตัวเลข ไม่บังคับ

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

• ชื่อ

  สตริง ไม่บังคับ

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

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

  บูลีน

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

• ถาวร

  บูลีน

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

• socketId

  ตัวเลข

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

SocketProperties

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

• bufferSize

  ตัวเลข ไม่บังคับ

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

• ชื่อ

  สตริง ไม่บังคับ

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

• ถาวร

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

  แฟล็กที่ระบุว่ามีการเปิดซ็อกเก็ตไว้หรือไม่เมื่อระบบยกเลิกการโหลดหน้าเหตุการณ์ของแอปพลิเคชัน (ดูจัดการวงจรของแอป) ค่าเริ่มต้นคือ "false" เมื่อโหลดแอปพลิเคชันแล้ว คุณสามารถดึงข้อมูลซ็อกเก็ตที่เปิดไว้ก่อนหน้านี้ด้วย persistent=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,
)

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

พารามิเตอร์

• socketId

  ตัวเลข

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

• Callback

  ฟังก์ชัน ไม่บังคับ

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

  () => void

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

• Promise<void>

  Chrome 121 ขึ้นไป

  ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

create()

สัญญา

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

สร้างซ็อกเก็ต UDP ด้วยพร็อพเพอร์ตี้ที่ระบุ

พารามิเตอร์

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

  SocketProperties ไม่บังคับ

  พร็อพเพอร์ตี้ซ็อกเก็ต (ไม่บังคับ)

• Callback

  ฟังก์ชัน ไม่บังคับ

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

  (createInfo: CreateInfo) => void

  • createInfo

    CreateInfo

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

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

• Promise<CreateInfo>

  Chrome 121 ขึ้นไป

  ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

getInfo()

สัญญา

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

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

พารามิเตอร์

• socketId

  ตัวเลข

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

• Callback

  ฟังก์ชัน ไม่บังคับ

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

  (socketInfo: SocketInfo) => void

  • socketInfo

    SocketInfo

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

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

• Promise<SocketInfo>

  Chrome 121 ขึ้นไป

  ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

getJoinedGroups()

สัญญา

chrome.sockets.udp.getJoinedGroups(
  socketId: number,
  callback?: function,
)

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

พารามิเตอร์

• socketId

  ตัวเลข

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

• Callback

  ฟังก์ชัน ไม่บังคับ

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

  (groups: string[]) => void

  • กลุ่ม

    string[]

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

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

• Promise<string[]>

  Chrome 121 ขึ้นไป

  ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

getSockets()

สัญญา

chrome.sockets.udp.getSockets(
  callback?: function,
)

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

พารามิเตอร์

• Callback

  ฟังก์ชัน ไม่บังคับ

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

  (socketInfos: SocketInfo[]) => void

  • socketInfos

    SocketInfo[]

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

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

• Promise<SocketInfo[]>

  Chrome 121 ขึ้นไป

  ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

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 คุณจำเป็นต้องเรียกใช้เฉพาะในกรณีที่วางแผนที่จะใช้ซ็อกเก็ตต่อหลังจากนั้น เนื่องจากระบบปฏิบัติการจะดำเนินการนี้โดยอัตโนมัติเมื่อซ็อกเก็ตปิด

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

พารามิเตอร์

• socketId

  ตัวเลข

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

• ที่อยู่

  สตริง

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

• Callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

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

send()

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

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

พารามิเตอร์

• socketId

  ตัวเลข

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

• ข้อมูล

  ArrayBuffer

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

• ที่อยู่

  สตริง

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

• พอร์ต

  ตัวเลข

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

• 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

  ตัวเลข

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

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

  บูลีน

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

• Callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

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

setMulticastLoopbackMode()

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

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

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

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

พารามิเตอร์

• socketId

  ตัวเลข

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

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

  บูลีน

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

• Callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

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

setMulticastTimeToLive()

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

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

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

พารามิเตอร์

• socketId

  ตัวเลข

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

• ttl

  ตัวเลข

  ค่า Time to Live

• Callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

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

setPaused()

สัญญา

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

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

พารามิเตอร์

• socketId

  ตัวเลข

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

  บูลีน

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

• Callback

  ฟังก์ชัน ไม่บังคับ

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

  () => void

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

• Promise<void>

  Chrome 121 ขึ้นไป

  ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

update()

สัญญา

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

อัปเดตพร็อพเพอร์ตี้ซ็อกเก็ต

พารามิเตอร์

• socketId

  ตัวเลข

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

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

  SocketProperties

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

• Callback

  ฟังก์ชัน ไม่บังคับ

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

  () => void

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

• Promise<void>

  Chrome 121 ขึ้นไป

  ระบบรองรับ Promises สำหรับไฟล์ Manifest V3 ขึ้นไปเท่านั้น ส่วนแพลตฟอร์มอื่นๆ ต้องใช้การเรียกกลับ

กิจกรรม

onReceive

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

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

พารามิเตอร์

• Callback

  ฟังก์ชัน

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

  (info: ReceiveInfo) => void

  • ข้อมูล

    ReceiveInfo

onReceiveError

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

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

พารามิเตอร์

• Callback

  ฟังก์ชัน

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

  (info: ReceiveErrorInfo) => void

  • ข้อมูล

    ReceiveErrorInfo