v8  3.11.10(node0.8.28)
V8 is Google's open source JavaScript engine
Debug Class Reference

#include <v8-debug.h>

Data Structures

class  ClientData
 
class  EventDetails
 
class  Message
 

Public Types

typedef void(* EventCallback) (DebugEvent event, Handle< Object > exec_state, Handle< Object > event_data, Handle< Value > data)
 
typedef void(* EventCallback2) (const EventDetails &event_details)
 
typedef void(* MessageHandler) (const uint16_t *message, int length, ClientData *client_data)
 
typedef void(* MessageHandler2) (const Message &message)
 
typedef void(* HostDispatchHandler) ()
 
typedef void(* DebugMessageDispatchHandler) ()
 

Static Public Member Functions

static bool SetDebugEventListener (EventCallback that, Handle< Value > data=Handle< Value >())
 
static bool SetDebugEventListener2 (EventCallback2 that, Handle< Value > data=Handle< Value >())
 
static bool SetDebugEventListener (v8::Handle< v8::Object > that, Handle< Value > data=Handle< Value >())
 
static void DebugBreak (Isolate *isolate=NULL)
 
static void CancelDebugBreak (Isolate *isolate=NULL)
 
static void DebugBreakForCommand (ClientData *data=NULL, Isolate *isolate=NULL)
 
static void SetMessageHandler (MessageHandler handler, bool message_handler_thread=false)
 
static void SetMessageHandler2 (MessageHandler2 handler)
 
static void SendCommand (const uint16_t *command, int length, ClientData *client_data=NULL, Isolate *isolate=NULL)
 
static void SetHostDispatchHandler (HostDispatchHandler handler, int period=100)
 
static void SetDebugMessageDispatchHandler (DebugMessageDispatchHandler handler, bool provide_locker=false)
 
static Local< ValueCall (v8::Handle< v8::Function > fun, Handle< Value > data=Handle< Value >())
 
static Local< ValueGetMirror (v8::Handle< v8::Value > obj)
 
static bool EnableAgent (const char *name, int port, bool wait_for_connection=false)
 
static void DisableAgent ()
 
static void ProcessDebugMessages ()
 
static Local< ContextGetDebugContext ()
 

Detailed Description

Definition at line 84 of file v8-debug.h.

Member Typedef Documentation

typedef void(* DebugMessageDispatchHandler) ()

Callback function for the host to ensure debug messages are processed.

Definition at line 245 of file v8-debug.h.

typedef void(* EventCallback) (DebugEvent event, Handle< Object > exec_state, Handle< Object > event_data, Handle< Value > data)

Debug event callback function.

Parameters
eventthe type of the debug event that triggered the callback (enum DebugEvent)
exec_stateexecution state (JavaScript object)
event_dataevent specific data (JavaScript object)
datavalue passed by the user to SetDebugEventListener

Definition at line 197 of file v8-debug.h.

typedef void(* EventCallback2) (const EventDetails &event_details)

Debug event callback function.

Parameters
event_detailsobject providing information about the debug event

A EventCallback2 does not take possession of the event data, and must not rely on the data persisting after the handler returns.

Definition at line 210 of file v8-debug.h.

typedef void(* HostDispatchHandler) ()

Debug host dispatch callback function.

Definition at line 240 of file v8-debug.h.

typedef void(* MessageHandler) (const uint16_t *message, int length, ClientData *client_data)

Debug message callback function.

Parameters
messagethe debug message handler message object
lengthlength of the message
client_datathe data value passed when registering the message handler

A MessageHandler does not take possession of the message string, and must not rely on the data persisting after the handler returns.

This message handler is deprecated. Use MessageHandler2 instead.

Definition at line 224 of file v8-debug.h.

typedef void(* MessageHandler2) (const Message &message)

Debug message callback function.

Parameters
messagethe debug message handler message object

A MessageHandler does not take possession of the message data, and must not rely on the data persisting after the handler returns.

Definition at line 235 of file v8-debug.h.

Member Function Documentation

static Local<Value> Call ( v8::Handle< v8::Function fun,
Handle< Value data = HandleValue >() 
)
static

Run a JavaScript function in the debugger.

