V8 API Reference Guide for node.js v9.10.0 - v9.11.1
Public Types | Public Member Functions | List of all members
v8::SnapshotCreator Class Reference

#include <v8.h>

Public Types

enum  FunctionCodeHandling { kClear, kKeep }
 

Public Member Functions

 SnapshotCreator (const intptr_t *external_references=nullptr, StartupData *existing_blob=nullptr)
 
IsolateGetIsolate ()
 
void SetDefaultContext (Local< Context > context, SerializeInternalFieldsCallback callback=SerializeInternalFieldsCallback())
 
size_t AddContext (Local< Context > context, SerializeInternalFieldsCallback callback=SerializeInternalFieldsCallback())
 
size_t AddTemplate (Local< Template > template_obj)
 
StartupData CreateBlob (FunctionCodeHandling function_code_handling)
 
 SnapshotCreator (const SnapshotCreator &)=delete
 
void operator= (const SnapshotCreator &)=delete
 

Detailed Description

Helper class to create a snapshot data blob.

Constructor & Destructor Documentation

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

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_blobexisting snapshot from which to create this one.
external_referencesa null-terminated array of external references that must be equivalent to CreateParams::external_references.

Member Function Documentation

size_t v8::SnapshotCreator::AddContext ( Local< Context context,
SerializeInternalFieldsCallback  callback = SerializeInternalFieldsCallback() 
)

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

Parameters
callbackoptional callback to serialize internal fields.
Returns
the index of the context in the snapshot blob.
size_t v8::SnapshotCreator::AddTemplate ( Local< Template template_obj)

Add a template to be included in the snapshot blob.

Returns
the index of the template in the snapshot blob.
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_handlingwhether 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.
Isolate* v8::SnapshotCreator::GetIsolate ( )
Returns
the isolate prepared by the snapshot creator.
void v8::SnapshotCreator::SetDefaultContext ( Local< Context context,
SerializeInternalFieldsCallback  callback = SerializeInternalFieldsCallback() 
)

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
callbackoptional callback to serialize internal fields.

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