Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / JavaScript

Transferir un ArrayBuffer con postMessage: propiedad y desvinculación

Transferir un `ArrayBuffer` con `postMessage()` desvincula el búfer del emisor antes de la entrega. Sin lista de transferencia, se copian los bytes.

Versión: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxis

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] })

Si un ArrayBuffer normal está en el mensaje pero no en la lista de transferencia, la clonación estructurada copia sus bytes y el emisor puede seguir usando su búfer. Incluirlo en la lista transfiere la propiedad de la memoria subyacente en lugar de compartirla. Si la transferencia tiene éxito, el búfer del emisor ya está desvinculado cuando retorna la llamada. Si el mensaje llega, el destinatario recibe en event.data un objeto búfer nuevo con los bytes originales en un evento message posterior. La desvinculación no confirma la entrega.

Incluye el mismo búfer en el mensaje, por ejemplo { buffer }, y en la lista de transferencia [buffer]. Si solo lo incluyes en la lista, puede quedar desvinculado sin estar accesible en los datos del mensaje. Un Uint8Array o un DataView se puede clonar, pero no puede ir en la lista de transferencia. Usa view.buffer: se transfiere todo el búfer subyacente, no solo el intervalo de la vista.

La desvinculación no elimina el objeto ni sus referencias. buffer.byteLength y el byteLength de los arrays tipados existentes que usan ese búfer devuelven 0, pero leer byteLength en un DataView que lo usa lanza TypeError. Una longitud de 0 no demuestra por sí sola la desvinculación: un búfer no desvinculado puede estar vacío. Si está disponible el getter ArrayBuffer.prototype.detached de ECMAScript 2024, comprueba buffer.detached.

Un búfer repetido o ya desvinculado, una vista o un SharedArrayBuffer en la lista, o un valor no clonable en el mensaje, como una función, pueden provocar de forma síncrona una DOMException llamada DataCloneError. Si está permitido enviar un SharedArrayBuffer, se comparte la memoria en vez de transferir su propiedad.

Worker, MessagePort y el ámbito global de un worker dedicado aceptan, después del mensaje, una lista o las opciones { transfer }. Para una ventana, indica targetOrigin antes de la lista o usa { targetOrigin, transfer }. El valor predeterminado "/" representa el origen del emisor. Si conoces el origen de destino, indícalo exactamente en vez de usar "*". Al recibir, comprueba event.origin, event.source cuando corresponda y la validez de los datos. postMessage() es una API de la plataforma web, no de ECMAScript; su compatibilidad depende del entorno de ejecución.

Ejemplos

(() => {
  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}`);
})();

Resultado

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

Ejecuta el código en la consola de desarrollo de un navegador. Ambos puertos funcionan en la misma página, sin un worker. Se esperan primero las dos líneas del emisor y luego la del destinatario con los tres bytes intactos.

Lecciones relacionadas

  • JavaScript · Lección 5 · Avanzado · Versión: 4

Fuentes