chrome.sockets.tcp

Açıklama

TCP bağlantılarını kullanarak ağ üzerinden veri göndermek ve almak için chrome.sockets.tcp 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

CreateInfo

Özellikler

  • socketId

    sayı

    Yeni oluşturulan yuvanı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.

DnsQueryType

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

DNS çözümleme tercihleri. any varsayılan değerdir ve IPv4 veya IPv6 döndürebilecek geçerli işletim sistemi yapılandırmasını kullanır. ipv4 IPv4'ü, ipv6 ise IPv6'yı zorunlu kılar.

Enum

"herhangi biri"

"ipv4"

"ipv6"

ReceiveErrorInfo

Özellikler

  • resultCode

    sayı

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

  • socketId

    sayı

    Yuva tanımlayıcısı.

ReceiveInfo

Özellikler

  • veri

    DiziArabelleği

    Maksimum bufferSize boyutunda olmak üzere alınan veriler.

  • socketId

    sayı

    Yuva tanımlayıcısı.

SecureOptions

Özellikler

SendInfo

Özellikler

  • bytesSent

    sayı isteğe bağlı

    Gönderilen bayt sayısı (sonuç == 0 ise)

  • resultCode

    sayı

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

SocketInfo

Özellikler

  • bufferSize

    sayı isteğe bağlı

    Verileri almak için kullanılan arabelleğin boyutu. Açık bir şekilde arabellek boyutu belirtilmediyse değer sağlanmaz.

  • bağlandı

    boolean

    Soketin uzak bir eşe bağlı olup olmadığını gösteren işaret.

  • localAddress

    dize isteğe bağlı

    Temel yuva bağlıysa yerel IPv4/6 adresini içerir.

  • localPort

    sayı isteğe bağlı

    Temel soket bağlıysa yerel bağlantı noktasını içerir.

  • ad

    dize isteğe bağlı

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

  • duraklatıldı

    boolean

    Bağlı bir soketin, eşinin daha fazla veri göndermesini engelleyip engellemediğini gösteren işaret (bkz. setPaused).

  • peerAddress

    dize isteğe bağlı

    Temel yuva bağlıysa eş/ IPv4/6 adresini içerir.

  • peerPort

    sayı isteğe bağlı

    Temel soket bağlıysa eş bağlantı noktasını içerir.

  • kalıcı

    boolean

    Uygulama askıya alındığında soketin açık kalıp kalmadığını gösteren işaret (bkz. SocketProperties.persistent).

  • socketId

    sayı

    Yuva tanımlayıcısı.

SocketProperties

Özellikler

  • bufferSize

    sayı isteğe bağlı

    Verileri almak için kullanılan arabelleğin boyutu. Varsayılan değer 4096'dır.

  • 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.

TLSVersionConstraints

Özellikler

  • maks.

    dize isteğe bağlı

  • dk

    dize isteğe bağlı

    TLS'nin kabul edilebilir minimum ve maksimum sürümleri. tls1.2 veya tls1.3 değerleri desteklenir.

    tls1 ve tls1.1 değerleri artık desteklenmiyor. min bu değerlerden birine ayarlanırsa sessizce tls1.2 değerine ayarlanır. max bu değerlerden birine veya tanınmayan başka bir değere ayarlanırsa sessizce yoksayılır.

Yöntemler

close()

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

Yuvayı kapatır ve soketin bağlı olduğu adresi/bağlantı noktasını serbest bırakır. 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.

connect()

chrome.sockets.tcp.connect(
  socketId: number,
  peerAddress: string,
  peerPort: number,
  dnsQueryType?: DnsQueryType,
  callback: function,
)

