Açıklama
TCP bağlantılarını kullanarak ağ üzerinden veri gönderip 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
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
DNS çözümleme tercihleri. Varsayılan değer any
şeklindedir ve IPv4 veya IPv6 döndürebilen mevcut işletim sistemi yapılandırmasını kullanır. ipv4
IPv4'ü, ipv6
ise 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ı
Yuva tanımlayıcısı.
ReceiveInfo
Özellikler
-
veri
ArrayBuffer
Maksimum
bufferSize
boyutunda alınan veriler. -
socketId
sayı
Yuva tanımlayıcısı.
SecureOptions
Özellikler
-
tlsVersion
TLSVersionConstraints isteğe bağlı
SendInfo
Özellikler
-
bytesSent
numara 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
numara isteğe bağlı
Verileri almak için kullanılan arabelleğin boyutu. Açıkça herhangi bir tampon boyutu belirtilmediyse değer sağlanmaz.
-
bağlandı
boolean
Yuvanın uzak bir eşe bağlı olup olmadığını gösteren işaret.
-
localAddress
string isteğe bağlı
Alttaki yuva bağlıysa yerel IPv4/6 adresini içerir.
-
localPort
numara isteğe bağlı
Alttaki yuva bağlıysa yerel bağlantı noktasını içerir.
-
ad
string isteğe bağlı
Yuvayla ilişkilendirilen 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
string isteğe bağlı
Alttaki yuva bağlıysa eş/ IPv4/6 adresini içerir.
-
peerPort
numara isteğe bağlı
Alttaki yuva bağlıysa eş bağlantı noktasını içerir.
-
inatçı
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
numara isteğe bağlı
Verileri almak için kullanılan arabelleğin boyutu. Varsayılan değer 4096'dır.
-
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 (Uygulama Yaşam Döngüsünü Yönetme bölümüne bakın). 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.
TLSVersionConstraints
Özellikler
-
maks.
string isteğe bağlı
-
dak
string isteğe bağlı
TLS'nin kabul edilebilir minimum ve maksimum sürümleri.
tls1.2
veyatls1.3
değerleri desteklenir.tls1
vetls1.1
değerleri artık desteklenmiyor.min
bu değerlerden birine ayarlanırsa sessizcetls1.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()
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ı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ümlerVaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması 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 yükseltilir. Ç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 başka onReceive
etkinliği oluşturulmaz.
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ümlerAdres çö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()
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
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(createInfo: CreateInfo) => void
-
createInfo
Yuva oluşturma işleminin sonucu.
-
İlerlemeler
-
Promise<CreateInfo>
Chrome 121 ve sonraki sürümlerVaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
disconnect()
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
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:() => void
İlerlemeler
-
Promise<void>
Chrome 121 ve sonraki sürümlerVaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
getInfo()
chrome.sockets.tcp.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
Yuva bilgilerini içeren nesne.
-
İlerlemeler
-
Promise<SocketInfo>
Chrome 121 ve sonraki sürümlerVaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
getSockets()
chrome.sockets.tcp.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
Yuva bilgilerini içeren nesne dizisi.
-
İlerlemeler
-
Promise<SocketInfo[]>
Chrome 121 ve sonraki sürümlerVaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması 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ı soket.
-
seçenekler
SecureOptions isteğe bağlı
TLS bağlantısı kısıtlamaları ve parametreleri.
-
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 soketinde veri gönderir.
Parametreler
-
socketId
sayı
Yuva tanımlayıcısı.
-
veri
ArrayBuffer
Gönderilecek veriler.
-
geri çağırma
işlev
callback
parametresi şu şekilde görünür:(sendInfo: SendInfo) => void
-
sendInfo
send
yönteminin sonucu.
-
setKeepAlive()
chrome.sockets.tcp.setKeepAlive(
socketId: number,
enable: boolean,
delay?: number,
callback: function,
)
TCP bağlantısı için keep-alive işlevini etkinleştirir veya devre dışı bırakır.
Parametreler
-
socketId
sayı
Yuva tanımlayıcısı.
-
enable
boolean
Doğru değerine ayarlanırsa canlı tutma işlevini etkinleştirin.
-
delay
numara 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
değerini belirler 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) değerine ayarlanırsa Nagle'ın algoritması devre dışı bırakılı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()
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" değeridir. Bir yuvanın duraklatılması, genellikle bir uygulama tarafından, eşi tarafından gönderilen verileri daraltmak için kullanılır. Bir yuva duraklatıldığında onReceive
etkinliği yükseltilmez. Bir yuva bağlandığında ve duraklatması kaldırıldığında, mesaj alındığında onReceive
etkinlikleri tekrar yükselir.
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ümlerVaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
update()
chrome.sockets.tcp.update(
socketId: number,
properties: SocketProperties,
callback?: function,
)
Yuva özelliklerini günceller.
Parametreler
-
socketId
sayı
Yuva tanımlayıcısı.
-
mülkler
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ümlerVaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
Etkinlikler
onReceive
chrome.sockets.tcp.onReceive.addListener(
callback: function,
)
Belirli bir yuva için veri alındığında ortaya çıkan etkinlik.
Parametreler
-
geri çağırma
işlev
callback
parametresi şu şekilde görünür:(info: ReceiveInfo) => void
-
bilgi
-
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 ortaya çıktı. Bu etkinlik yükseltildiğinde, yuva paused
olarak ayarlanır ve bu yuva için başka onReceive
etkinliği yükseltilmez.
Parametreler
-
geri çağırma
işlev
callback
parametresi şu şekilde görünür:(info: ReceiveErrorInfo) => void
-
bilgi
-