SFRTracer

Internal class to manage a tracer.

#include <SFRTracer.hpp>

class SFRTracer : public SFCInvoker;

SFMTYPEDEFCLASS(SFRTracer)

Inheritance diagram

Collaboration diagram

Description

The SFRTracer class is used in SophiaFramework internally.

Reference

Tracer

Member

Constructor/Destructor
SFRTracer( `Void` ) Constructor of the SFRTracer class.
~SFRTracer( `Void` ) Destructor of the SFRTracer class.

Public Functions
`SFCError`	RegisterTracer( `BehaviorType` behavior , `TracerEnum` trace ) Register the tracer.
`SFCError`	RegisterTracer( `SFCEventEnum` type , `BehaviorType` behavior , `TracerEnum` trace ) Register the tracer.
`SFCError`	RegisterTracer( `SFCEventEnum` type , `UInt16` p16 , `BehaviorType` behavior , `TracerEnum` trace ) Register the tracer.
`SFCError`	RegisterTracer( `SFCEventEnum` type , `UInt16` bgnP16 , `UInt16` endP16 , `BehaviorType` behavior , `TracerEnum` trace ) Register the tracer.
`SFCError`	RegisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType , `BehaviorType` behavior , `TracerEnum` trace ) Register the tracer.
`SFCError`	RegisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType , `UInt16` p16 , `BehaviorType` behavior , `TracerEnum` trace ) Register the tracer.
`SFCError`	RegisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType , `UInt16` bgnP16 , `UInt16` endP16 , `BehaviorType` behavior , `TracerEnum` trace ) Register the tracer.
`Void`	UnregisterTracer( `Void` ) Unregister the tracer.
`Void`	UnregisterTracer( `SFCEventEnum` type ) Unregister the tracer.
`Void`	UnregisterTracer( `SFCEventEnum` type , `UInt16` p16 ) Unregister the tracer.
`Void`	UnregisterTracer( `SFCEventEnum` type , `UInt16` bgnP16 , `UInt16` endP16 ) Unregister the tracer.
`Void`	UnregisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType ) Unregister the tracer.
`Void`	UnregisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType , `UInt16` p16 ) Unregister the tracer.
`Void`	UnregisterTracer( `SFCEventEnum` bgnType , `SFCEventEnum` endType , `UInt16` bgnP16 , `UInt16` endP16 ) Unregister the tracer.
`Bool`	Invoke( `SFXEventConstRef` event ) (inherits from SFCInvoker) Send an event.

Protected Functions
`TracerRecConstPtr`	SearchTracer( `SFXEventConstRef` event ) Search for the tracer that matches the specified event.

Types
TracerEnum Constant that represents the trace order.
TracerTraceMPP Type of the callback function.

SFRTracer::SFRTracer

Constructor of the SFRTracer class.

[ protected ]
SFRTracer(Void);

SFRTracer::~SFRTracer

Destructor of the SFRTracer class.

[ protected, virtual ]
~SFRTracer(Void);

SFRTracer::RegisterTracer

[ public ]
SFCError RegisterTracer(
    BehaviorType behavior   // flag to compare the status
    TracerEnum trace        // trace order
);

[ public ]
SFCError RegisterTracer(
    SFCEventEnum type       // event type
    BehaviorType behavior   // flag to compare the status
    TracerEnum trace        // trace order
);

[ public ]
SFCError RegisterTracer(
    SFCEventEnum type       // event type
    UInt16 p16              // the first argument
    BehaviorType behavior   // flag to compare the status
    TracerEnum trace        // trace order
);

[ public ]
SFCError RegisterTracer(
    SFCEventEnum type       // event type
    UInt16 bgnP16           // the beginning number of first argument
    UInt16 endP16           // the end number of first argument
    BehaviorType behavior   // flag to compare the status
    TracerEnum trace        // trace order
);

