DPCL Class Reference

Chapter 12. Class ProbeHandle

Objects of this class represent identifying handles to installed point probes. Using these probe handles, your analysis tool can manipulate the installed point probes. For example, your analysis tool code will need a probe handle in order to:

• activate an installed point probe (so it will run when execution reaches its installed location in the code).
• deactivate an installed point probe (so it will not execute).
• remove an installed point probe.

Constructors

Synopsis

#include <ProbeHandle.h>
ProbeHandle(void);
ProbeHandle(const ProbeHandle &copy);

Parameters

copy

object to be duplicated in the copy constructor

Description

Two constructors are provided with this class; a default constructor and a copy constructor. The default constructor is able to create storage, marked initially as containing invalid probe handles, that may later be assigned or initialized through a probe installation.

The copy constructor performs a similar operation to assignment, but operates on an uninitialized object.

Exceptions

ASC_insufficient_memory

a memory allocation routine failed. Insufficient memory to create a new node.

See Also

Application::binstall_probe, Application::install_probe, Process::binstall_probe Process::install_probe.

get_expression

Synopsis

#include <ProbeHandle.h>
ProbeExp get_expression(void);

Description

Returns the original probe expression installed in the application process. Note that the expression returned is a copy, so alterations to the original after it has been installed will be not reflected in the expression returned by this function.

Return Values

Returns a copy of the probe expression installed in the application process.

See Also

Class ProbeExp

get_point

Synopsis

#include <ProbeHandle.h>
InstPoint get_point(void);

Description

Returns the original instrumentation point where the probe expression was installed in the application process.

Return Values

Returns the instrumentation point where the probe expression was installed in the application process.

See Also

Class InstPoint

operator =

Synopsis

#include <ProbeHandle.h>
ProbeHandle &operator = (const ProbeHandle &copy);

Parameters

copy

object to be duplicated in the assignment operator

Description

Assigns the value of the right operand to the invoking object. The left operand is the invoking object.

For example,

ProbeHandle rhs, lhs; ... lhs = rhs;

assigns the value of rhs to lhs. ProbeHandle objects would then contain the same value.

Return Values

Returns a reference to the invoking object.