chrome.sockets.udp

Açıklama

UDP bağlantılarını kullanarak ağ üzerinden veri göndermek ve almak için chrome.sockets.udp API'yi kullanın. Bu API, daha önce "socket"ta bulunan UDP işlevselliğinin yerini alır API'ye gidin.

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 recvfrom() çağrısından döndürülen sonuç kodu.

  • socketId

    sayı

    Yuva kimliği.

ReceiveInfo

Özellikler

  • veri

    DiziArabelleği

    UDP paketi içeriği (mevcut arabellek boyutuna kısaltılır).

  • remoteAddress

    dize

    Paketin geldiği ana makinenin adresidir.

  • remotePort

    sayı

    Paketin geldiği ana makinenin bağlantı noktasıdır.

  • socketId

    sayı

    Yuva kimliği.

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.

  • localAddress

    dize isteğe bağlı

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

  • localPort

    sayı isteğe bağlı

    Alttaki yuva 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

    Yuvanın onGet etkinliklerini tetiklemesinin engellenip engellenmediğini gösteren işaret.

  • 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. Arabellek UDP paketini almak için çok küçükse veriler kaybolur. 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.

Yöntemler

bind()

chrome.sockets.udp.bind(
  socketId: number,
  address: string,
  port: number,
  callback: function,
)

Yuvanın yerel adresini ve bağlantı noktasını bağlar. İstemci soketinde platformun boş bir bağlantı noktası seçmesine izin vermek için bağlantı noktası 0'ın kullanılması önerilir.

bind işlemi başarıyla tamamlandıktan sonra, UDP paketleri belirtilen adrese/bağlantı noktasına ulaştığında (soket duraklatılmadığı sürece) onReceive etkinlikleri oluşturulur.

Parametreler

  • socketId

    sayı

    Yuva kimliği.

  • adres

    dize

    Yerel makinenin adresidir. DNS adı, IPv4 ve IPv6 biçimleri desteklenir. "0.0.0.0" değerini kullanın mevcut tüm yerel ağ arayüzlerinden gelen paketleri kabul etmenizi sağlar.

  • bağlantı noktası

    sayı

    Yerel makinenin bağlantı noktası. "0" değerini kullanın serbest bağlantı noktasına bağlamak için kullanı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.

close()

Söz 'nı inceleyin.
chrome.sockets.udp.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 kimliği.

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

create()

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

Verilen özelliklere sahip bir UDP 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.

getInfo()

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

Belirli bir yuvanın durumunu alır.

Parametreler

  • socketId

    sayı

    Yuva kimliği.

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

getJoinedGroups()

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

Yuvanın şu anda katıldığı çoklu yayın grup adreslerini alır.

Parametreler

  • socketId

    sayı

    Yuva kimliği.

  • geri çağırma

    işlev isteğe bağlı

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

    (groups: string[]) => void

    • groups

      dize[]

      Yuvanın birleştirildiği grup dizisi.

İadeler

  • Promise&lt;string[]&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.udp.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.

joinGroup()

chrome.sockets.udp.joinGroup(
  socketId: number,
  address: string,
  callback: function,
)

Çoklu yayın grubuna katılır ve bu gruptan paket almaya başlar. Bu yöntem çağrılmadan önce soket yerel bağlantı noktasına bağlı olmalıdır.

Parametreler

  • socketId

    sayı

    Yuva kimliği.

  • adres

    dize

    Katılınacak grup adresi. Alan adları desteklenmez.

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

leaveGroup()

chrome.sockets.udp.leaveGroup(
  socketId: number,
  address: string,
  callback: function,
)

Daha önce joinGroup kullanarak katılmış olan çoklu yayın grubundan ayrılır. Bu, yuva kapatıldığında işletim sistemi tarafından otomatik olarak gerçekleştirileceğinden, yalnızca yuvayı daha sonra kullanmaya devam etmeyi düşünüyorsanız çağırmak için gereklidir.

Ana makinede başka bir işlemin gruba katılmadığı varsayıldığında, gruptan ayrıldığınızda yönlendiricinin yerel ana makineye çoklu yayın veri birimleri göndermesi engellenir.

