chrome.sockets.tcpServer

คำอธิบาย

ใช้ chrome.sockets.tcpServer API เพื่อสร้างแอปพลิเคชันเซิร์ฟเวอร์โดยใช้การเชื่อมต่อ TCP API นี้มีผลแทนฟังก์ชัน TCP ที่พบใน API ของ chrome.socket ก่อนหน้านี้

ไฟล์ Manifest

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

"sockets"

ประเภท

AcceptErrorInfo

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

  • resultCode

    ตัวเลข

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

  • socketId

    ตัวเลข

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

AcceptInfo

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

  • clientSocketId

    ตัวเลข

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

  • socketId

    ตัวเลข

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

CreateInfo

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

  • socketId

    ตัวเลข

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

SocketInfo

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

  • localAddress

    string ไม่บังคับ

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

  • localPort

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

    หากซ็อกเก็ตกำลังฟังอยู่ ก็ให้พอร์ตในเครื่อง

  • ชื่อ

    string ไม่บังคับ

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

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

    boolean

    การแจ้งที่ระบุว่าจะมีการส่งคำขอการเชื่อมต่อในซ็อกเก็ตสำหรับฟังผ่านเหตุการณ์ onAccept หรืออยู่ในคิวใน Backlog ของคิวการฟังหรือไม่ ดู setPaused ค่าเริ่มต้นคือ "false"

  • ต่อเนื่อง

    boolean

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

  • socketId

    ตัวเลข

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

SocketProperties

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

  • ชื่อ

    string ไม่บังคับ

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

  • ต่อเนื่อง

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

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

เมธอด

close()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • Callback

    ไม่บังคับ

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

    () => void

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

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

    Chrome 121 ขึ้นไป

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

create()

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

สร้างซ็อกเก็ตเซิร์ฟเวอร์ TCP

พารามิเตอร์

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

    SocketProperties ไม่บังคับ

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

  • Callback

    ไม่บังคับ

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

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

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

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

  • Promise&lt;CreateInfo&gt;

    Chrome 121 ขึ้นไป

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

disconnect()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • Callback

    ไม่บังคับ

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

    () => void

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

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

    Chrome 121 ขึ้นไป

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

getInfo()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • Callback

    ไม่บังคับ

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

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

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

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

  • Promise&lt;SocketInfo&gt;

    Chrome 121 ขึ้นไป

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

getSockets()

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

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

พารามิเตอร์

  • Callback

    ไม่บังคับ

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

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

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

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

  • Promise&lt;SocketInfo[]&gt;

    Chrome 121 ขึ้นไป

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

listen()

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

รับการเชื่อมต่อบนพอร์ตและที่อยู่ที่ระบุ หากพอร์ต/ที่อยู่มีการใช้งาน Callback จะแสดงว่าล้มเหลว

พารามิเตอร์

  • socketId

    ตัวเลข

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

  • ที่อยู่

    สตริง

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

  • พอร์ต

    ตัวเลข

    พอร์ตของเครื่องภายใน เมื่อตั้งค่าเป็น 0 ระบบจะเลือกพอร์ตฟรีแบบไดนามิก โดยจะเรียกใช้ getInfo เพื่อหาพอร์ตที่จัดสรรแบบไดนามิกได้

  • งานค้าง

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

    ความยาวของคิวการฟังของซ็อกเก็ต ค่าเริ่มต้นจะขึ้นอยู่กับระบบปฏิบัติการ (SOMAXCONN) ซึ่งทำให้แอปพลิเคชันส่วนใหญ่มีความยาวคิวเพียงพอ

  • Callback

    ฟังก์ชัน

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

    (result: number) => void

    • ผลลัพธ์

      ตัวเลข

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

setPaused()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

    boolean

  • Callback

    ไม่บังคับ

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

    () => void

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

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

    Chrome 121 ขึ้นไป

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

update()

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

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

พารามิเตอร์

  • socketId

    ตัวเลข

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

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

    SocketProperties

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

  • Callback

    ไม่บังคับ

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

    () => void

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

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

    Chrome 121 ขึ้นไป

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

กิจกรรม

onAccept

chrome.sockets.tcpServer.onAccept.addListener(
  callback: function,
)

เหตุการณ์เพิ่มขึ้นเมื่อมีการเชื่อมต่อกับซ็อกเก็ตเซิร์ฟเวอร์

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (info: AcceptInfo) => void

onAcceptError

chrome.sockets.tcpServer.onAcceptError.addListener(
  callback: function,
)

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

พารามิเตอร์

  • Callback

    ฟังก์ชัน

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

    (info: AcceptErrorInfo) => void