ej.trace

Class Tracer

java.lang.Object

ej.trace.Tracer

public class Tracer
extends java.lang.Object

Implements the natives of the library ej.api#trace and provides the same API as the Tracer class.

The aim is to be able to add events from the native world (in addition with the events added by the application and its libraries) like the application does with the foundation library API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Tracer.TracerService Indirection for the implementation.

Constructor Summary

Constructors

Constructor and Description
Tracer(java.lang.String name, int nbEventTypes) Creates a new tracer with the given name.

Method Summary

Modifier and Type	Method and Description
int	getGroupID() Gets the group identifier.
static boolean	isTraceStarted() Tests whether the trace system is started or not.
void	recordEvent(int eventId) Records an event for this Tracer.
void	recordEvent(int eventId, int... values) Records an event for this Tracer.
void	recordEvent(int eventId, int value1) Records an event for this Tracer.
void	recordEvent(int eventId, int value1, int value2) Records an event for this Tracer.
void	recordEvent(int eventId, int value1, int value2, int value3) Records an event for this Tracer.
void	recordEvent(int eventId, int value1, int value2, int value3, int value4) Records an event for this Tracer.
void	recordEvent(int eventId, int value1, int value2, int value3, int value4, int value5) Records an event for this Tracer.
void	recordEvent(int eventId, int value1, int value2, int value3, int value4, int value5, int value6) Records an event for this Tracer.
void	recordEvent(int eventId, int value1, int value2, int value3, int value4, int value5, int value6, int value7) Records an event for this Tracer.
void	recordEvent(int eventId, int value1, int value2, int value3, int value4, int value5, int value6, int value7, int value8) Records an event for this Tracer.
void	recordEvent(int eventId, int value1, int value2, int value3, int value4, int value5, int value6, int value7, int value8, int value9) Records an event for this Tracer.
void	recordEvent(int eventId, int value1, int value2, int value3, int value4, int value5, int value6, int value7, int value8, int value9, int value10) Records an event for this Tracer.
void	recordEventEnd(int eventId) Records the end of the execution of an event for this Tracer.
void	recordEventEnd(int eventId, int... values) Records the end of the execution of an event for this Tracer.
void	recordEventEnd(int eventId, int value1) Records the end of the execution of an event for this Tracer.
static void	recordEventEndNative(int groupId, int eventId) Record the end of the execution of an event.
static void	recordEventEndNative(int groupId, int eventId, int value1) Record the end of the execution of an event with one custom value.
static void	recordEventNative(int groupId, int eventId) Records an event.
static void	recordEventNative(int groupId, int eventId, int value1) Records an event with one custom value.
static void	recordEventNative(int groupId, int eventId, int value1, int value2) Records an event with several custom values.
static void	recordEventNative(int groupId, int eventId, int value1, int value2, int value3) Records an event with several custom values.
static void	recordEventNative(int groupId, int eventId, int value1, int value2, int value3, int value4) Records an event with several custom values.
static void	recordEventNative(int groupId, int eventId, int value1, int value2, int value3, int value4, int value5) Records an event with several custom values.
static void	recordEventNative(int groupId, int eventId, int value1, int value2, int value3, int value4, int value5, int value6) Records an event with several custom values.
static void	recordEventNative(int groupId, int eventId, int value1, int value2, int value3, int value4, int value5, int value6, int value7) Records an event with several custom values.
static void	recordEventNative(int groupId, int eventId, int value1, int value2, int value3, int value4, int value5, int value6, int value7, int value8) Records an event with several custom values.
static void	recordEventNative(int groupId, int eventId, int value1, int value2, int value3, int value4, int value5, int value6, int value7, int value8, int value9) Records an event with several custom values.
static void	recordEventNative(int groupId, int eventId, int value1, int value2, int value3, int value4, int value5, int value6, int value7, int value8, int value9, int value10) Records an event with several custom values.
static int	registerGroup(byte[] groupNameBuffer, int nbEventTypes) Register a group and returns the native identifier that identifies it.
static void	startTrace() Starts to record the events.
static void	stopTrace() Stops to record the events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Tracer

