chrome.sockets.tcpServer

Açıklama

TCP bağlantılarını kullanarak sunucu uygulamaları oluşturmak için chrome.sockets.tcpServer API'yi kullanın. Bu API, daha önce chrome.socket API'sinde bulunan TCP işlevinin yerini alır.

Manifest

Bu API'yi kullanmak için aşağıdaki anahtarlar manifest dosyasında beyan edilmelidir.

"sockets"

Türler

AcceptErrorInfo

Özellikler

  • resultCode

    sayı

    Temel ağ çağrısından döndürülen sonuç kodu.

  • socketId

    sayı

    Sunucu yuvası tanımlayıcısı.

AcceptInfo

Özellikler

  • clientSocketId

    sayı

    İstemci yuvası tanımlayıcısı, yani yeni kurulan bağlantının yuva tanımlayıcısı. Bu soket tanımlayıcısı yalnızca chrome.sockets.tcp ad alanındaki işlevlerle kullanılmalıdır. İstemci soketinin başlangıçta duraklatıldığını ve veri almaya başlamak için uygulama tarafından açıkça duraklatmanın kaldırılması gerektiğini unutmayın.

  • socketId

    sayı

    Sunucu yuvası tanımlayıcısı.

CreateInfo

Özellikler

  • socketId

    sayı

    Yeni oluşturulan sunucu soketinin kimliği. Bu API'den oluşturulan soket kimliklerinin, kullanımdan kaldırılan [soket](../socket/) API'si gibi diğer API'lerden oluşturulan soket kimlikleriyle uyumlu olmadığını unutmayın.

SocketInfo

Özellikler

  • localAddress

    dize isteğe bağlı

    Soket dinliyorsa yerel IPv4/6 adresini içerir.

  • localPort

    number isteğe bağlı

    Soket dinliyorsa yerel bağlantı noktasını içerir.

  • ad

    dize isteğe bağlı

    Soketle ilişkili, uygulama tarafından tanımlanan dize.

  • duraklatıldı

    boolean

    Bir dinleme soketindeki bağlantı isteklerinin onAccept etkinliği aracılığıyla gönderilip gönderilmediğini veya dinleme kuyruğu birikiminde sıraya alınıp alınmadığını gösteren işaret. Şu sayfaya göz atın: setPaused. Varsayılan değer "false" değeridir.

  • kalıcı

    boolean

    Uygulamanın etkinlik sayfası kaldırıldığında soketin açık kalıp kalmadığını belirten işaret (SocketProperties.persistent bölümüne bakın). Varsayılan değer "false"tur.

  • socketId

    sayı

    Soket tanımlayıcısı.

SocketProperties

Özellikler

  • ad

    dize isteğe bağlı

    Soketle ilişkilendirilmiş, uygulama tarafından tanımlanan bir dize.

  • kalıcı

    boolean isteğe bağlı

    Uygulamanın etkinlik sayfası kaldırıldığında soketin açık kalıp kalmadığını belirten işaret (bkz. Uygulama Yaşam Döngüsünü Yönetme). Varsayılan değer "false" değeridir. Uygulama yüklendiğinde, daha önce persistent=true ile açılan tüm soketler getSockets ile getirilebilir.

Yöntemler

close()

Promise 
chrome.sockets.tcpServer.close(
  socketId: number,
  callback?: function,
): Promise<void>

Soketin bağlantısını keser ve soketi yok eder. Oluşturulan her soket, kullanımdan sonra kapatılmalıdır. İşlev çağrılır çağrılmaz soket kimliği artık geçerli olmaz. Ancak soketin yalnızca geri çağırma işlemi çağrıldığında kapatılacağı garanti edilir.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

create()

Promise 
chrome.sockets.tcpServer.create(
  properties?: SocketProperties,
  callback?: function,
): Promise<CreateInfo>

TCP sunucu soketi oluşturur.

Parametreler

  • mülkler

    SocketProperties isteğe bağlı

    Soket özellikleri (isteğe bağlı).

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      Soket oluşturma işleminin sonucu.

İadeler

  • Promise<CreateInfo>

    Chrome 121 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

disconnect()

Promise 
chrome.sockets.tcpServer.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

Dinleme soketinin bağlantısını keser. Yani yeni bağlantıları kabul etmeyi durdurur ve soketin bağlı olduğu adresi/bağlantı noktasını serbest bırakır. Soket tanımlayıcısı geçerliliğini korur. Örneğin, yeni bir bağlantı noktasında ve adreste bağlantıları kabul etmek için listen ile kullanılabilir.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getInfo()

Promise 
chrome.sockets.tcpServer.getInfo(
  socketId: number,
  callback?: function,
): Promise<SocketInfo>

Belirtilen soketin durumunu alır.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Soket bilgilerini içeren nesne.

İadeler

  • Promise<SocketInfo>

    Chrome 121 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getSockets()

Promise 
chrome.sockets.tcpServer.getSockets(
  callback?: function,
): Promise<SocketInfo[]>

Uygulamaya ait olan ve şu anda açık olan yuvaların listesini alır.

Parametreler

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      Soket bilgilerini içeren nesne dizisi.

İadeler

  • Promise<SocketInfo[]>

    Chrome 121 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

listen()

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

Belirtilen bağlantı noktası ve adresteki bağlantıları dinler. Bağlantı noktası/adres kullanılıyorsa geri çağırma işlemi başarısız olur.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • adres

    dize

    Yerel makinenin adresi.

  • bağlantı noktası

    sayı

    Yerel makinenin bağlantı noktası. 0 olarak ayarlandığında ücretsiz bir bağlantı noktası dinamik olarak seçilir. Dinamik olarak ayrılan bağlantı noktası, getInfo aranarak bulunabilir.

  • backlog

    number isteğe bağlı

    Soketin dinleme sırasının uzunluğu. Varsayılan değer, İşletim Sistemine (SOMAXCONN) bağlıdır ve çoğu uygulama için makul bir kuyruk uzunluğu sağlar.

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    (result: number) => void

    • sonuç

      sayı

      Temel ağ çağrısından döndürülen sonuç kodu. Negatif değerler hata olduğunu gösterir.

setPaused()

Promise 
chrome.sockets.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
): Promise<void>

Bir dinleme yuvasının yeni bağlantıları kabul etmesini etkinleştirir veya devre dışı bırakır. Duraklatıldığında, bir dinleme soketi, biriktirme kuyruğu (listen işlevine bakın) dolana kadar yeni bağlantıları kabul eder, ardından ek bağlantı isteklerini reddeder. onAccept etkinlikleri yalnızca soket duraklatılmadığında tetiklenir.

Parametreler

  • socketId

    sayı

  • duraklatıldı

    boolean

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

update()

Promise 
chrome.sockets.tcpServer.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
): Promise<void>

Soket özelliklerini günceller.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • mülkler

    SocketProperties

    Güncellenecek mülkler.

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

Etkinlikler

onAccept

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

Sunucu yuvasına bağlantı kurulduğunda tetiklenen etkinlik.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    (info: AcceptInfo) => void

onAcceptError

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

Çalışma zamanı, soket adresi ve bağlantı noktasında yeni bağlantıları beklerken bir ağ hatası oluştuğunda tetiklenen etkinlik. Bu etkinlik oluşturulduktan sonra soket paused olarak ayarlanır ve soket devam ettirilene kadar bu soket için başka onAccept etkinlikleri oluşturulmaz.

Parametreler