chrome.socket

คำอธิบาย

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

สิทธิ์

socket

ประเภท

AcceptInfo

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

  • resultCode

    ตัวเลข

  • socketId

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

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

CreateInfo

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

  • socketId

    ตัวเลข

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

CreateOptions

NetworkInterface

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

  • ที่อยู่

    สตริง

    ที่อยู่ IPv4/6 ที่พร้อมใช้งาน

  • ชื่อ

    สตริง

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

  • prefixLength

    ตัวเลข

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

ReadInfo

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

  • ข้อมูล

    ArrayBuffer

  • resultCode

    ตัวเลข

    รหัสผลลัพธ์ที่แสดงผลจากการเรียกใช้ read() ที่อยู่เบื้องหลัง

RecvFromInfo

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

  • ที่อยู่

    สตริง

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

  • ข้อมูล

    ArrayBuffer

  • พอร์ต

    ตัวเลข

  • resultCode

    ตัวเลข

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

SecureOptions

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

SocketInfo

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

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

    บูลีน

    การเชื่อมต่อซ็อกเก็ตพื้นฐานหรือไม่

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

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

  • localAddress

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

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

  • localPort

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

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

  • peerAddress

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

    หากซ็อกเก็ตพื้นฐานเชื่อมต่ออยู่ จะมีที่อยู่ IPv4/6 ของคู่สนทนา

  • peerPort

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

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

  • 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,
)

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

  • Callback

    ฟังก์ชัน

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

    (acceptInfo: AcceptInfo) => void

bind()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

  • ที่อยู่

    สตริง

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

  • พอร์ต

    ตัวเลข

    พอร์ตของเครื่อง

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

connect()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    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 ขึ้นไป

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

destroy()

chrome.socket.destroy(
  socketId: number,
)

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

disconnect()

chrome.socket.disconnect(
  socketId: number,
)

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

getInfo()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

  • Callback

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

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

    (result: SocketInfo) => void

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

  • Promise<SocketInfo>

    Chrome 121 ขึ้นไป

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

getJoinedGroups()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

  • Callback

    ฟังก์ชัน

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

    (groups: string[]) => void

    • กลุ่ม

      string[]

getNetworkList()

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

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

พารามิเตอร์

  • Callback

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

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

    (result: NetworkInterface[]) => void

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

  • Promise<NetworkInterface[]>

    Chrome 121 ขึ้นไป

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

joinGroup()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

  • ที่อยู่

    สตริง

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

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

leaveGroup()

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

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

  • ที่อยู่

    สตริง

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

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

listen()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

  • ที่อยู่

    สตริง

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

  • พอร์ต

    ตัวเลข

    พอร์ตของเครื่อง

  • งานค้าง

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

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

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

read()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

  • bufferSize

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

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

  • Callback

    ฟังก์ชัน

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

    (readInfo: ReadInfo) => void

recvFrom()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    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

    ตัวเลข

    socketId

  • ข้อมูล

    ArrayBuffer

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

  • ที่อยู่

    สตริง

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

  • พอร์ต

    ตัวเลข

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

  • Callback

    ฟังก์ชัน

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

    (writeInfo: WriteInfo) => void

setKeepAlive()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

  • เปิดใช้

    บูลีน

    หากเป็น "จริง" ให้เปิดใช้ฟังก์ชันการคงการเชื่อมต่อไว้

  • ล่าช้า

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

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

  • Callback

    ฟังก์ชัน

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

    (result: boolean) => void

    • ผลลัพธ์

      บูลีน

setMulticastLoopbackMode()

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

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

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

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

    บูลีน

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

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

setMulticastTimeToLive()

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

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    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

    ตัวเลข

    socketId

  • noDelay

    บูลีน

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

  • Callback

    ฟังก์ชัน

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

    (result: boolean) => void

    • ผลลัพธ์

      บูลีน

write()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

    socketId

  • ข้อมูล

    ArrayBuffer

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

  • Callback

    ฟังก์ชัน

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

    (writeInfo: WriteInfo) => void