chrome.socket

คำอธิบาย

ใช้ chrome.socket API เพื่อส่งและรับข้อมูลผ่านเครือข่ายโดยใช้การเชื่อมต่อ TCP และ UDP หมายเหตุ: ตั้งแต่ Chrome 33 เป็นต้นไป API นี้จะเลิกใช้งานเพื่อสนับสนุน API sockets.udp, sockets.tcp และ sockets.tcpServer

สิทธิ์

socket

ประเภท

AcceptInfo

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

• resultCode

  ตัวเลข

• socketId

  number ไม่บังคับ

  รหัสของซ็อกเก็ตที่ยอมรับ

CreateInfo

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

• socketId

  ตัวเลข

  รหัสของซ็อกเก็ตที่สร้างขึ้นใหม่

CreateOptions

NetworkInterface

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

• ที่อยู่

  สตริง

  ที่อยู่ IPv4/6 ที่ใช้ได้

• name

  สตริง

  ชื่อพื้นฐานของอะแดปเตอร์ ใน *nix โดยทั่วไปจะเป็น "eth0", "lo" เป็นต้น

• prefixLength

  ตัวเลข

  ความยาวคำนำหน้า

ReadInfo

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

• เพิ่มเติม

  ArrayBuffer

• resultCode

  ตัวเลข

  resultCode ที่แสดงผลจากการเรียกใช้ read() ที่เกี่ยวข้อง

RecvFromInfo

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

• ที่อยู่

  สตริง

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

• เพิ่มเติม

  ArrayBuffer

• พอร์ต

  ตัวเลข

• resultCode

  ตัวเลข

  resultCode ที่แสดงผลจากการเรียกใช้ recvfrom() ที่สำคัญ

SecureOptions

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

• tlsVersion

  TLSVersionConstraints ไม่บังคับ

SocketInfo

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

• เชื่อมต่อแล้ว

  บูลีน

  ซ็อกเก็ตที่เกี่ยวข้องเชื่อมต่ออยู่หรือไม่

  สำหรับซ็อกเก็ต tcp ค่านี้จะยังคงเป็นจริงแม้ว่าเพียร์ระยะไกลจะยกเลิกการเชื่อมต่อแล้วก็ตาม การอ่านหรือเขียนไปยังซ็อกเก็ตอาจส่งผลให้เกิดข้อผิดพลาด ซึ่งบ่งชี้ว่าควรยกเลิกการเชื่อมต่อซ็อกเก็ตนี้ผ่าน disconnect()

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

• localAddress

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

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

• localPort

  number ไม่บังคับ

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

• peerAddress

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

  หากซ็อกเก็ตที่เกี่ยวข้องเชื่อมต่ออยู่ จะมีที่อยู่ IPv4/6 ของเพียร์

• peerPort

  number ไม่บังคับ

  หากซ็อกเก็ตที่สำคัญเชื่อมต่ออยู่ จะมีพอร์ตของเพียร์ที่เชื่อมต่ออยู่

• socketType

  SocketType

  ประเภทของซ็อกเก็ตที่ส่งมา ซึ่งจะเป็น tcp หรือ udp

SocketType

ค่าแจกแจง

"tcp"

"udp"

TLSVersionConstraints

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

• สูงสุด

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

• นาที

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

  เวอร์ชัน TLS ขั้นต่ำและสูงสุดที่ยอมรับได้ ค่าที่รองรับคือ tls1.2 หรือ tls1.3

  ระบบไม่รองรับค่า tls1 และ tls1.1 อีกต่อไป หากตั้งค่า min เป็นค่าใดค่าหนึ่งเหล่านี้ ระบบจะจำกัดค่าเป็น tls1.2 โดยไม่มีการแจ้งเตือน หากตั้งค่า max เป็นค่าใดค่าหนึ่งดังกล่าว หรือค่าอื่นๆ ที่ไม่รู้จัก ระบบจะไม่สนใจค่าดังกล่าวโดยไม่มีการแจ้งเตือน

WriteInfo

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

• bytesWritten

  ตัวเลข

  จำนวนไบต์ที่ส่งหรือรหัสข้อผิดพลาดเชิงลบ

เมธอด

accept()

chrome.socket.accept(
  socketId: number,
  callback: function,
): void

วิธีนี้ใช้ได้กับซ็อกเก็ต TCP เท่านั้น ลงทะเบียนฟังก์ชัน Callback ที่จะเรียกใช้เมื่อยอมรับการเชื่อมต่อในซ็อกเก็ตเซิร์ฟเวอร์ที่รับฟังนี้ ต้องเรียกใช้ Listen ก่อน หากมี Callback การยอมรับที่ใช้งานอยู่แล้ว ระบบจะเรียกใช้ Callback นี้ทันทีโดยมีข้อผิดพลาดเป็น resultCode

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• callback

  ฟังก์ชัน

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

  (acceptInfo: AcceptInfo) => void

  • acceptInfo

    AcceptInfo

bind()

chrome.socket.bind(
  socketId: number,
  address: string,
  port: number,
  callback: function,
): void