Parametreler

  • socketId

    sayı

    Yuva kimliği.

  • adres

    dize

    Ayrılmak istediğiniz grup adresi. Alan adları desteklenmez.

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

send()

chrome.sockets.udp.send(
  socketId: number,
  data: ArrayBuffer,
  address: string,
  port: number,
  dnsQueryType?: DnsQueryType,
  callback: function,
)

Verilen yuvadaki verileri verilen adrese ve bağlantı noktasına gönderir. Bu yöntem çağrılmadan önce soket yerel bağlantı noktasına bağlı olmalıdır.

Parametreler

  • socketId

    sayı

    Yuva kimliği.

  • veri

    DiziArabelleği

    Gönderilecek veriler.

  • adres

    dize

    Uzak makinenin adresi.

  • bağlantı noktası

    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: 

    (sendInfo: SendInfo) => void

    • sendInfo

      SendInfo

      send yönteminin sonucu.

setBroadcast()

Chrome 44 ve sonraki sürümler 'nı inceleyin.
chrome.sockets.udp.setBroadcast(
  socketId: number,
  enabled: boolean,
  callback: function,
)

Bu yuvadaki yayın paketlerini etkinleştirir veya devre dışı bırakır.

Parametreler

  • socketId

    sayı

    Yuva kimliği.

  • etkin

    boolean

    Yayın paketlerini etkinleştirmek için true, devre dışı bırakmak için false.

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

setMulticastLoopbackMode()

chrome.sockets.udp.setMulticastLoopbackMode(
  socketId: number,
  enabled: boolean,
  callback: function,
)

Ana makineden çoklu yayın grubuna gönderilen çoklu yayın paketlerinin ana makineye geri döngülü olup olmayacağını belirler.

Not: setMulticastLoopbackMode işletim sisteminin davranışı, Windows ve Unix benzeri sistemlerde biraz farklıdır. Tutarsızlık yalnızca, aynı ana makinede birden fazla uygulamanın aynı çoklu yayın grubuna katılıp çoklu yayın geri dönüş modunda farklı ayarlara sahip olması durumunda ortaya çıkar. Windows'da, geri döngünün devre dışı olduğu uygulamalar geri döngü paketlerini ALMAZ; Unix benzeri sistemlerde, geri döngü kapalı uygulamaları olan uygulamalar geri döngü paketlerini aynı ana bilgisayardaki diğer uygulamalara GÖNDERMEZ. MSDN'ye göz atın: http://goo.gl/6vqbj

Bu yöntemin çağrılması, çoklu yayın izinleri gerektirmez.

Parametreler

  • socketId

    sayı

    Yuva kimliği.

  • etkin

    boolean

    Geri döngü modunun etkinleştirilip etkinleştirilmeyeceğini belirtin.

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

setMulticastTimeToLive()

chrome.sockets.udp.setMulticastTimeToLive(
  socketId: number,
  ttl: number,
  callback: function,
)

Çoklu yayın grubuna gönderilen çoklu yayın paketlerinin geçerlilik süresini ayarlar.

Bu yöntemin çağrılması, çoklu yayın izinleri gerektirmez.

Parametreler

  • socketId

    sayı

    Yuva kimliği.

  • ttl

    sayı

    Geçerlilik süresi değeri.

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

Bir yuvayı duraklatır veya devam ettirir. Duraklatılmış bir yuvanın onReceive etkinliği tetiklemesi engellendi.

Parametreler

  • socketId

    sayı

  • duraklatıldı

    boolean

    Duraklatmayı veya duraklatmayı kaldırmayı gösteren işaret.

  • 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.udp.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

Yuva özelliklerini günceller.

Parametreler

  • socketId

    sayı

    Yuva kimliği.

  • 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.udp.onReceive.addListener(
  callback: function,
)

Belirli bir yuvaya UDP paketi alındığında ortaya çıkan etkinlik.

Parametreler

  • geri çağırma

    işlev

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

    (info: ReceiveInfo) => void

onReceiveError

chrome.sockets.udp.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 başlatıldıktan sonra yuva duraklatılır ve soket devam ettirilene kadar bu yuva için başka onReceive etkinliği başlatılmaz.

Parametreler