v8::ValueSerializer::Delegate Class Reference

#include <v8-value-serializer.h>

Public Member Functions
virtual	~Delegate ()=default
virtual void	ThrowDataCloneError (Local< String > message)=0
virtual bool	HasCustomHostObject (Isolate *isolate)
virtual Maybe< bool >	IsHostObject (Isolate *isolate, Local< Object > object)
virtual Maybe< bool >	WriteHostObject (Isolate *isolate, Local< Object > object)
virtual Maybe< uint32_t >	GetSharedArrayBufferId (Isolate *isolate, Local< SharedArrayBuffer > shared_array_buffer)
virtual Maybe< uint32_t >	GetWasmModuleTransferId (Isolate *isolate, Local< WasmModuleObject > module)
virtual bool	AdoptSharedValueConveyor (Isolate *isolate, SharedValueConveyor &&conveyor)
virtual void *	ReallocateBufferMemory (void *old_buffer, size_t size, size_t *actual_size)
virtual void	FreeBufferMemory (void *buffer)

Constructor & Destructor Documentation

~Delegate()

virtual v8::ValueSerializer::Delegate::~Delegate ( )

virtualdefault

Member Function Documentation

AdoptSharedValueConveyor()

virtual bool v8::ValueSerializer::Delegate::AdoptSharedValueConveyor ( Isolate *  isolate, SharedValueConveyor &&  conveyor  )

virtual

Called when the first shared value is serialized. All subsequent shared values will use the same conveyor.

The embedder must ensure the lifetime of the conveyor matches the lifetime of the serialized data.

If the embedder supports serializing shared values, this method should return true. Otherwise the embedder should throw an exception and return false.

This method is called at most once per serializer.

FreeBufferMemory()

virtual void v8::ValueSerializer::Delegate::FreeBufferMemory ( void *  buffer )

virtual

Frees a buffer allocated with |ReallocateBufferMemory|.

The default implementation uses the stdlib's free() function.

GetSharedArrayBufferId()

virtual Maybe< uint32_t > v8::ValueSerializer::Delegate::GetSharedArrayBufferId ( Isolate *  isolate, Local< SharedArrayBuffer >  shared_array_buffer  )

virtual

Called when the ValueSerializer is going to serialize a SharedArrayBuffer object. The embedder must return an ID for the object, using the same ID if this SharedArrayBuffer has already been serialized in this buffer. When deserializing, this ID will be passed to ValueDeserializer::GetSharedArrayBufferFromId as |clone_id|.

If the object cannot be serialized, an exception should be thrown and Nothing<uint32_t>() returned.

GetWasmModuleTransferId()

virtual Maybe< uint32_t > v8::ValueSerializer::Delegate::GetWasmModuleTransferId ( Isolate *  isolate, Local< WasmModuleObject >  module  )

virtual

HasCustomHostObject()

virtual bool v8::ValueSerializer::Delegate::HasCustomHostObject ( Isolate *  isolate )

virtual

The embedder overrides this method to enable custom host object filter with Delegate::IsHostObject.

This method is called at most once per serializer.

IsHostObject()

virtual Maybe< bool > v8::ValueSerializer::Delegate::IsHostObject ( Isolate *  isolate, Local< Object >  object  )

virtual

The embedder overrides this method to determine if an JS object is a host object and needs to be serialized by the host.

ReallocateBufferMemory()

virtual void * v8::ValueSerializer::Delegate::ReallocateBufferMemory ( void *  old_buffer, size_t  size, size_t *  actual_size  )

virtual

Allocates memory for the buffer of at least the size provided. The actual size (which may be greater or equal) is written to |actual_size|. If no buffer has been allocated yet, nullptr will be provided.

If the memory cannot be allocated, nullptr should be returned. |actual_size| will be ignored. It is assumed that |old_buffer| is still valid in this case and has not been modified.

The default implementation uses the stdlib's realloc() function.

ThrowDataCloneError()

virtual void v8::ValueSerializer::Delegate::ThrowDataCloneError ( Local< String >  message )

pure virtual

Handles the case where a DataCloneError would be thrown in the structured clone spec. Other V8 embedders may throw some other appropriate exception type.

WriteHostObject()

virtual Maybe< bool > v8::ValueSerializer::Delegate::WriteHostObject ( Isolate *  isolate, Local< Object >  object  )

virtual

The embedder overrides this method to write some kind of host object, if possible. If not, a suitable exception should be thrown and Nothing<bool>() returned.

---

The documentation for this class was generated from the following file:

• include/v8-value-serializer.h