NAME

DBGp::Client::Response - documentation for DBGp response objects

DESCRIPTION

Brief description of all possible response objects; they are thin wrappers around the XML returned by the DBGp client, you should refer to the DBGp protocol specification for the meaning of the various values.

Unless specified, the values returned by the various accessors is the raw value provided by the debugger.

All responses, except for "init", "stream" and notify have transaction_id and command accessors.

All response objects have an is_error accessor, which only returns true for error responses; is_internal_error returns true for error responses coming from the debugger (for example for a broken connection).

RESPONSES

init

Implemented by DBGp::Client::Response::Init. See also connection initialization in the DBGp spec.

Accessors:

fileuri

parent

idekey

thread

appid

protocol_version

hostname

language

error

Implemented by DBGp::Client::Response::Error. See also debugger engine errors in the DBGp spec.

Accessors:

code

apperr

message

status

Implemented by DBGp::Client::Response::Step. See also status in the DBGp spec.

Accessors:

reason

status

feature_get

Implemented by DBGp::Client::Response::FeatureGet. See also feature_get in the DBGp spec.

Accessors:

supported

feature

value

feature_set

Implemented by DBGp::Client::Response::FeatureSet. See also feature_set in the DBGp spec.

Accessors:

success

feature

run, step_into, step_over, step_out, stop,detach

Implemented by DBGp::Client::Response::Step. See also continuation commands in the DBGp spec.

Accessors:

reason

status

filename

Might or might not be present (Xdebug extension not in the specification)

lineno

Might or might not be present (Xdebug extension not in the specification)

breakpoint_set

Implemented by DBGp::Client::Response::BreakpointSet. See also breakpoint_set in the DBGp spec.

Accessors:

state

id

breakpoint_get

Implemented by DBGp::Client::Response::BreakpointGetUpdateRemove. See also breakpoint_get in the DBGp spec.

Accessors:

breakpoint

A "breakpoint" object (see below).

breakpoint_update

Implemented by DBGp::Client::Response::BreakpointGetUpdateRemove. See also breakpoint_get in the DBGp spec.

Accessors:

breakpoint

(Optional) A "breakpoint" object (see below). Not documented in the DBGp spec.

breakpoint_remove

Implemented by DBGp::Client::Response::BreakpointGetUpdateRemove. See also breakpoint_remove in the DBGp spec.

Accessors:

breakpoint

(Optional) A "breakpoint" object (see below).

breakpoint_list

Implemented by DBGp::Client::Response::BreakpointList. See also breakpoint_list in the DBGp spec.

Accessors:

breakpoints

An array of "breakpoint" objects (see below).

stack_depth

Implemented by DBGp::Client::Response::StackDepth. See also stack_depth in the DBGp spec.

Accessors:

depth

stack_get

Implemented by DBGp::Client::Response::StackGet. See also stack_get in the DBGp spec.

Accessors:

frames

An array of frame objects; each object has the following attributes:

level

type

filename

where

lineno

context_names

Implemented by DBGp::Client::Response::ContextNames. See also context_names in the DBGp spec.

Accessors:

contexts

An array of context objects; each object has the following attributes:

name

id

context_get

Implemented by DBGp::Client::Response::ContextGet. See also context_get in the DBGp spec.

Accessors:

context_id

values

An array of "property" objects (see below).

typemap_get

Implemented by DBGp::Client::Response::Typemap. See also typemap_get in the DBGp spec.

Accessors:

types

An array of type objects; each object has the following attributes:

type

name

xsi_type

property_get

Implemented by DBGp::Client::Response::PropertyGet. See also property_get, property_set, property_value in the DBGp spec.

Accessors:

property

A "property" object (see below).

property_set

Implemented by DBGp::Client::Response::PropertySet. See also property_get, property_set, property_value in the DBGp spec.

Accessors:

success

property_value

Implemented by DBGp::Client::Response::PropertyValue. See also property_get, property_set, property_value in the DBGp spec.

Accessors:

size

value

Decoded value string.

source

Implemented by DBGp::Client::Response::Source. See also source in the DBGp spec.

Accessors:

success

source

stdin, stdout, stderr

Implemented by DBGp::Client::Response::Redirect. See also stdout, stderr and stdin in the DBGp spec.

Accessors:

success

break

Implemented by DBGp::Client::Response::Break. See also break in the DBGp spec.

Accessors:

success

eval, expr, exec

Implemented by DBGp::Client::Response::Eval. See also eval in the DBGp spec.

Accessors:

success

result

An optional "property" object (see below).

interact

Implemented by DBGp::Client::Response::Interact. See also interact - interactive shell in the DBGp spec.

Accessors:

status

more

prompt

stream

Implemented by DBGp::Client::Response::Stream.

Accessors:

type

content

decoded content

notify

Implemented by DBGp::Client::Response::Notification. See also Notifications in the DBGp spec.

Accessors:

name

OTHER OBJECTS

Lists other objects that are part of the response object structure but are not response objects.

breakpoint

Implemented by DBGp::Client::Response::Breakpoint. See also breakpoints in the DBGp spec.

Accessors:

id

type

state

filename

lineno

function

exception

hit_value

hit_condition

hit_count

expression

temporary

property

Implemented by DBGp::Client::Response::Property. See also properties, variables and values in the DBGp spec.

Accessors:

name

fullname

constant

type

children

address

pagesize

page

classname

key

facet

numchildren

It always returns 0 unless children is true

value

The decoded value of scalar properties (typically useful when children is false).

childs

Array of DBGp::Client::Response::Property objects. Returns an empty array unless children is true).

AUTHOR

Mattia Barbon <mbarbon@cpan.org>

LICENSE

Copyright (c) 2015 Mattia Barbon. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

cpanm DBGp::Client

perl -MCPAN -e shell
install DBGp::Client