V8
Public Member Functions | Static Public Member Functions | Friends | List of all members
v8::TryCatch Class Reference

#include <v8.h>

Public Member Functions

 TryCatch ()
 TryCatch (Isolate *isolate)
 ~TryCatch ()
bool HasCaught () const
bool CanContinue () const
bool HasTerminated () const
Handle< ValueReThrow ()
Local< ValueException () const
Local< ValueStackTrace () const
Local< v8::MessageMessage () const
void Reset ()
void SetVerbose (bool value)
void SetCaptureMessage (bool value)

Static Public Member Functions

static void * JSStackComparableAddress (v8::TryCatch *handler)

Friends

class v8::internal::Isolate

Detailed Description

An external exception handler.

Constructor & Destructor Documentation

v8::TryCatch::TryCatch ( )

Creates a new try/catch block and registers it with v8. Note that all TryCatch blocks should be stack allocated because the memory location itself is compared against JavaScript try/catch blocks.

v8::TryCatch::TryCatch ( Isolate isolate)

Creates a new try/catch block and registers it with v8. Note that all TryCatch blocks should be stack allocated because the memory location itself is compared against JavaScript try/catch blocks.

v8::TryCatch::~TryCatch ( )

Unregisters and deletes this try/catch block.

Member Function Documentation

bool v8::TryCatch::CanContinue ( ) const

For certain types of exceptions, it makes no sense to continue execution.

If CanContinue returns false, the correct action is to perform any C++ cleanup needed and then return. If CanContinue returns false and HasTerminated returns true, it is possible to call CancelTerminateExecution in order to continue calling into the engine.

Local<Value> v8::TryCatch::Exception ( ) const

Returns the exception caught by this try/catch block. If no exception has been caught an empty handle is returned.

The returned handle is valid until this TryCatch block has been destroyed.

bool v8::TryCatch::HasCaught ( ) const

Returns true if an exception has been caught by this try/catch block.

bool v8::TryCatch::HasTerminated ( ) const

Returns true if an exception has been caught due to script execution being terminated.

There is no JavaScript representation of an execution termination exception. Such exceptions are thrown when the TerminateExecution methods are called to terminate a long-running script.

If such an exception has been thrown, HasTerminated will return true, indicating that it is possible to call CancelTerminateExecution in order to continue calling into the engine.

static void* v8::TryCatch::JSStackComparableAddress ( v8::TryCatch handler)
inlinestatic

There are cases when the raw address of C++ TryCatch object cannot be used for comparisons with addresses into the JS stack. The cases are: 1) ARM, ARM64 and MIPS simulators which have separate JS stack. 2) Address sanitizer allocates local C++ object in the heap when UseAfterReturn mode is enabled. This method returns address that can be used for comparisons with addresses into the JS stack. When neither simulator nor ASAN's UseAfterReturn is enabled, then the address returned will be the address of the C++ try catch handler itself.

Local<v8::Message> v8::TryCatch::Message ( ) const

Returns the message associated with this exception. If there is no message associated an empty handle is returned.

The returned handle is valid until this TryCatch block has been destroyed.

void v8::TryCatch::Reset ( )

Clears any exceptions that may have been caught by this try/catch block. After this method has been called, HasCaught() will return false. Cancels the scheduled exception if it is caught and ReThrow() is not called before.

It is not necessary to clear a try/catch block before using it again; if another exception is thrown the previously caught exception will just be overwritten. However, it is often a good idea since it makes it easier to determine which operation threw a given exception.

Handle<Value> v8::TryCatch::ReThrow ( )

Throws the exception caught by this TryCatch in a way that avoids it being caught again by this same TryCatch. As with ThrowException it is illegal to execute any JavaScript operations after calling ReThrow; the caller must return immediately to where the exception is caught.

void v8::TryCatch::SetCaptureMessage ( bool  value)

Set whether or not this TryCatch should capture a Message object which holds source information about where the exception occurred. True by default.

void v8::TryCatch::SetVerbose ( bool  value)

Set verbosity of the external exception handler.

By default, exceptions that are caught by an external exception handler are not reported. Call SetVerbose with true on an external exception handler to have exceptions caught by the handler reported as if they were not caught.

Local<Value> v8::TryCatch::StackTrace ( ) const

Returns the .stack property of the thrown object. If no .stack property is present an empty handle is returned.


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