Soketi uzaktaki bir makineye bağlar. connect işlemi başarıyla tamamlandığında, eşten veri alındığında onReceive etkinlik oluşturulur. Çalışma zamanı paketleri alırken bir ağ hatası oluşursa bir onReceiveError etkinliği oluşturulur. Bu noktada resume yöntemi çağrılana kadar bu yuva için onReceive etkinliği tetiklenmez.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • peerAddress

    dize

    Uzak makinenin adresi. DNS adı, IPv4 ve IPv6 biçimleri desteklenir.

  • peerPort

    sayı

    Uzak makinenin bağlantı noktası.

  • dnsQueryType

    DnsQueryType isteğe bağlı

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

    Adres çözümleme tercihi.

  • 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.

create()

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

TCP soketi 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

      Yuvanın 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.tcp.disconnect(
  socketId: number,
  callback?: function,
)

Prizin bağlantısını keser.

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.tcp.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.tcp.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.

secure()

chrome.sockets.tcp.secure(
  socketId: number,
  options?: SecureOptions,
  callback: function,
)

Bağlı TCP istemci yuvası üzerinden bir TLS istemci bağlantısı başlatın.

Parametreler

  • socketId

    sayı

    Kullanılacak mevcut bağlı yuva.

  • seçenekler

    SecureOptions isteğe bağlı

    TLS bağlantısıyla ilgili kısıtlamalar ve parametreler.

  • geri çağırma

    işlev

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

    (result: number) => void

    • sonuç

      sayı

send()

chrome.sockets.tcp.send(
  socketId: number,
  data: ArrayBuffer,
  callback: function,
)

Belirtilen TCP soketindeki verileri gönderir.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • veri

    DiziArabelleği

    Gönderilecek veriler.

  • geri çağırma

    işlev

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

    (sendInfo: SendInfo) => void

    • sendInfo

      SendInfo

      send yönteminin sonucu.

setKeepAlive()

chrome.sockets.tcp.setKeepAlive(
  socketId: number,
  enable: boolean,
  delay?: number,
  callback: function,
)

TCP bağlantısı için canlı tutma işlevini etkinleştirir veya devre dışı bırakır.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • enable

    boolean

    Doğruysa canlı tutma işlevini etkinleştirin.

  • gecikme

    sayı isteğe bağlı

    Alınan son veri paketi ile ilk keepalive kontrolü arasındaki saniye cinsinden gecikme süresini ayarlayın. Varsayılan değer 0'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.

setNoDelay()

chrome.sockets.tcp.setNoDelay(
  socketId: number,
  noDelay: boolean,
  callback: function,
)

TCP bağlantısı için TCP_NODELAY öğesini ayarlar veya temizler. TCP_NODELAY ayarlandığında Nagle'ın algoritması devre dışı bırakılır.

Parametreler

  • socketId

    sayı

    Yuva tanımlayıcısı.

  • noDelay

    boolean

    True (doğru) ise Nagle'ın algoritmasını devre dışı bırakı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.tcp.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

Uygulamanın, eşinden ileti almasını etkinleştirir veya devre dışı bırakır. Varsayılan değer "false" (yanlış) değeridir. Yuva duraklatma işlemi genellikle bir uygulama tarafından eşi tarafından gönderilen verileri kısıtlamak için kullanılır. Bir yuva duraklatıldığında hiçbir onReceive etkinliği oluşturulmaz. Bir yuva bağlandığında ve duraklatma kaldırıldığında, mesajlar alındığında onReceive etkinlikleri tekrar tetiklenir.

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.tcp.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

onReceive

chrome.sockets.tcp.onReceive.addListener(
  callback: function,
)

Belirli bir yuva için veri alındığında oluşturulan etkinlik.

Parametreler

  • geri çağırma

    işlev

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

    (info: ReceiveInfo) => void

onReceiveError

chrome.sockets.tcp.onReceiveError.addListener(
  callback: function,
)

Çalışma zamanı yuva adresi ve bağlantı noktasında veri beklerken bir ağ hatası oluştuğunda ortaya çıkan etkinlik. Bu etkinlik oluşturulduktan sonra yuva paused olarak ayarlanır ve bu yuva için başka onReceive etkinliği oluşturulmaz.

Parametreler