v8::SnapshotCreator Class Reference

#include <v8-snapshot.h>

Public Types
enum class	FunctionCodeHandling { kClear , kKeep }

Public Member Functions
	SnapshotCreator (Isolate *isolate, const intptr_t *external_references=nullptr, const StartupData *existing_blob=nullptr, bool owns_isolate=true)
	SnapshotCreator (const intptr_t *external_references=nullptr, const StartupData *existing_blob=nullptr)
	SnapshotCreator (const v8::Isolate::CreateParams &params)
	SnapshotCreator (v8::Isolate *isolate, const v8::Isolate::CreateParams &params)
	~SnapshotCreator ()
Isolate *	GetIsolate ()
void	SetDefaultContext (Local< Context > context, SerializeInternalFieldsCallback internal_fields_serializer=SerializeInternalFieldsCallback(), SerializeContextDataCallback context_data_serializer=SerializeContextDataCallback(), SerializeAPIWrapperCallback api_wrapper_serializer=SerializeAPIWrapperCallback())
size_t	AddContext (Local< Context > context, SerializeInternalFieldsCallback internal_fields_serializer=SerializeInternalFieldsCallback(), SerializeContextDataCallback context_data_serializer=SerializeContextDataCallback(), SerializeAPIWrapperCallback api_wrapper_serializer=SerializeAPIWrapperCallback())
template<class T >
size_t	AddData (Local< Context > context, Local< T > object)
template<class T >
size_t	AddData (Local< T > object)
StartupData	CreateBlob (FunctionCodeHandling function_code_handling)
	SnapshotCreator (const SnapshotCreator &)=delete
void	operator= (const SnapshotCreator &)=delete

Friends
class	internal::SnapshotCreatorImpl

Detailed Description

Helper class to create a snapshot data blob.

The Isolate used by a SnapshotCreator is owned by it, and will be entered and exited by the constructor and destructor, respectively; The destructor will also destroy the Isolate. Experimental language features, including those available by default, are not available while creating a snapshot.

Member Enumeration Documentation

FunctionCodeHandling

enum class v8::SnapshotCreator::FunctionCodeHandling

strong

Enumerator
kClear
kKeep

Constructor & Destructor Documentation

SnapshotCreator() [1/5]

v8::SnapshotCreator::SnapshotCreator ( Isolate *  isolate, const intptr_t *  external_references = nullptr, const StartupData *  existing_blob = nullptr, bool  owns_isolate = true  )

explicit

Initialize and enter an isolate, and set it up for serialization. The isolate is either created from scratch or from an existing snapshot. The caller keeps ownership of the argument snapshot.

Parameters

existing_blob	existing snapshot from which to create this one.
external_references	a null-terminated array of external references that must be equivalent to CreateParams::external_references.
owns_isolate	whether this SnapshotCreator should call v8::Isolate::Dispose() during its destructor.

SnapshotCreator() [2/5]

v8::SnapshotCreator::SnapshotCreator ( const intptr_t *  external_references = nullptr, const StartupData *  existing_blob = nullptr  )

explicit

Create and enter an isolate, and set it up for serialization. The isolate is either created from scratch or from an existing snapshot. The caller keeps ownership of the argument snapshot.

Parameters

existing_blob	existing snapshot from which to create this one.
external_references	a null-terminated array of external references that must be equivalent to CreateParams::external_references.

SnapshotCreator() [3/5]

v8::SnapshotCreator::SnapshotCreator ( const v8::Isolate::CreateParams &  params )

explicit

Creates an Isolate for serialization and enters it. The creator fully owns the Isolate and will invoke v8::Isolate::Dispose() during destruction.

Parameters

params

The parameters to initialize the Isolate for. Details: params.external_references are expected to be a null-terminated array of external references. params.existing_blob is an optional snapshot blob from which can be used to initialize the new blob.

SnapshotCreator() [4/5]

v8::SnapshotCreator::SnapshotCreator	(	v8::Isolate *	isolate,
		const v8::Isolate::CreateParams &	params
	)