Parameters
funthe function to call
datapassed as second argument to the function With this call the debugger is entered and the function specified is called with the execution state as the first argument. This makes it possible to get access to information otherwise not available during normal JavaScript execution e.g. details on stack frames. Receiver of the function call will be the debugger context global object, however this is a subject to change. The following example shows a JavaScript function which when passed to v8::Debug::Call will return the current line of JavaScript execution.
function frame_source_line(exec_state) {
return exec_state.frame(0).sourceLine();
}
static void CancelDebugBreak ( Isolate isolate = NULL)
static
static void DebugBreak ( Isolate isolate = NULL)
static
static void DebugBreakForCommand ( ClientData data = NULL,
Isolate isolate = NULL 
)
static
static void DisableAgent ( )
static

Disable the V8 builtin debug agent. The TCP/IP connection will be closed.

static bool EnableAgent ( const char *  name,
int  port,
bool  wait_for_connection = false 
)
static

Enable the V8 builtin debug agent. The debugger agent will listen on the supplied TCP/IP port for remote debugger connection.

Parameters
namethe name of the embedding application
portthe TCP/IP port to listen on
wait_for_connectionwhether V8 should pause on a first statement allowing remote debugger to connect before anything interesting happened
static Local<Context> GetDebugContext ( )
static

Debugger is running in its own context which is entered while debugger messages are being dispatched. This is an explicit getter for this debugger context. Note that the content of the debugger context is subject to change.

static Local<Value> GetMirror ( v8::Handle< v8::Value obj)
static

Returns a mirror object for the given object.

static void ProcessDebugMessages ( )
static

Makes V8 process all pending debug messages.

From V8 point of view all debug messages come asynchronously (e.g. from remote debugger) but they all must be handled synchronously: V8 cannot do 2 things at one time so normal script execution must be interrupted for a while.

Generally when message arrives V8 may be in one of 3 states:

  1. V8 is running script; V8 will automatically interrupt and process all pending messages (however auto_break flag should be enabled);
  2. V8 is suspended on debug breakpoint; in this state V8 is dedicated to reading and processing debug messages;
  3. V8 is not running at all or has called some long-working C++ function; by default it means that processing of all debug messages will be deferred until V8 gets control again; however, embedding application may improve this by manually calling this method.

It makes sense to call this method whenever a new debug message arrived and V8 is not already running. Method v8::Debug::SetDebugMessageDispatchHandler should help with the former condition.

Technically this method in many senses is equivalent to executing empty script:

  1. It does nothing except for processing all pending debug messages.
  2. It should be invoked with the same precautions and from the same context as V8 script would be invoked from, because: a. with "evaluate" command it can do whatever normal script can do, including all native calls; b. no other thread should call V8 while this method is running (v8::Locker may be used here).

"Evaluate" debug command behavior currently is not specified in scope of this method.

static void SendCommand ( const uint16_t *  command,
int  length,
ClientData client_data = NULL,
Isolate isolate = NULL 
)
static
static bool SetDebugEventListener ( EventCallback  that,
Handle< Value data = HandleValue >() 
)
static
static bool SetDebugEventListener ( v8::Handle< v8::Object that,
Handle< Value data = HandleValue >() 
)
static
static bool SetDebugEventListener2 ( EventCallback2  that,
Handle< Value data = HandleValue >() 
)
static
static void SetDebugMessageDispatchHandler ( DebugMessageDispatchHandler  handler,
bool  provide_locker = false 
)
static

Register a callback function to be called when a debug message has been received and is ready to be processed. For the debug messages to be processed V8 needs to be entered, and in certain embedding scenarios this callback can be used to make sure V8 is entered for the debug message to be processed. Note that debug messages will only be processed if there is a V8 break. This can happen automatically by using the option –debugger-auto-break.

Parameters
provide_lockerrequires that V8 acquires v8::Locker for you before calling handler
static void SetHostDispatchHandler ( HostDispatchHandler  handler,
int  period = 100 
)
static
static void SetMessageHandler ( MessageHandler  handler,
bool  message_handler_thread = false 
)
static
static void SetMessageHandler2 ( MessageHandler2  handler)
static

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