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'de bulunan TCP işlevinin yerini alır.

Manifest

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

"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ı (ör. yeni kurulan bağlantının yuva tanımlayıcısı). Bu yuva 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şlaması için uygulama tarafından duraklatmanın açıkça kaldırılması gerektiğini unutmayın.

  • socketId

    sayı

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

CreateInfo

Özellikler

  • socketId

    sayı

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

SocketInfo

Özellikler

  • localAddress

    dize isteğe bağlı

    Yuva dinliyorsa yerel IPv4/6 adresini içerir.

  • localPort

    sayı isteğe bağlı

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

  • ad

    dize isteğe bağlı

    Yuva ile ilişkili, uygulama tanımlı dize.

  • duraklatıldı

    boolean

    Bir dinleme yuvasındaki bağlantı isteklerinin onAccept etkinliği aracılığıyla mı gönderildiğini veya dinleme sırası iş listesinde sıraya alınıp alınmadığını gösteren işaret. Şu sayfaya göz atın: setPaused. Varsayılan değer "false" (yanlış) değeridir.

  • kalıcı

    boolean

    Uygulamanın etkinlik sayfası kaldırıldığında soketin açık kalıp kalmadığını gösteren işaret (bkz. SocketProperties.persistent). Varsayılan değer "false" (yanlış) değeridir.

  • socketId

    sayı

    Yuva tanımlayıcısı.

SocketProperties

Özellikler

  • ad

    dize isteğe bağlı

    Yuva ile ilişkili, uygulama tanımlı bir dize.

  • kalıcı

    boole isteğe bağlı

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

Yöntemler

close()

Söz 'nı inceleyin.
chrome.sockets.tcpServer.close(
  socketId: number,
  callback?: function,
)

Soketin bağlantısını keser ve soketi yok eder. Oluşturulan her yuva kullanımdan sonra kapatılmalıdır. İşlev çağrıldığı anda yuva kimliği geçerli olmaz. Ancak yuvanın yalnızca geri arama çağrıldığında kapatılacağı garanti edilir.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • geri çağırma

    işlev isteğe bağlı

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

    () => void

İadeler

  • Taahhüt<void>

    Chrome 121 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

create()

Söz 'nı inceleyin.
chrome.sockets.tcpServer.create(
  properties?: SocketProperties,
  callback?: function,
)

TCP sunucu yuvası oluşturur.

Parametreler

  • mülkler

    SocketProperties isteğe bağlı

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

  • geri çağırma

    işlev isteğe bağlı

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

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      Yuva oluşturulmasının sonucu.

İadeler

  • Promise&lt;CreateInfo&gt;

    Chrome 121 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

disconnect()

Söz 'nı inceleyin.
chrome.sockets.tcpServer.disconnect(
  socketId: number,
  callback?: function,
)

Dinleme prizinin bağlantısını keser (ör. yeni bağlantıları kabul etmeyi durdurur ve yuvanın bağlı olduğu adresi/bağlantı noktasını serbest bırakır). Yuva kimliği geçerli kalır, ör. yeni bir bağlantı noktası ve adresteki bağlantıları kabul etmek için listen ile kullanılabilir.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • geri çağırma

    işlev isteğe bağlı

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

    () => void

İadeler

  • Taahhüt<void>

    Chrome 121 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

getInfo()

Söz 'nı inceleyin.
chrome.sockets.tcpServer.getInfo(
  socketId: number,
  callback?: function,
)

Belirli bir yuvanın durumunu alır.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • geri çağırma

    işlev isteğe bağlı

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

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Yuva bilgilerini içeren nesne.

İadeler

  • Promise&lt;SocketInfo&gt;

    Chrome 121 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

getSockets()

Söz 'nı inceleyin.
chrome.sockets.tcpServer.getSockets(
  callback?: function,
)

Uygulamanın sahip olduğu, o anda açık olan yuvaların listesini alır.

Parametreler

  • geri çağırma

    işlev isteğe bağlı

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

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      Yuva bilgilerini içeren nesne dizisi.

İadeler

  • Promise&lt;SocketInfo[]&gt;

    Chrome 121 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

listen()

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

Belirtilen bağlantı noktası ve adresteki bağlantıları dinler. Bağlantı noktası/adres kullanılıyorsa, geri çağırma bir hata olduğunu gösterir.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • adres

    dize

    Yerel makinenin adresidir.

  • 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ılmış bağlantı noktası, getInfo çağrısı yapılarak bulunabilir.

  • iş listesi

    sayı isteğe bağlı

    Yuvanın dinleme sırasının uzunluğu. Varsayılan değer, çoğu uygulama için makul bir sıra uzunluğu sağlayan İşletim Sistemi'ne (SOMAXCONN) bağlıdır.

  • geri çağırma

    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ğer bir hata olduğunu gösterir.

setPaused()

Söz 'nı inceleyin.
chrome.sockets.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

Dinleme soketinin yeni bağlantıları kabul etmesini etkinleştirir veya devre dışı bırakır. Bir dinleme yuvası duraklatıldığında, iş listesi (bkz. listen işlevi) dolana kadar yeni bağlantıları kabul eder, ardından ek bağlantı isteklerini reddeder. onAccept etkinlikleri, yalnızca yuva duraklatma işlemi kaldırıldığında ortaya çıkar.

Parametreler

  • socketId

    sayı

  • duraklatıldı

    boolean

  • geri çağırma

    işlev isteğe bağlı

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

    () => void

İadeler

  • Taahhüt<void>

    Chrome 121 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

update()

Söz 'nı inceleyin.
chrome.sockets.tcpServer.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

Yuva özelliklerini günceller.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • mülkler

    SocketProperties

    Güncellenecek özellikler.

  • geri çağırma

    işlev isteğe bağlı

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

    () => void

İadeler

  • Taahhüt<void>

    Chrome 121 ve sonraki sürümler 'nı inceleyin.

    Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.

Etkinlikler

onAccept

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

Sunucu yuvasıyla bağlantı kurulduğunda ortaya çıkan etkinlik.

Parametreler

  • geri çağırma

    işlev

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

    (info: AcceptInfo) => void

onAcceptError

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

Çalışma zamanı yuva adresinde ve bağlantı noktasında yeni bağlantılar beklerken bir ağ hatası oluştuğunda ortaya çıkan olay. Bu etkinlik oluşturulduktan sonra, yuva paused olarak ayarlanır ve yuva devam ettirilene kadar bu yuva için başka onAccept etkinliği başlatılmaz.

Parametreler