Boost C++ Libraries Home Libraries People FAQ More
PrevUpHomeNext

Class template timed_generator

boost::signals::timed_generator — Creates its own thread and periodically sends a signal with the stored value.

Synopsis

template<typename Signature, typename OutSignal = unfused, 
         typename Combiner = boost::last_value<typename boost::function_traits<Signature>::result_type>, 
         typename Group = int, typename GroupCompare = std::less<Group> > 
class timed_generator : public boost::signals::storage< Signature, OutSignal, Combiner, Group, GroupCompare >
{
public:
  // construct/copy/destruct
  timed_generator();
  ~timed_generator();

  // public member functions
  void enable(double, unsigned = 0) ;
  void disable() ;
  void join() ;

  // private member functions
  void thread_function() ;
};

Description

timed_generator construct/copy/destruct

  1. timed_generator();
  2. ~timed_generator();

timed_generator public member functions

  1. void enable(double interval, unsigned signal_count = 0) ;

    Parameters:
    interval

    Sets the time interval (in seconds) at which the signal is sent.

    signal_count

    The signal will be sent signal_count times, or indefinitelly if signal_count==0. 

  2. void disable() ;
  3. void join() ;

timed_generator private member functions

  1. void thread_function() ;
Copyright © 2007 Stjepan Rajko
PrevUpHomeNext