chrome.sockets.tcpServer

Açıklama

TCP bağlantılarını kullanarak sunucu uygulamaları oluşturmak için chrome.sockets.tcpServer API'sini 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 tanımlanması 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ı, yani yeni kurulan bağlantının yuva tanımlayıcısı. Bu soket tanımlayıcı 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şlamak için uygulama tarafından açıkça devam ettirilmesi 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 soket kimliklerinin, desteği sonlandırılmış [socket](../socket/) API gibi diğer API'lerden oluşturulan soket kimlikleriyle uyumlu olmadığını unutmayın.

SocketInfo

Özellikler

  • localAddress

    string 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

    string isteğe bağlı

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

  • duraklatıldı

    boole

    Dinleme soketindeki bağlantı isteklerinin onAccept etkinliği aracılığıyla gönderilip gönderilmediğini veya dinleme sırası biriktirme 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"dur.

  • kalıcı

    boole

    Uygulamanın etkinlik sayfası kaldırıldığında soketin açık kalıp kalmayacağını belirten işaret (bkz. SocketProperties.persistent). Varsayılan değer "false"tur.

  • socketId

    sayı

    Soket tanımlayıcısı.

SocketProperties

Özellikler

  • ad

    string isteğe bağlı

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

  • kalıcı

    boole isteğe bağlı

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

Yöntemler

close()

Taahhüt 
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ıldıktan sonra kapatılmalıdır. Soket kimliği, işlev çağrılır çağrılmaz geçersiz hale gelir. Ancak soketin yalnızca geri çağırma işlevi çağrıldığında kapatılacağı garanti edilir.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • callback

    function isteğe bağlı

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

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

create()

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

TCP sunucu yuvası oluşturur.

Parametreler

  • mülkler

    SocketProperties isteğe bağlı

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

  • callback

    function 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

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

disconnect()

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

Dinleme soketinin bağlantısını keser. Diğer bir deyişle, 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çerli kalır. Örneğin, yeni bir bağlantı noktası ve adresteki bağlantıları kabul etmek için listen ile kullanılabilir.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • callback

    function isteğe bağlı

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

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

getInfo()

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

Belirtilen soketin durumunu alır.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • callback

    function 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

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

getSockets()

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

Uygulamaya ait olan ve o anda açık olan soketlerin listesini alır.

Parametreler

  • callback

    function 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

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

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

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 boş bir bağlantı noktası dinamik olarak seçilir. Dinamik olarak ayrılan bağlantı noktası, getInfo çağrılarak bulunabilir.

  • birikmiş işler

    number isteğe bağlı

    Soketin dinleme sırasının uzunluğu. Varsayılan değer, işletim sistemine (SOMAXCONN) bağlıdır. Bu, çoğu uygulama için makul bir sıra 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ğer, hata olduğunu gösterir.

setPaused()

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

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

Parametreler

  • socketId

    sayı

  • duraklatıldı

    boole

  • callback

    function isteğe bağlı

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

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

update()

Taahhüt 
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 özellikler.

  • callback

    function isteğe bağlı

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

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promise'ler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırma işlevlerini kullanması gerekir.

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 tetiklendikten sonra soket paused olarak ayarlanır ve soket devam ettirilene kadar bu soket için başka onAccept etkinliği tetiklenmez.

Parametreler