chrome.sockets.tcpServer

Açıklama

TCP bağlantıları 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'te 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 yuva 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 yuvasının başlangıçta duraklatıldığını ve veri almaya başlaması için uygulamanın duraklatmasını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

    string isteğe bağlı

    Yuva dinliyorsa yerel IPv4/6 adresini içerir.

  • localPort

    numara isteğe bağlı

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

  • ad

    string isteğe bağlı

    Yuvayla ilişkilendirilen uygulama tanımlı dize.

  • duraklatıldı

    boolean

    Dinleme yuvasındaki bağlantı isteklerinin onAccept etkinliği üzerinden gönderilip gönderilmediğini veya dinleme sırası yığınında 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.

  • inatçı

    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

    string isteğe bağlı

    Yuvayla ilişkilendirilmiş, uygulama tanımlı bir dize.

  • inatçı

    boole isteğe bağlı

    Uygulamanın etkinlik sayfası kaldırıldığında soketin açık kalıp kalmadığını gösteren 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 kalıcı=true ile açılmış olan tüm yuvalar getSockets ile getirilebilir.

Yöntemler

close()

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

Yuvanın bağlantısını keser ve yuvayı yok eder. Oluşturulan her yuva kullanıldıktan sonra kapatılmalıdır. İşlev çağrıldığı anda yuva kimliği artık geçerli değildir. Ancak yalnızca geri çağırma çağrıldığında yuvanın kapatılması garanti edilir.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • geri çağırma

    Functions (isteğe bağlı)

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

    ()=>void

İlerlemeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

create()

Söz 
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

    Functions (isteğe bağlı)

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

    (createInfo: CreateInfo)=>void

    • createInfo

      CreateInfo

      Yuva oluşturma işleminin sonucu.

İlerlemeler

  • Promise<CreateInfo>

    Chrome 121 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

disconnect()

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

Dinleme yuvasının bağlantısını keser. Yani, yeni bağlantı kabul etmeyi durdurur ve soketin bağlı olduğu adresi/bağlantı noktasını çıkarır. Yuva tanımlayıcısı geçerli olmaya devam eder. Örneğin, yeni bir bağlantı noktası ve adreste bağlantıları kabul etmek için listen ile birlikte kullanılabilir.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • geri çağırma

    Functions (isteğe bağlı)

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

    ()=>void

İlerlemeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

getInfo()

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

Belirtilen yuvanın durumunu alır.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • geri çağırma

    Functions (isteğe bağlı)

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

    (socketInfo: SocketInfo)=>void

    • socketInfo

      SocketInfo

      Yuva bilgilerini içeren nesne.

İlerlemeler

  • Promise<SocketInfo>

    Chrome 121 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

getSockets()

Söz 
chrome.sockets.tcpServer.getSockets(
  callback?: function,
)

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

Parametreler

  • geri çağırma

    Functions (isteğe bağlı)

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

    (socketInfos: SocketInfo[])=>void

    • socketInfos

      SocketInfo[]

      Yuva bilgilerini içeren nesne dizisi.

İlerlemeler

  • Promise<SocketInfo[]>

    Chrome 121 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması 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 adresi.

  • bağlantı noktası

    sayı

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

  • iş listesi

    numara 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 Sistemine (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 
chrome.sockets.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

Dinleme yuvasının yeni bağlantıları kabul etmesini etkinleştirir veya devre dışı bırakır. Bir dinleme soketi duraklatıldığında iş listesi (bkz. listen işlevi) dolana kadar yeni bağlantıları kabul eder ve ardından ek bağlantı isteklerini reddeder. onAccept etkinlikleri yalnızca yuvanın duraklatması kaldırıldığında yükseltilir.

Parametreler

  • socketId

    sayı

  • duraklatıldı

    boolean

  • geri çağırma

    Functions (isteğe bağlı)

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

    ()=>void

İlerlemeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

update()

Söz 
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

    Functions (isteğe bağlı)

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

    ()=>void

İlerlemeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.

Etkinlikler

onAccept

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

Sunucu yuvasına bağlantı kurulduğunda etkinlik oluşuyor.

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 etkinlik oluşuyor. Bu etkinlik yükseltildiğinde, yuva paused olarak ayarlanır ve yuva devam ettirilene kadar bu yuva için başka onAccept etkinliği yükseltilmez.

Parametreler