---

CdbBdbObjectProfiler.hh

Go to the documentation of this file.

#ifndef CDBBDB_OBJECT_PROFILER_HH
#define CDBBDB_OBJECT_PROFILER_HH

// File and Version Information:
//      $Id: CdbBdbObjectProfiler.hh,v 1.2 2004/10/21 20:35:50 gapon Exp $

#include "CdbBase/CdbCommon.hh"

#include <oo.h>     // ooRef(ooObj), ooHandle(ooObj)

// Forward declarations

class CdbBdbObjectProfilerUserAction;
class CdbBdbObjectProfilerImpl;

/// This class provides "object profiler" facility for persistent objects.
/**
  * This facility uses the Objectivity/DB Active Schema API to navigate accross
  * an arbitrary graph of objects by visiting and profiling (collecting the object's
  * size satistic information for each node) and calling a user defined
  * action at each node. Each node is visited/profiled just once. A user defined action object
  * provides a feedback wether the profiling should propagate beyond a profiled
  * node or it should stop at this node or it should break profiling due to a error.
  * 
  * IMPLEMENTATION NOTES:
  *
  *   (1) This class uses PIMPL idiom to protect end users
  *       of the class from being exposed to the buggy header
  *       files of the Objectivity/DB Active Schema API.
  *
  *   (2) This class violates CDB API convention on the inclusion
  *       of "CdbBase/CdbCommon.hh" header file to avoid STD namespace
  *       conflicts of the kind described above.
  *
  * ATTENTION:
  *
  *   - This group of classes has nothing in common with the famous "Visitor"
  *     pattern ("Go4").
  */
class CdbBdbObjectProfiler {

private:

  /// Default constructor (NOT IMPLEMENTED)
  /**
    * There is no way to get the consistent object's context without user defined
    * parameters passed through the normal constructor.
    */
    CdbBdbObjectProfiler( );

public:

  /// Normal constructor
  /**
    * Sets the initial context for the profiling. This context can be reused
    * accross multiple calls to the profiling method itself.
    *
    * A non-zero pointer onto a user defined action is required.
    *
    * The ownership to a user action does not get transferred
    * into the current object. We may need non-const pointer to let a user
    * to maintain the context of user action between calls.
    *
    * Note, a user action object can be overriden by passing another user action
    * object by calling a special "setUserAction" method.
    */
    CdbBdbObjectProfiler( CdbBdbObjectProfilerUserAction* theUserAction,
                                                     bool verboseMode = false,
                                                     bool debugMode   = false );

  /// Destructor
  /**
    * More details...
    */
    virtual ~CdbBdbObjectProfiler( );

  /// Visit the specified object
  /**
    * The operation will return "true" in case of success, it will return "false"
    * in case of any errors.
    */
    bool profile( const ooHandle(ooObj)& theInputH );

  /// Set user action
  /**
    * If 0 pointer is passed then the current user action will be reset
    * and it will not be called anymore.
    *
    * The method will return a pointer onto the previous action (if any).
    *
    * @see class CdbBdbObjectProfilerUserAction
    */
    CdbBdbObjectProfilerUserAction* setUserAction( CdbBdbObjectProfilerUserAction* theUserAction );

  /// Get current size
  /**
    * This method will return the number of bytes found by the profiler
    * by the time of the current request get executed.
    */
    uint64 getSize( ) const;

  /// Get current number of top-level objects
  /**
    * This method will return the number of "top-level" objects (not counting duplicated ones)
    * processed by the profiler by the time of the current request get executed.
    *
    * NOTES:
    *
    *   - this procedure does NOT count "children" of composite "top-level" objects
    *   - it does NOT count those objects processed by a user defined action either
    */
    uint64 getTopObjects( ) const;

private:

  // Here is my implementation

    CdbBdbObjectProfilerImpl* _myImpl;
};

#endif  // CDBBDB_OBJECT_PROFILER_HH

---