[ public ]
SFCError RegisterTracer(
    SFCEventEnum bgnType    // the beginning number of event
    SFCEventEnum endType    // the end number of event
    BehaviorType behavior   // flag to compare the status
    TracerEnum trace        // trace order
);

[ public ]
SFCError RegisterTracer(
    SFCEventEnum bgnType    // the beginning number of event
    SFCEventEnum endType    // the end number of event
    UInt16 p16              // the first argument
    BehaviorType behavior   // flag to compare the status
    TracerEnum trace        // trace order
);

[ public, virtual ]
SFCError RegisterTracer(
    SFCEventEnum bgnType    // the beginning number of event
    SFCEventEnum endType    // the end number of event
    UInt16 bgnP16           // the beginning number of first argument
    UInt16 endP16           // the end number of first argument
    BehaviorType behavior   // flag to compare the status
    TracerEnum trace        // trace order
);

Argument

compare

Specify which status flag of responder is used to compare with.

If BEHAVIOR_NONE is specified, all status flags are not used and an event is notified to the responder regardless of its status.

If TRACER_PROVIDE is specified, an event may be notified to other responders duplicately.

trace

TRACER_NONE, TRACER_FORWARD, TRACER_BACKWARD, or TRACER_FOCUS can be specified.

Detailed information on tracer constant: SFRTracer::TracerEnum

Return value

If succeeds: SFERR_NO_ERROR
If failed: Error code

Reference

SFRTracer::UnregisterTracer

SFRTracer::SearchTracer

Search for the tracer that matches the specified event.

[ protected, const ]
TracerRecConstPtr SearchTracer(
    SFXEventConstRef event   // event to search
);

SFRTracer::UnregisterTracer

Unregister the tracer.

[ public ]
Void UnregisterTracer(Void);

[ public ]
Void UnregisterTracer(
    SFCEventEnum type   // event type
);

[ public ]
Void UnregisterTracer(
    SFCEventEnum type   // event type
    UInt16 p16          // the first argument
);

[ public ]
Void UnregisterTracer(
    SFCEventEnum type   // event type
    UInt16 bgnP16       // the beginning number of first argument
    UInt16 endP16       // the end number of first argument
);

[ public ]
Void UnregisterTracer(
    SFCEventEnum bgnType   // the beginning number of event
    SFCEventEnum endType   // the end number of event
);

[ public ]
Void UnregisterTracer(
    SFCEventEnum bgnType   // the beginning number of event
    SFCEventEnum endType   // the end number of event
    UInt16 p16             // the first argument
);

[ public, virtual ]
Void UnregisterTracer(
    SFCEventEnum bgnType   // the beginning number of event
    SFCEventEnum endType   // the end number of event
    UInt16 bgnP16          // the beginning number of first argument
    UInt16 endP16          // the end number of first argument
);

Reference

SFRTracer::RegisterTracer

SFRTracer::TracerEnum

Constant that represents the trace order.

enum TracerEnum{
    TRACER_NONE                         = 0,
    TRACER_FORWARD,
    TRACER_BACKWARD,
    TRACER_FOCUS
};

Description

The following are constants for trace order:

TRACER_FORWARD	Notify an event from foreground to background responder.
TRACER_BACKWARD	Notify an event from background to foreground responder.
TRACER_FOCUS	Notify an event to the focused responder.
TRACER_NONE	Don't notify an event to any responder.

Reference

SFRTracer::RegisterTracer

SFRTracer::TracerRec

Structure that represents a tracer.

SFMTYPEDEFSTRUCT(TracerRec)
        friend  struct  TracerRec;
        struct TracerRec {
     SFCEventEnum                btype;
     SFCEventEnum                etype;
            UInt16                      bp16;
            UInt16                      ep16;
            BehaviorType                behavior;
            TracerTraceMPP              mpp;
            TracerRecPtr                next;
        };

SFRTracer::TracerTraceMPP

Type of the callback function.

typedef Bool(SFRTracer::* SFRTracer::TracerTraceMPP)(SFXEventConstRef event, TracerRecConstPtr tracer)