Initializes an Isolate for serialization and enters it. The creator does not own the Isolate but merely initialize it properly.

Parameters

isolate	The isolate that was allocated by `Isolate::Allocate()~.
params	The parameters to initialize the Isolate for. Details: params.external_references are expected to be a null-terminated array of external references. params.existing_blob is an optional snapshot blob from which can be used to initialize the new blob.

~SnapshotCreator()

v8::SnapshotCreator::~SnapshotCreator

(

)

Destroy the snapshot creator, and exit and dispose of the Isolate associated with it.

SnapshotCreator() [5/5]

v8::SnapshotCreator::SnapshotCreator ( const SnapshotCreator &  )

delete

Member Function Documentation

AddContext()

size_t v8::SnapshotCreator::AddContext	(	Local< Context >	context,
		SerializeInternalFieldsCallback	internal_fields_serializer = SerializeInternalFieldsCallback(),
		SerializeContextDataCallback	context_data_serializer = SerializeContextDataCallback(),
		SerializeAPIWrapperCallback	api_wrapper_serializer = SerializeAPIWrapperCallback()
	)

Add additional context to be included in the snapshot blob. The snapshot will include the global proxy.

Parameters

internal_fields_serializer	Similar to internal_fields_serializer in SetDefaultContext() but only applies to the context being added.
context_data_serializer	Similar to context_data_serializer in SetDefaultContext() but only applies to the context being added.
api_wrapper_serializer	Similar to api_wrapper_serializer in SetDefaultContext() but only applies to the context being added.

AddData() [1/2]

template<class T >

size_t v8::SnapshotCreator::AddData ( Local< Context >  context, Local< T >  object  )

inline

Attach arbitrary V8::Data to the context snapshot, which can be retrieved via Context::GetDataFromSnapshotOnce after deserialization. This data does not survive when a new snapshot is created from an existing snapshot.

Returns

the index for retrieval.

AddData() [2/2]

template<class T >

size_t v8::SnapshotCreator::AddData ( Local< T >  object )

inline

Attach arbitrary V8::Data to the isolate snapshot, which can be retrieved via Isolate::GetDataFromSnapshotOnce after deserialization. This data does not survive when a new snapshot is created from an existing snapshot.

Returns

the index for retrieval.

CreateBlob()

StartupData v8::SnapshotCreator::CreateBlob

(

FunctionCodeHandling

function_code_handling

)

Created a snapshot data blob. This must not be called from within a handle scope.

Parameters

function_code_handling

whether to include compiled function code in the snapshot.

Returns

{ nullptr, 0 } on failure, and a startup snapshot on success. The caller acquires ownership of the data array in the return value.

GetIsolate()

Isolate * v8::SnapshotCreator::GetIsolate

(

)

Returns

the isolate prepared by the snapshot creator.

operator=()

void v8::SnapshotCreator::operator= ( const SnapshotCreator &  )

delete

SetDefaultContext()

void v8::SnapshotCreator::SetDefaultContext	(	Local< Context >	context,
		SerializeInternalFieldsCallback	internal_fields_serializer = SerializeInternalFieldsCallback(),
		SerializeContextDataCallback	context_data_serializer = SerializeContextDataCallback(),
		SerializeAPIWrapperCallback	api_wrapper_serializer = SerializeAPIWrapperCallback()
	)

Set the default context to be included in the snapshot blob. The snapshot will not contain the global proxy, and we expect one or a global object template to create one, to be provided upon deserialization.

Parameters

internal_fields_serializer	An optional callback used to serialize internal pointer fields set by v8::Object::SetAlignedPointerInInternalField().
context_data_serializer	An optional callback used to serialize context embedder data set by v8::Context::SetAlignedPointerInEmbedderData().
api_wrapper_serializer	An optional callback used to serialize API wrapper references set via v8::Object::Wrap().

Friends And Related Function Documentation

internal::SnapshotCreatorImpl

friend class internal::SnapshotCreatorImpl

friend

---

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

• include/v8-snapshot.h