chrome.sockets.tcpServer

תיאור

צריך להשתמש ב-API chrome.sockets.tcpServer כדי ליצור אפליקציות שרת באמצעות חיבורי TCP. ה-API הזה מחליף את פונקציונליות ה-TCP שנמצאת בעבר ב-API chrome.socket.

מניפסט

כדי להשתמש ב-API הזה, צריך להצהיר על המפתחות הבאים במניפסט.

"sockets"

סוגים

AcceptErrorInfo

מאפיינים

  • resultCode

    number

    קוד התוצאה שהוחזר מקריאת הרשת הבסיסית.

  • socketId

    number

    המזהה של שקע השרת.

AcceptInfo

מאפיינים

  • clientSocketId

    number

    מזהה שקע הלקוח, כלומר מזהה השקע של החיבור החדש שנוצר. צריך להשתמש במזהה השקע הזה רק עם פונקציות ממרחב השמות chrome.sockets.tcp. לתשומת ליבכם: שקע הלקוח מושהה בהתחלה, ויש לבטל את ההשהיה שלו באופן מפורש על ידי האפליקציה כדי להתחיל לקבל נתונים.

  • socketId

    number

    המזהה של שקע השרת.

CreateInfo

מאפיינים

  • socketId

    number

    המזהה של שקע השרת החדש שנוצר. חשוב לדעת שמזהי שקעים שנוצרו מה-API הזה לא תואמים למזהי שקעים שנוצרו מממשקי API אחרים, כמו ה-API של [socket](../socket/) שהוצא משימוש.

SocketInfo

מאפיינים

  • localAddress

    מחרוזת אופציונלי

    אם השקע מאזין, מכיל את כתובת IPv4/6 המקומית שלו.

  • localPort

    מספר אופציונלי

    אם השקע מאזין, מכיל את היציאה המקומית שלו.

  • שם

    מחרוזת אופציונלי

    מחרוזת מוגדרת אפליקציה שמשויכת לשקע.

  • מושהה

    בוליאני

    סימון שמציין אם בקשות חיבור בשקע האזנה נשלחות דרך האירוע onAccept או מופיעות בתור בעיכוב בתור ההאזנה. setPaused. ערך ברירת המחדל הוא 'FALSE'.

  • מתמיד

    בוליאני

    סימון שמציין אם השקע נשאר פתוח אחרי שהטעינה של דף האירוע של האפליקציה מתבטלת (מידע נוסף זמין ב-SocketProperties.persistent). ערך ברירת המחדל הוא 'FALSE'.

  • socketId

    number

    מזהה ה-socket.

SocketProperties

מאפיינים

  • שם

    מחרוזת אופציונלי

    מחרוזת בהגדרת האפליקציה שמשויכת לשקע.

  • מתמיד

    ערך בוליאני אופציונלי

    סימון שמציין אם השקע נשאר פתוח אחרי שמסתיימת הטעינה של דף האירוע של האפליקציה (מידע נוסף זמין בקטע ניהול מחזור החיים של אפליקציה). ערך ברירת המחדל הוא 'FALSE'. כשהאפליקציה נטענת, ניתן לאחזר כל sockets שנפתחו בעבר באמצעות persistent=true באמצעות getSockets.

שיטות

close()

הבטחה 
chrome.sockets.tcpServer.close(
  socketId: number,
  callback?: function,
)

מנתק את השקע והשמדת אותו. כל שקע שנוצר צריך להיסגר אחרי השימוש. מזהה ה-socket לא תקף יותר מיד לאחר הפעלת הפונקציה. עם זאת, מובטח שהשקע ייסגר רק כשתתבצע קריאה חוזרת.

פרמטרים

  • socketId

    number

    מזהה ה-socket.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • הבטחה<Empty>

    Chrome 121 ואילך

    הבטחות נתמכות רק במניפסט מגרסה 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 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

disconnect()

הבטחה 
chrome.sockets.tcpServer.disconnect(
  socketId: number,
  callback?: function,
)

הפעולה הזו מנתקת את שקע ההאזנה, כלומר מפסיקה לקבל חיבורים חדשים ומשחררת את הכתובת או היציאה שאליה מחובר השקע. מזהה ה-socket נשאר תקין, למשל: אפשר להשתמש בו עם listen כדי לקבל חיבורים ביציאה ובכתובת חדשות.

פרמטרים

  • socketId

    number

    מזהה ה-socket.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • הבטחה<Empty>

    Chrome 121 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getInfo()

הבטחה 
chrome.sockets.tcpServer.getInfo(
  socketId: number,
  callback?: function,
)

אחזור המצב של השקע הנתון.

פרמטרים

  • socketId

    number

    מזהה ה-socket.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      אובייקט שמכיל את המידע על השקע.

החזרות

  • Promise&lt;SocketInfo&gt;

    Chrome 121 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getSockets()

הבטחה 
chrome.sockets.tcpServer.getSockets(
  callback?: function,
)

אחזור רשימה של השקעים הפתוחים הנוכחיים שבבעלות האפליקציה.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      מערך אובייקטים שמכיל מידע על השקע.

החזרות

  • Promise&lt;SocketInfo[]&gt;

    Chrome 121 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

listen()

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

המערכת מאזינה לחיבורים ביציאה ובכתובת שצוינו. אם היציאה/הכתובת נמצאת בשימוש, הקריאה החוזרת מציינת כשל.

פרמטרים

  • socketId

    number

    מזהה ה-socket.

  • כתובת

    מחרוזת

    הכתובת של המכונה המקומית.

  • יציאה

    number

    היציאה של המכונה המקומית. אם המדיניות מוגדרת לערך 0, היציאה החופשית נבחרת באופן דינמי. אפשר למצוא את השקע שהוקצה באופן דינמי באמצעות קריאה ל-getInfo.

  • עיכוב

    מספר אופציונלי

    אורך תור ההאזנה של השקע. ערך ברירת המחדל תלוי במערכת ההפעלה (SOMAXCONN), שמאפשרת להבטיח אורך תור סביר לרוב האפליקציות.

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (result: number) => void

    • תוצאה

      number

      קוד התוצאה שהוחזר מקריאת הרשת הבסיסית. ערך שלילי מציין שגיאה.

setPaused()

הבטחה 
chrome.sockets.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

המתג מפעיל או משבית את האפשרות של חיבורים חדשים לשקע האזנה. כשהתכונה מושהית, שקע האזנה מקבל חיבורים חדשים עד שהעיכוב יתמלא (ניתן לעיין בפונקציה listen) ואז ידחה בקשות חיבור נוספות. אירועי onAccept מוגברים רק כשמבטלים את השהיה של השקע.

פרמטרים

  • socketId

    number

  • מושהה

    בוליאני

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • הבטחה<Empty>

    Chrome 121 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

update()

הבטחה 
chrome.sockets.tcpServer.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

עדכון המאפיינים של ה-socket.

פרמטרים

  • socketId

    number

    מזהה ה-socket.

  • נכסים

    SocketProperties

    המאפיינים שצריך לעדכן.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • הבטחה<Empty>

    Chrome 121 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

אירועים

onAccept

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

אירוע שנוצר כאשר בוצע חיבור לשקע השרת.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (info: AcceptInfo) => void

onAcceptError

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

האירוע התרחש כשאירעה שגיאת רשת בזמן שזמן הריצה חיכה לחיבורים חדשים בכתובת השקע וביציאה. אחרי שהאירוע הזה יוגדל, ה-socket יוגדר לערך paused ולא יתווספו עוד אירועים מסוג onAccept ל-socket הזה עד לחידוש ה-socket.

פרמטרים