เชื่อมโยงที่อยู่ภายในเครื่องสำหรับซ็อกเก็ต ปัจจุบันระบบยังไม่รองรับซ็อกเก็ต TCP

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• ที่อยู่

  สตริง

  ที่อยู่ของเครื่องในพื้นที่

• พอร์ต

  ตัวเลข

  พอร์ตของเครื่องในพื้นที่

• callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

connect()

chrome.socket.connect(
  socketId: number,
  hostname: string,
  port: number,
  callback: function,
): void

เชื่อมต่อซ็อกเก็ตกับเครื่องระยะไกล (สำหรับซ็อกเก็ต tcp) สำหรับซ็อกเก็ต udp การดำเนินการนี้จะตั้งค่าที่อยู่เริ่มต้นซึ่งระบบจะส่งแพ็กเก็ตไปและอ่านจากที่อยู่ดังกล่าวสำหรับการเรียก read() และ write()

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• hostname

  สตริง

  ชื่อโฮสต์หรือที่อยู่ IP ของเครื่องระยะไกล

• พอร์ต

  ตัวเลข

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

• callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

create()

Promise

chrome.socket.create(
  type: SocketType,
  options?: CreateOptions,
  callback?: function,
): Promise<CreateInfo>

สร้างซ็อกเก็ตประเภทที่ระบุซึ่งจะเชื่อมต่อกับเครื่องระยะไกลที่ระบุ

พารามิเตอร์

• ประเภท

  SocketType

  ประเภทของซ็อกเก็ตที่จะสร้าง ต้องเป็น tcp หรือ udp

• ตัวเลือก

  CreateOptions ไม่บังคับ

  ตัวเลือกซ็อกเก็ต

• callback

  function ไม่บังคับ

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

  (createInfo: CreateInfo) => void

  • createInfo

    CreateInfo

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

• Promise<CreateInfo>

  Chrome 121 ขึ้นไป

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

destroy()

chrome.socket.destroy(
  socketId: number,
): void

ทำลายซ็อกเก็ต ควรทำลายซ็อกเก็ตแต่ละรายการที่สร้างขึ้นหลังการใช้งาน

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

disconnect()

chrome.socket.disconnect(
  socketId: number,
): void

ยกเลิกการเชื่อมต่อซ็อกเก็ต สำหรับซ็อกเก็ต UDP disconnect จะไม่ทำงาน แต่เรียกใช้ได้อย่างปลอดภัย

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

getInfo()

Promise

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

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

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• callback

  function ไม่บังคับ

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

  (result: SocketInfo) => void

  • ผลลัพธ์

    SocketInfo

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

• Promise<SocketInfo>

  Chrome 121 ขึ้นไป

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

getJoinedGroups()

chrome.socket.getJoinedGroups(
  socketId: number,
  callback: function,
): void

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

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• callback

  ฟังก์ชัน

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

  (groups: string[]) => void

  • กลุ่ม

    string[]

getNetworkList()

Promise

chrome.socket.getNetworkList(
  callback?: function,
): Promise<NetworkInterface[]>

เรียกดูข้อมูลเกี่ยวกับอะแดปเตอร์ในเครื่องในระบบนี้

พารามิเตอร์

• callback

  function ไม่บังคับ

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

  (result: NetworkInterface[]) => void

  • ผลลัพธ์

    NetworkInterface[]

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

• Promise<NetworkInterface[]>

  Chrome 121 ขึ้นไป

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

joinGroup()

chrome.socket.joinGroup(
  socketId: number,
  address: string,
  callback: function,
): void

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

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• ที่อยู่

  สตริง

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

• callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

leaveGroup()

chrome.socket.leaveGroup(
  socketId: number,
  address: string,
  callback: function,
): void

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

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

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• ที่อยู่

  สตริง

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

• callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

listen()

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

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

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• ที่อยู่

  สตริง

  ที่อยู่ของเครื่องในพื้นที่

• พอร์ต

  ตัวเลข

  พอร์ตของเครื่องในพื้นที่

• งานค้าง

  number ไม่บังคับ

  ความยาวของคิวการฟังของซ็อกเก็ต

• callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

read()

chrome.socket.read(
  socketId: number,
  bufferSize?: number,
  callback: function,
): void

อ่านข้อมูลจากซ็อกเก็ตที่เชื่อมต่อที่ระบุ

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• bufferSize

  number ไม่บังคับ

  ขนาดบัฟเฟอร์การอ่าน

• callback

  ฟังก์ชัน

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

  (readInfo: ReadInfo) => void

  • readInfo

    ReadInfo

recvFrom()

chrome.socket.recvFrom(
  socketId: number,
  bufferSize?: number,
  callback: function,
): void

รับข้อมูลจากซ็อกเก็ต UDP ที่ระบุ

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• bufferSize

  number ไม่บังคับ

  ขนาดบัฟเฟอร์ที่ได้รับ

• callback

  ฟังก์ชัน

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

  (recvFromInfo: RecvFromInfo) => void

  • recvFromInfo

    RecvFromInfo

