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

Manifest

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

"sockets"

Türler

CreateInfo

Özellikler

  • socketId

    sayı

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

DnsQueryType

Chrome 103 veya daha yeni bir sürüm

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'ü, ipv6 ise IPv6'yı zorlar.

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

  • aktarma

    ArrayBuffer

    En fazla bufferSize boyutunda alınan veriler.

  • 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ğerler 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 belirtilmediyse değer sağlanmaz.

  • bağlandı

    boolean

    Soketin uzak bir eşe bağlanıp bağlanmadığını gösteren işaret.

  • localAddress

    dize 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

    dize isteğe bağlı

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

  • duraklatıldı

    boolean

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

  • peerAddress

    dize 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ı

    boolean

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

  • 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 4.096'dır.

  • ad

    dize isteğe bağlı

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

  • kalıcı

    boolean 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" değeridir. Uygulama yüklendiğinde, daha önce persistent=true ile açılan tüm soketler getSockets ile getirilebilir.

TLSVersionConstraints

Özellikler

  • maks.

    dize isteğe bağlı

  • dk

    dize 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()

Promise 
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ımdan sonra kapatılmalıdır. İşlev çağrılır çağrılmaz soket kimliği artık geçerli olmaz. Ancak soketin yalnızca geri çağırma işlemi çağrıldığında kapatılacağı garanti edilir.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • callback

    işlev isteğe bağlı

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

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

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ı paket 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 veya daha yeni bir sürüm

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

create()

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

TCP yuvası oluşturur.

Parametreler

  • mülkler

    SocketProperties isteğe bağlı

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

  • callback

    işlev 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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

disconnect()

Promise 
chrome.sockets.tcp.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

Soketin bağlantısını keser.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • callback

    işlev isteğe bağlı

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

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getInfo()

Promise 
chrome.sockets.tcp.getInfo(
  socketId: number,
  callback?: function,
): Promise<SocketInfo>

Belirtilen soketin durumunu alır.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • callback

    işlev 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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

getSockets()

Promise 
chrome.sockets.tcp.getSockets(
  callback?: function,
): Promise<SocketInfo[]>

Uygulamaya ait olan ve şu anda açık olan yuvaların listesini alır.

Parametreler

  • callback

    işlev 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

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

secure()

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

Bağlı TCP istemci soketi ü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.

  • 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 soketine veri gönderir.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • aktarma

    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

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

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • enable

    boolean

    Doğruysa keep-alive işlevini etkinleştirin.

  • gecikme

    number isteğe bağlı

    Alınan son veri paketi ile ilk canlı tutma araştırması 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ğerler 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 ayarlarını belirler veya temizler. TCP_NODELAY ayarlandığında Nagle algoritması devre dışı bırakılır.

Parametreler

  • socketId

    sayı

    Soket tanımlayıcısı.

  • noDelay

    boolean

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

setPaused()

Promise 
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" değeridir. Bir soketi duraklatmak genellikle bir uygulama tarafından eşi tarafından gönderilen verileri sınırlamak için kullanılır. Bir soket duraklatıldığında onReceive etkinliği tetiklenmez. Bir soket bağlanıp duraklatma kaldırıldığında, mesajlar alındığında onReceive etkinlikleri tekrar tetiklenir.

Parametreler

  • socketId

    sayı

  • duraklatıldı

    boolean

  • callback

    işlev isteğe bağlı

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

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

update()

Promise 
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 mülkler.

  • callback

    işlev isteğe bağlı

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

    () => void

İadeler

  • Promise<void>

    Chrome 121 ve sonraki sürümler

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

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ındaki verileri 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 etkinlikleri tetiklenmez.

Parametreler