public Tracer(java.lang.String name,
              int nbEventTypes)
       throws java.lang.InternalError

Creates a new tracer with the given name. The created Tracer defines nbEventTypes types of events. The event identifiers available for this group are from 0 to nbEventTypes-1.

Parameters:

name - name that identifies the group. Must not be null

nbEventTypes - maximum number of event types available for the group

Throws:

java.lang.InternalError

Method Detail

startTrace

public static void startTrace()

Starts to record the events.

By default, the trace system is stopped.

stopTrace

public static void stopTrace()

Stops to record the events. When the record system is stopped, any call to the recordEvent(int) methods will not record any events.

By default, the trace system is stopped.

isTraceStarted

public static boolean isTraceStarted()

Tests whether the trace system is started or not.

Returns:

true if the trace system is started, false otherwise.

registerGroup

public static int registerGroup(byte[] groupNameBuffer,
                                int nbEventTypes)

Register a group and returns the native identifier that identifies it.

Parameters:

groupNameBuffer - name of the group. A null terminated string

nbEventTypes - maximum number of event ids for the registered group

Returns:

a new group id for the given name

recordEventNative

public static void recordEventNative(int groupId,
                                     int eventId)

Records an event.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

recordEventNative

public static void recordEventNative(int groupId,
                                     int eventId,
                                     int value1)

Records an event with one custom value.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

value1 - custom value for the event

recordEventNative

public static void recordEventNative(int groupId,
                                     int eventId,
                                     int value1,
                                     int value2)

Records an event with several custom values.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

recordEventNative

public static void recordEventNative(int groupId,
                                     int eventId,
                                     int value1,
                                     int value2,
                                     int value3)

Records an event with several custom values.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

recordEventNative

public static void recordEventNative(int groupId,
                                     int eventId,
                                     int value1,
                                     int value2,
                                     int value3,
                                     int value4)

Records an event with several custom values.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

recordEventNative

public static void recordEventNative(int groupId,
                                     int eventId,
                                     int value1,
                                     int value2,
                                     int value3,
                                     int value4,
                                     int value5)

Records an event with several custom values.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

recordEventNative

public static void recordEventNative(int groupId,
                                     int eventId,
                                     int value1,
                                     int value2,
                                     int value3,
                                     int value4,
                                     int value5,
                                     int value6)

Records an event with several custom values.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

value6 - custom value for the event

recordEventNative

public static void recordEventNative(int groupId,
                                     int eventId,
                                     int value1,
                                     int value2,
                                     int value3,
                                     int value4,
                                     int value5,
                                     int value6,
                                     int value7)

Records an event with several custom values.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

value6 - custom value for the event

value7 - custom value for the event

recordEventNative

public static void recordEventNative(int groupId,
                                     int eventId,
                                     int value1,
                                     int value2,
                                     int value3,
                                     int value4,
                                     int value5,
                                     int value6,
                                     int value7,
                                     int value8)

Records an event with several custom values.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

value6 - custom value for the event

value7 - custom value for the event

value8 - custom value for the event

recordEventNative

public static void recordEventNative(int groupId,
                                     int eventId,
                                     int value1,
                                     int value2,
                                     int value3,
                                     int value4,
                                     int value5,
                                     int value6,
                                     int value7,
                                     int value8,
                                     int value9)

Records an event with several custom values.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

value6 - custom value for the event

value7 - custom value for the event

value8 - custom value for the event

value9 - custom value for the event

recordEventNative

public static void recordEventNative(int groupId,
                                     int eventId,
                                     int value1,
                                     int value2,
                                     int value3,
                                     int value4,
                                     int value5,
                                     int value6,
                                     int value7,
                                     int value8,
                                     int value9,
                                     int value10)

Records an event with several custom values.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

value6 - custom value for the event

value7 - custom value for the event

value8 - custom value for the event

value9 - custom value for the event

value10 - custom value for the event

recordEventEndNative

public static void recordEventEndNative(int groupId,
                                        int eventId)

Record the end of the execution of an event.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

recordEventEndNative

