chrome.sockets.tcpServer

Описание

Используйте API chrome.sockets.tcpServer для создания серверных приложений с использованием TCP-соединений. Этот API заменяет функциональность TCP, ранее имевшуюся в API chrome.socket .

Манифест

Для использования этого API в манифесте необходимо объявить следующие ключи.

"sockets"

Типы

AcceptErrorInfo

Характеристики

  • код результата

    число

    Код результата, возвращенный базовым сетевым вызовом.

  • идентификатор сокета

    число

    Идентификатор сокета сервера.

AcceptInfo

Характеристики

  • clientSocketId

    число

    Идентификатор сокета клиента, т. е. идентификатор сокета вновь установленного соединения. Этот идентификатор сокета следует использовать только с функциями из пространства имен chrome.sockets.tcp . Обратите внимание, что клиентский сокет изначально приостановлен и должен быть явно возобновлен приложением, чтобы начать получать данные.

  • идентификатор сокета

    число

    Идентификатор сокета сервера.

CreateInfo

Характеристики

  • идентификатор сокета

    число

    Идентификатор вновь созданного сокета сервера. Обратите внимание, что идентификаторы сокетов, созданные с помощью этого API, несовместимы с идентификаторами сокетов, созданными с помощью других API, например устаревшего API [ ocket ](../socket/) .

SocketInfo

Характеристики

  • локальныйадрес

    строка необязательна

    Если сокет прослушивается, он содержит его локальный адрес IPv4/6.

  • локальный порт

    номер необязательно

    Если сокет прослушивает, содержит его локальный порт.

  • имя

    строка необязательна

    Определяемая приложением строка, связанная с сокетом.

  • остановился

    логическое значение

    Флаг, указывающий, отправляются ли запросы на подключение к прослушивающему сокету через событие onAccept или ставятся в очередь в очереди прослушивания. См. setPaused . Значение по умолчанию неверно".

  • настойчивый

    логическое значение

    Флаг, указывающий, остается ли сокет открытым при выгрузке страницы событий приложения (см. SocketProperties.persistent ). Значение по умолчанию неверно".

  • идентификатор сокета

    число

    Идентификатор сокета.

SocketProperties

Характеристики

  • имя

    строка необязательна

    Определяемая приложением строка, связанная с сокетом.

  • настойчивый

    логическое значение необязательно

    Флаг, указывающий, остается ли сокет открытым при выгрузке страницы событий приложения (см. «Управление жизненным циклом приложения »). Значение по умолчанию неверно." Когда приложение загружается, любые сокеты, ранее открытые с параметром persist=true, можно получить с помощью getSockets .

Методы

close()

Обещать
chrome.sockets.tcpServer.close(
  socketId: number,
  callback?: function,
)

Отключает и разрушает розетку. Каждый созданный сокет должен быть закрыт после использования. Идентификатор сокета больше не действителен при вызове функции. Однако сокет гарантированно закроется только при вызове обратного вызова.

Параметры

  • идентификатор сокета

    число

    Идентификатор сокета.

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    ()=>void

Возврат

  • Обещание<void>

    Хром 121+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

create()

Обещать
chrome.sockets.tcpServer.create(
  properties?: SocketProperties,
  callback?: function,
)

Создает сокет TCP-сервера.

Параметры

  • характеристики

    Свойства сокета необязательно.

    Свойства сокета (необязательно).

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    (createInfo: CreateInfo)=>void

Возврат

  • Обещание <CreateInfo>

    Хром 121+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

disconnect()

Обещать
chrome.sockets.tcpServer.disconnect(
  socketId: number,
  callback?: function,
)

Отключает прослушиваемый сокет, т.е. прекращает принимать новые соединения и освобождает адрес/порт, к которому привязан сокет. Идентификатор сокета остается действительным, например, его можно использовать с listen для приема соединений по новому порту и адресу.

Параметры

  • идентификатор сокета

    число

    Идентификатор сокета.

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    ()=>void

Возврат

  • Обещание<void>

    Хром 121+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

getInfo()

Обещать
chrome.sockets.tcpServer.getInfo(
  socketId: number,
  callback?: function,
)

Получает состояние данного сокета.

Параметры

  • идентификатор сокета

    число

    Идентификатор сокета.

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    (socketInfo: SocketInfo)=>void

Возврат

  • Обещание <SocketInfo>

    Хром 121+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

getSockets()

Обещать
chrome.sockets.tcpServer.getSockets(
  callback?: function,
)

Получает список открытых в данный момент сокетов, принадлежащих приложению.

Параметры

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    (socketInfos: SocketInfo[])=>void

Возврат

  • Обещание< SocketInfo []>

    Хром 121+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

listen()

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

Прослушивает соединения по указанному порту и адресу. Если порт/адрес используется, обратный вызов указывает на сбой.

Параметры

  • идентификатор сокета

    число

    Идентификатор сокета.

  • адрес

    нить

    Адрес локальной машины.

  • порт

    число

    Порт локальной машины. Если установлено значение 0 , свободный порт выбирается динамически. Динамически выделенный порт можно найти, вызвав getInfo .

  • отставание

    номер необязательно

    Длина очереди прослушивания сокета. Значение по умолчанию зависит от операционной системы (SOMAXCONN), которая обеспечивает разумную длину очереди для большинства приложений.

  • перезвонить

    функция

    Параметр callback выглядит так: 

    (result: number)=>void

    • результат

      число

      Код результата, возвращенный базовым сетевым вызовом. Отрицательное значение указывает на ошибку.

setPaused()

Обещать
chrome.sockets.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

Включает или отключает прослушивающий сокет от приема новых подключений. В режиме паузы прослушивающий сокет принимает новые соединения до тех пор, пока его очередь (см. функцию listen ) не заполнится, а затем отклоняет дополнительные запросы на соединение. События onAccept возникают только тогда, когда сокет не приостановлен.

Параметры

  • идентификатор сокета

    число

  • остановился

    логическое значение

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    ()=>void

Возврат

  • Обещание<void>

    Хром 121+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

update()

Обещать
chrome.sockets.tcpServer.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

Обновляет свойства сокета.

Параметры

  • идентификатор сокета

    число

    Идентификатор сокета.

  • характеристики

    Свойства сокета

    Свойства для обновления.

  • перезвонить

    функция необязательна

    Параметр callback выглядит так: 

    ()=>void

Возврат

  • Обещание<void>

    Хром 121+

    Промисы поддерживаются только для Manifest V3 и более поздних версий, на других платформах необходимо использовать обратные вызовы.

События

onAccept

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

Событие возникает, когда установлено соединение с сокетом сервера.

Параметры

  • перезвонить

    функция

    Параметр callback выглядит так: 

    (info: AcceptInfo)=>void

onAcceptError

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

Событие возникает, когда возникает сетевая ошибка, пока среда выполнения ожидает новых подключений к адресу сокета и порту. Как только это событие возникает, сокет устанавливается на paused , и события onAccept для этого сокета больше не возникают, пока сокет не будет возобновлен.

Параметры