KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

Een ArrayBuffer overdragen met postMessage: eigendom en loskoppeling

Een overdracht via `postMessage()` koppelt de `ArrayBuffer` van de afzender vóór bezorging los. Zonder overdrachtslijst worden de bytes gekopieerd.

Versie: ECMAScript 2024 and the current web platform; runtime support varies

Syntax

worker.postMessage(message)
worker.postMessage(message, [buffer])
worker.postMessage(message, { transfer: [buffer] })
self.postMessage(message, [buffer]) // Dedicated worker global scope
port.postMessage(message, [buffer])
port.postMessage(message, { transfer: [buffer] })
targetWindow.postMessage(message, targetOrigin, [buffer])
targetWindow.postMessage(message, { targetOrigin, transfer: [buffer] })

Staat een gewone ArrayBuffer wel in het bericht maar niet in de overdrachtslijst, dan kopieert gestructureerd klonen de bytes en blijft de buffer van de afzender bruikbaar. Staat de buffer wel in die lijst, dan wordt het eigendom van het onderliggende geheugen overgedragen in plaats van gedeeld. Bij een geslaagde overdracht is de buffer van de afzender al losgekoppeld zodra de aanroep terugkeert. Komt het bericht aan, dan krijgt de ontvanger bij een latere message-gebeurtenis via event.data een nieuw bufferobject met de oorspronkelijke bytes. Loskoppeling bevestigt geen bezorging.

Zet dezelfde buffer in het bericht, bijvoorbeeld { buffer }, én in de overdrachtslijst [buffer]. Alleen vermelden in de lijst kan de buffer loskoppelen zonder die via de berichtgegevens toegankelijk te maken. Een Uint8Array of DataView kan worden gekloond, maar kan zelf niet in de overdrachtslijst. Gebruik view.buffer: daarmee draag je de hele onderliggende buffer over, niet alleen het bereik van de weergave.

Loskoppeling verwijdert het object en de verwijzingen ernaar niet. buffer.byteLength en de byteLength van bestaande getypeerde arrays op die buffer geven 0 terug. Het lezen van byteLength op een DataView met die buffer geeft daarentegen een TypeError. Alleen 0 bewijst geen loskoppeling: een gekoppelde buffer kan leeg zijn. Als de getter ArrayBuffer.prototype.detached uit ECMAScript 2024 beschikbaar is, controleer dan buffer.detached.

Een dubbele of al losgekoppelde buffer, een weergave of SharedArrayBuffer in de lijst, of een niet-kloonbare berichtwaarde zoals een functie kan synchroon een DOMException met de naam DataCloneError veroorzaken. Als het versturen van een SharedArrayBuffer is toegestaan, wordt het geheugen gedeeld in plaats van overgedragen.

Worker, MessagePort en de globale context van een dedicated worker accepteren na het bericht een lijst of { transfer } als opties. Geef voor een venster targetOrigin vóór de lijst op of gebruik { targetOrigin, transfer }. De standaardwaarde "/" staat voor de origin van de afzender. Geef de exacte doelorigin op als je die kent, in plaats van "*". Controleer bij ontvangst event.origin, waar relevant event.source, en valideer de gegevens. postMessage() is een webplatform-API, geen onderdeel van ECMAScript; de ondersteuning verschilt per uitvoeringsomgeving.

Voorbeelden

(() => {
  const { port1, port2 } = new MessageChannel();
  const view = new Uint8Array([7, 42, 255]);
  const buffer = view.buffer;

  port2.onmessage = ({ data }) => {
    const bytes = new Uint8Array(data.buffer);
    console.log(`received: ${bytes.byteLength} bytes (${bytes.join(', ')})`);
    port1.close();
    port2.close();
  };

  console.log(`before: buffer=${buffer.byteLength}, view=${view.byteLength}`);
  port1.postMessage({ buffer }, [buffer]);
  console.log(`after: buffer=${buffer.byteLength}, view=${view.byteLength}`);
})();

Resultaat

before: buffer=3, view=3
after: buffer=0, view=0
received: 3 bytes (7, 42, 255)

Voer de code uit in de ontwikkelaarsconsole van een browser. Beide poorten werken op dezelfde pagina, zonder worker. Verwacht eerst de twee regels van de afzender en daarna die van de ontvanger met de drie ongewijzigde bytes.

Gerelateerde lessen

  • JavaScript · Les 5 · Gevorderd · Versie: 4

Bronnen