public static void recordEventEndNative(int groupId,
                                        int eventId,
                                        int value1)

Record the end of the execution of an event with one custom value.

Parameters:

groupId - identifier of the group of events

eventId - identifier of the event

value1 - custom value for the event

getGroupID

public int getGroupID()

Gets the group identifier. This identifier is unique for each Tracer instance.

Returns:

the group unique identifier.

recordEvent

public void recordEvent(int eventId)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

recordEvent

public void recordEvent(int eventId,
                        int value1)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

value1 - custom value for the event

recordEvent

public void recordEvent(int eventId,
                        int value1,
                        int value2)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

recordEvent

public void recordEvent(int eventId,
                        int value1,
                        int value2,
                        int value3)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

recordEvent

public void recordEvent(int eventId,
                        int value1,
                        int value2,
                        int value3,
                        int value4)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

recordEvent

public void recordEvent(int eventId,
                        int value1,
                        int value2,
                        int value3,
                        int value4,
                        int value5)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

recordEvent

public void recordEvent(int eventId,
                        int value1,
                        int value2,
                        int value3,
                        int value4,
                        int value5,
                        int value6)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

value6 - custom value for the event

recordEvent

public void recordEvent(int eventId,
                        int value1,
                        int value2,
                        int value3,
                        int value4,
                        int value5,
                        int value6,
                        int value7)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

value6 - custom value for the event

value7 - custom value for the event

recordEvent

public void recordEvent(int eventId,
                        int value1,
                        int value2,
                        int value3,
                        int value4,
                        int value5,
                        int value6,
                        int value7,
                        int value8)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

value6 - custom value for the event

value7 - custom value for the event

value8 - custom value for the event

recordEvent

public void recordEvent(int eventId,
                        int value1,
                        int value2,
                        int value3,
                        int value4,
                        int value5,
                        int value6,
                        int value7,
                        int value8,
                        int value9)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

value6 - custom value for the event

value7 - custom value for the event

value8 - custom value for the event

value9 - custom value for the event

recordEvent

public void recordEvent(int eventId,
                        int value1,
                        int value2,
                        int value3,
                        int value4,
                        int value5,
                        int value6,
                        int value7,
                        int value8,
                        int value9,
                        int value10)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

value1 - custom value for the event

value2 - custom value for the event

value3 - custom value for the event

value4 - custom value for the event

value5 - custom value for the event

value6 - custom value for the event

value7 - custom value for the event

value8 - custom value for the event

value9 - custom value for the event

value10 - custom value for the event

recordEvent

public void recordEvent(int eventId,
                        int... values)

Records an event for this Tracer. The given event identifier must be valid for this Tracer (i.e. between 0 and nbEventTypes-1 included where nbEventTypes is the value given to the Tracer(String, int) constructor).

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - the event identifier

values - the event parameters

recordEventEnd

public void recordEventEnd(int eventId)

Records the end of the execution of an event for this Tracer. Call this method to trace the duration of an event previously record with one of the recordEvent(int) methods. This method should not be called for event that has no duration.

For example, if you want to trace the execution of a method, you can call recordEvent(int) at the beginning of the function and recordEventEnd(int) at the end of the function.

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

recordEventEnd

public void recordEventEnd(int eventId,
                           int value1)

Records the end of the execution of an event for this Tracer. Call this method to trace the duration of an event previously record with one of the recordEvent(int) methods. This method should not be called for event that has no duration.

For example, if you want to trace the execution of a method, you can call recordEvent(int) at the beginning of the function and recordEventEnd(int, int) at the end of the function.

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - identifier of the event

value1 - custom value for the event end.

recordEventEnd

public void recordEventEnd(int eventId,
                           int... values)

Records the end of the execution of an event for this Tracer. Call this method to trace the duration of an event previously record with one of the recordEvent(int) methods. This method should not be called for event that has no duration.

For example, if you want to trace the execution of a method, you can call recordEvent(int) at the beginning of the function and recordEventEnd(int) at the end of the function.

The record is done only if the trace system is started (see startTrace()).

Parameters:

eventId - the "end" event identifier

values - the "end" event parameters