chrome.sockets.tcp

Açıklama

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

CreateInfo

Özellikler

  • socketId

    sayı

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

DnsQueryType

Chrome 103+

DNS çözümleme tercihleri. Varsayılan değer any olup IPv4 veya IPv6 döndürebilen mevcut işletim sistemi yapılandırmasını kullanır. ipv4, IPv4'ü zorunlu kılar ve ipv6, IPv6'yı zorunlu kılar.

Enum

"any"

"ipv4"

"ipv6"

ReceiveErrorInfo

Özellikler

  • resultCode

    sayı

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

  • socketId

    sayı

    Soket tanımlayıcısı.

ReceiveInfo

Özellikler

  • veri

    ArrayBuffer

    Alınan veriler (maksimum boyut: bufferSize).

  • socketId

    sayı

    Soket tanımlayıcısı.

SecureOptions

Özellikler

SendInfo

Özellikler

  • bytesSent

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

SocketInfo

Özellikler

  • bufferSize

    number isteğe bağlı

    Veri almak için kullanılan arabelleğin boyutu. Arabellek boyutu açıkça belirtilmemişse değer sağlanmaz.

  • bağlandı

    boole

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

  • localAddress

    string isteğe bağlı

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

  • localPort

    number isteğe bağlı

    Temel soket bağlıysa 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

    Bağlı bir soketin, eşinin daha fazla veri göndermesini engelleyip engellemediğini gösteren işaret (setPaused bölümüne bakın).

  • peerAddress

    string isteğe bağlı

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

  • peerPort

    number isteğe bağlı

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

  • kalıcı

    boole

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

  • socketId

    sayı

    Soket tanımlayıcısı.

SocketProperties

Özellikler

  • bufferSize

    number isteğe bağlı

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

  • 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 bırakılıp bırakılmadığını gösteren 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.

TLSVersionConstraints

Özellikler

  • maks.

    string isteğe bağlı

  • dk

    string isteğe bağlı

    Kabul edilebilir minimum ve maksimum TLS 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 sabitlenir. max bu değerlerden birine veya tanınmayan başka bir değere ayarlanırsa sessizce yoksayılır.

Yöntemler

close()

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

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

connect()

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

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

Parametreler

  • socketId

    sayı

    Soket 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+

    Adres çözümleme tercihi.

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

create()

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

TCP soketi 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.tcp.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

Soket bağlantısını keser.

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

secure()

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

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

Parametreler

  • socketId

    sayı

    Kullanılacak mevcut, bağlı soket.

  • seçenekler

    SecureOptions isteğe bağlı

    TLS bağlantısı için kısıtlamalar ve parametreler.

  • callback

    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,
): void

Belirtilen TCP soketinde veri gönderir.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • veri

    ArrayBuffer

    Gönderilecek veriler.

  • callback

    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,
): void

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

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • enable

    boole

    Doğru ise bağlantıyı canlı tutma işlevini etkinleştirir.

  • gecikme

    number isteğe bağlı

    Alınan son veri paketi ile ilk bağlantıyı canlı tutma sorgusu arasındaki gecikme süresini saniye cinsinden ayarlayın. Varsayılan değer 0'dır.

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

setNoDelay()

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

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

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • noDelay

    boole

    Doğru değerine ayarlanırsa Nagle algoritmasını devre dışı bırakır.

  • 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.tcp.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
): Promise<void>

Uygulamanın, eşinden mesaj almasını etkinleştirir veya devre dışı bırakır. Varsayılan değer "false"dur. Soket duraklatma, genellikle bir uygulama tarafından eşi tarafından gönderilen verileri kısıtlamak için kullanılır. Soket duraklatıldığında onReceive etkinliği tetiklenmez. Bir soket bağlandığında ve duraklatılmadığında, mesajlar alındığında onReceive etkinlikleri tekrar 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.tcp.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

onReceive

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

Belirli bir soket için veri alındığında tetiklenen etkinlik.

Parametreler

  • callback

    işlev

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

    (info: ReceiveInfo) => void

onReceiveError

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

Çalışma zamanı, soket adresi ve bağlantı noktasında veri beklerken bir ağ hatası oluştuğunda tetiklenen etkinlik. Bu etkinlik tetiklendikten sonra soket paused olarak ayarlanır ve bu soket için başka onReceive etkinliği tetiklenmez.

Parametreler