secure()

chrome.socket.secure(
  socketId: number,
  options?: SecureOptions,
  callback: function,
): void

เริ่มการเชื่อมต่อไคลเอ็นต์ TLS ผ่านซ็อกเก็ตไคลเอ็นต์ TCP ที่เชื่อมต่ออยู่

พารามิเตอร์

• socketId

  ตัวเลข

  ซ็อกเก็ตที่เชื่อมต่อที่จะใช้

• ตัวเลือก

  SecureOptions ไม่บังคับ

  ข้อจำกัดและพารามิเตอร์สำหรับการเชื่อมต่อ TLS

• callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

sendTo()

chrome.socket.sendTo(
  socketId: number,
  data: ArrayBuffer,
  address: string,
  port: number,
  callback: function,
): void

ส่งข้อมูลบนซ็อกเก็ต UDP ที่ระบุไปยังที่อยู่และพอร์ตที่ระบุ

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• เพิ่มเติม

  ArrayBuffer

  ข้อมูลที่จะเขียน

• ที่อยู่

  สตริง

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

• พอร์ต

  ตัวเลข

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

• callback

  ฟังก์ชัน

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

  (writeInfo: WriteInfo) => void

  • writeInfo

    WriteInfo

setKeepAlive()

chrome.socket.setKeepAlive(
  socketId: number,
  enable: boolean,
  delay?: number,
  callback: function,
): void

เปิดหรือปิดใช้ฟังก์ชัน Keep-Alive สำหรับการเชื่อมต่อ TCP

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• เปิดใช้

  บูลีน

  หากเป็นจริง ให้เปิดใช้ฟังก์ชันการทำงานของ Keep-Alive

• ล่าช้า

  number ไม่บังคับ

  ตั้งค่าจำนวนวินาทีที่ล่าช้าระหว่างกลุ่มข้อมูลล่าสุดที่ได้รับกับการตรวจสอบ Keepalive ครั้งแรก ค่าเริ่มต้นคือ 0

• callback

  ฟังก์ชัน

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

  (result: boolean) => void

  • ผลลัพธ์

    บูลีน

setMulticastLoopbackMode()

chrome.socket.setMulticastLoopbackMode(
  socketId: number,
  enabled: boolean,
  callback: function,
): void

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

หมายเหตุ: ลักษณะการทำงานของ setMulticastLoopbackMode จะแตกต่างกันเล็กน้อยระหว่างระบบ Windows และระบบที่คล้าย Unix ความไม่สอดคล้องกันจะเกิดขึ้นก็ต่อเมื่อมีแอปพลิเคชันมากกว่า 1 รายการในโฮสต์เดียวกันที่เข้าร่วมกลุ่มมัลติแคสต์เดียวกัน แต่มีการตั้งค่าที่แตกต่างกันในโหมด Loopback ของมัลติแคสต์ ใน Windows แอปพลิเคชันที่ปิด Loopback จะไม่ได้รับแพ็กเก็ต Loopback ส่วนในระบบที่คล้าย Unix แอปพลิเคชันที่ปิด Loopback จะไม่ส่งแพ็กเก็ต Loopback ไปยังแอปพลิเคชันอื่นๆ ในโฮสต์เดียวกัน ดู MSDN: https://learn.microsoft.com/en-us/windows/win32/winsock/ip-multicast-2

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

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• เปิดอยู่

  บูลีน

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

• callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

setMulticastTimeToLive()

chrome.socket.setMulticastTimeToLive(
  socketId: number,
  ttl: number,
  callback: function,
): void

ตั้งค่าอายุการใช้งานของแพ็กเก็ตมัลติแคสต์ที่ส่งไปยังกลุ่มมัลติแคสต์

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

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• ttl

  ตัวเลข

  ค่า Time-to-Live

• callback

  ฟังก์ชัน

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

  (result: number) => void

  • ผลลัพธ์

    ตัวเลข

setNoDelay()

chrome.socket.setNoDelay(
  socketId: number,
  noDelay: boolean,
  callback: function,
): void

ตั้งค่าหรือล้าง TCP_NODELAY สำหรับการเชื่อมต่อ TCP ระบบจะปิดใช้อัลกอริทึมของ Nagle เมื่อตั้งค่า TCP_NODELAY

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• noDelay

  บูลีน

  หากเป็นจริง ระบบจะปิดใช้อัลกอริทึมของ Nagle

• callback

  ฟังก์ชัน

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

  (result: boolean) => void

  • ผลลัพธ์

    บูลีน

write()

chrome.socket.write(
  socketId: number,
  data: ArrayBuffer,
  callback: function,
): void

เขียนข้อมูลในซ็อกเก็ตที่เชื่อมต่อที่ระบุ

พารามิเตอร์

• socketId

  ตัวเลข

  socketId

• เพิ่มเติม

  ArrayBuffer

  ข้อมูลที่จะเขียน

• callback

  ฟังก์ชัน

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

  (writeInfo: WriteInfo) => void

  • writeInfo

    WriteInfo