boost.png (6897 bytes) Home Libraries People FAQ More
PrevUpHomeNext

Class sink_control

boost::stacktrack::sink_control — sink_control manages trace log files to record information gathered by the stacktrack system

Synopsis

#include <boost/stacktrack/control.hpp>

using namespace boost::stacktrack;

class sink_control {
public:
  // construct/copy/destruct
  sink_control();
  sink_control(const char *);
  ~sink_control();

  // public member functions
  int is_open() const;
  int cycle() const;
  std::string filename() const;
  long sequence() ;
  void close() ;
  void close_on_exit() ;
  void next_cycle() ;
  void logging_enable(int) ;
};

Description

sink_control construct/copy/destruct

  1. sink_control();
  2. sink_control(const char * name);

    create log file

    Parameters

    name

    filename for log file 

  3. ~sink_control();

sink_control public member functions

  1. int is_open() const;

    Returns: true if log is open 

  2. int cycle() const;

    Returns: current log cycle 

  3. std::string filename() const;

    Returns: filename of log 

  4. long sequence() ;

    Returns: current value of sequence counter 

  5. void close() ;

    close log file 

  6. void close_on_exit() ;

    close log file on exit ??? 

  7. void next_cycle() ;

    increment cylce (may open new log file) 

  8. void logging_enable(int stat) ;

    enables/disables event logging

Copyright © 2005 James Fowler
PrevUpHomeNext