chrome.socket

คำอธิบาย

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

สิทธิ์

socket

ประเภท

AcceptInfo

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

  • resultCode

    ตัวเลข

  • socketId

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

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

CreateInfo

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

  • socketId

    ตัวเลข

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

CreateOptions

NetworkInterface

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

  • ที่อยู่

    สตริง

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

  • ชื่อ

    สตริง

    ชื่อพื้นฐานของอะแดปเตอร์ ใน *nix ค่านี้มักจะเป็น "eth0", "lo" ฯลฯ

  • prefixLength

    ตัวเลข

    ความยาวของคำนำหน้า

ReadInfo

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

  • ข้อมูล

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

  • resultCode

    ตัวเลข

    resultsCode ส่งคืนจากการเรียกใช้ Read() ที่สำคัญ

RecvFromInfo

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

  • ที่อยู่

    สตริง

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

  • ข้อมูล

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

  • พอร์ต

    ตัวเลข

  • resultCode

    ตัวเลข

    resultsCode ส่งคืนจากการเรียกใช้ Revfrom() พื้นฐาน

SecureOptions

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

SocketInfo

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

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

    boolean

    ระบุว่าเต้ารับพื้นฐานเชื่อมต่ออยู่หรือไม่

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

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

  • localAddress

    string ไม่บังคับ

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

  • localPort

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

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

  • peerAddress

    string ไม่บังคับ

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

  • peerPort

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

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

  • socketType

    SocketType

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

SocketType

ค่าแจกแจง

"tcp"

"udp"

TLSVersionConstraints

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

  • สูงสุด

    string ไม่บังคับ

  • นาที

    string ไม่บังคับ

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

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

WriteInfo

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

  • bytesWritten

    ตัวเลข

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

เมธอด

accept()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • Callback

    ฟังก์ชัน

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

    (acceptInfo: AcceptInfo) => void

bind()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • ที่อยู่

    สตริง

    ที่อยู่เครื่องของคุณเอง

  • พอร์ต

    ตัวเลข

    พอร์ตของเครื่องภายใน

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

connect()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • hostname

    สตริง

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

  • พอร์ต

    ตัวเลข

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

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

create()

สัญญา 
chrome.socket.create(
  type: SocketType,
  options?: CreateOptions,
  callback?: function,
)

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

พารามิเตอร์

  • ประเภท

    SocketType

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

  • ตัวเลือก

    CreateOptions ไม่บังคับ

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

  • Callback

    ไม่บังคับ

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

    (createInfo: CreateInfo) => void

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

  • Promise<CreateInfo>

    Chrome 121 ขึ้นไป

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

destroy()

chrome.socket.destroy(
  socketId: number,
)

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

disconnect()

chrome.socket.disconnect(
  socketId: number,
)

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

getInfo()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • Callback

    ไม่บังคับ

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

    (result: SocketInfo) => void

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

  • Promise<SocketInfo>

    Chrome 121 ขึ้นไป

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

getJoinedGroups()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • Callback

    ฟังก์ชัน

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

    (groups: string[]) => void

    • กลุ่ม

      สตริง[]

getNetworkList()

สัญญา 
chrome.socket.getNetworkList(
  callback?: function,
)

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

พารามิเตอร์

  • Callback

    ไม่บังคับ

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

    (result: NetworkInterface[]) => void

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

  • Promise<NetworkInterface[]>

    Chrome 121 ขึ้นไป

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

joinGroup()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • ที่อยู่

    สตริง

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

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

leaveGroup()

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

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • ที่อยู่

    สตริง

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

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

listen()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • ที่อยู่

    สตริง

    ที่อยู่เครื่องของคุณเอง

  • พอร์ต

    ตัวเลข

    พอร์ตของเครื่องภายใน

  • งานค้าง

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

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

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

read()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • bufferSize

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

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

  • Callback

    ฟังก์ชัน

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

    (readInfo: ReadInfo) => void

recvFrom()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • bufferSize

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

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

  • Callback

    ฟังก์ชัน

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

    (recvFromInfo: RecvFromInfo) => void

secure()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    เต้ารับที่เชื่อมต่อที่จะใช้

  • ตัวเลือก

    SecureOptions ไม่บังคับ

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

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

sendTo()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • ข้อมูล

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

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

  • ที่อยู่

    สตริง

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

  • พอร์ต

    ตัวเลข

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

  • Callback

    ฟังก์ชัน

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

    (writeInfo: WriteInfo) => void

setKeepAlive()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • เปิดใช้

    boolean

    หากเป็น "จริง" ให้เปิดใช้ฟังก์ชัน Keep-alive

  • ล่าช้า

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

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

  • Callback

    ฟังก์ชัน

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

    (result: boolean) => void

    • ผลลัพธ์

      boolean

setMulticastLoopbackMode()

chrome.socket.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.socket.setMulticastTimeToLive(
  socketId: number,
  ttl: number,
  callback: function,
)

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • TTL

    ตัวเลข

    ค่า Time to Live

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

setNoDelay()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • noDelay

    boolean

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

  • Callback

    ฟังก์ชัน

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

    (result: boolean) => void

    • ผลลัพธ์

      boolean

write()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • ข้อมูล

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

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

  • Callback

    ฟังก์ชัน

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

    (writeInfo: WriteInfo) => void