class CCL::AppSafetyManager

Overview

#include <appsafetymanager.h>

class AppSafetyManager:
    public CCL::Object,
    public CCL::IdleClient,
    public CCL::IServiceNotification,
    public CCL::Singleton
{
public:
    // classes

    class PluginOptionsProvider;
    class ServiceOptionsProvider;

    // fields

    static CLASS_INTERFACE2 (ITimerTask, IServiceNotification, Object) protected const String kDiagnosticFolder;
    static const int kIdleDelay = 10000;
    SignalSink safetySink;
    UnknownList optionProviders;
    ServiceOptionsProvider* serviceOptionsProvider;
    PluginOptionsProvider* pluginOptionsProvider;
    UnknownList diagnosticProviders;

    // methods

    bool startup (bool forceDialog = false);
    void shutdown ();
    tresult runDiagnosticsUI () const;
    void addOptionProvider (ISafetyOptionProvider* provider);
    void addDiagnosticProvider (IDiagnosticDataProvider* provider);
    bool addDiagnosticProvider (IUnknown* provider);
    bool showDocumentSafetyOptions (Document* document = nullptr);
    void resetDocumentSafetyOptions (Document* document = nullptr);

    void getActiveSafetyOptions (
        Vector <SafetyOptionDescription>& options,
        IUnknown* context
    ) const;

    void getActiveSafetyOptionsText (String& options, IUnknown* context) const;
    void getDiagnosticsFolder (IUrl& folder) const;
    virtual void CCL_API notify (ISubject* subject, MessageRef msg);
    virtual void onIdleTimer ();

    virtual tresult CCL_API onServiceNotification (
        const IServiceDescription& description,
        int eventCode
    );

    void registerServiceStartupOptions (StringRef category);

    bool showAppSafetyOptions (
        StringRef description,
        ICrashReport* report = nullptr,
        IUnknownList* unstablePlugins = nullptr
    );

    void applyAppSafetyOptions ();
    void reportUnstablePlugins (IUnknownList& unstablePlugins) const;
};

Inherited Members

public:
    // typedefs

    typedef CStringRef MemberID;

    // enums

    enum EventCode;

    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;
    Unknown& operator = (const Unknown&);
    unsigned int getRetainCount () const;
    virtual Object*CCL_API revealObject (const void* moduleAddress) = 0;
    virtual void CCL_API addObserver (IObserver* observer) = 0;
    virtual void CCL_API removeObserver (IObserver* observer) = 0;
    virtual void CCL_API signal (MessageRef msg) = 0;
    virtual void CCL_API deferSignal (IMessage* msg) = 0;
    static ISubject void addObserver (IUnknown* unknown, IObserver* observer);
    static void removeObserver (IUnknown* unknown, IObserver* observer);
    virtual void CCL_API notify (ISubject* subject, MessageRef msg) = 0;

    static IObserver void notify (
        IUnknown* unknown,
        ISubject* subject,
        MessageRef msg
    );

    virtual const ITypeInfo&CCL_API getTypeInfo () const = 0;
    virtual tbool CCL_API getProperty (Variant& var, MemberID propertyId) const = 0;
    virtual tbool CCL_API setProperty (MemberID propertyId, const Variant& var) = 0;
    virtual tbool CCL_API getPropertyNames (IPropertyCollector& collector) const = 0;
    virtual tbool CCL_API invokeMethod (Variant& returnValue, MessageRef msg) = 0;
    DECLARE_BASE_CLASS (Object);
    virtual void CCL_API removeObserver (IObserver* observer);
    virtual void CCL_API signal (MessageRef msg);
    virtual void CCL_API deferSignal (IMessage* msg);
    virtual void deferChanged ();
    virtual void CCL_API notify (ISubject* subject, MessageRef msg);
    virtual bool equals (const Object& obj) const;
    virtual int compare (const Object& obj) const;
    virtual bool load (const Storage& storage);
    virtual bool save (const Storage& storage) const;
    virtual bool save (const OutputStorage& storage) const;
    virtual bool toString (String& string, int flags = 0) const;
    virtual int getHashCode (int size) const;
    IUnknown* asUnknown ();
    static void addGarbageCollected (Object* obj, bool globalScope = true);
    static void deferDestruction (Object* obj);
    static const void* getModuleAddress ();
    virtual void CCL_API onTimer (ITimer* timer) = 0;
    void startTimer (int64 delay = 0, bool periodic = true);
    void stopTimer ();
    bool isTimerEnabled () const;
    bool enableTimer (bool state);
    virtual void CCL_API onTimer (ITimer*);

    virtual tresult CCL_API onServiceNotification (
        const IServiceDescription& description,
        int eventCode
    ) = 0;

    static T& instance ();
    static T* peekInstance ();
    static Object* __createSingleton ();

Detailed Documentation

Methods

void addOptionProvider (ISafetyOptionProvider* provider)

Add a provider.

Takes ownership.

virtual void CCL_API notify (ISubject* subject, MessageRef msg)

Receive notification from subject.

virtual void onIdleTimer ()

override to perform the periodic action

virtual tresult CCL_API onServiceNotification (
    const IServiceDescription& description,
    int eventCode
)

Handle service notification.