forward declaration for PausableSignalHub More...
#include <PausableSignalHub.hh>
Inheritance diagram for utility::signals::PausableSignalHub< ReturnType, Signal >:
Public Types | |
| typedef Super::Size | Size |
 Public Types inherited from utility::signals::BufferedSignalHub< ReturnType, Signal > | |
| typedef Super::Size | Size |
| typedef std::vector< Signal > | Buffer |
| Public Types inherited from utility::signals::SignalHub< ReturnType, Signal > | |
| typedef platform::Size | Size |
Public Member Functions | |
| PausableSignalHub () | |
| default constructor More... | |
| ~PausableSignalHub () override=default | |
| default destructor More... | |
| void | pause () |
| "pause" by waiting for stdin after a signal is sent More... | |
| void | unpause () |
| do not wait for stdin after a signal is sent More... | |
| bool | pausing () const |
| will a pause occur after sending a signal? More... | |
| Public Member Functions inherited from utility::signals::BufferedSignalHub< ReturnType, Signal > | |
| BufferedSignalHub () | |
| default constructor More... | |
| ~BufferedSignalHub () override=default | |
| default destructor More... | |
| void | buffer () |
| block signals and buffer them for release upon unblocking More... | |
| void | unblock () override |
| allow signals to be sent and release any signals that were buffered More... | |
| bool | buffering () const |
| are signals being buffered? More... | |
| void | clear_buffer () |
| clear the buffer More... | |
| Size | buffer_size () const |
| number of signals left in the buffer More... | |
| Public Member Functions inherited from utility::signals::SignalHub< ReturnType, Signal > | |
| SignalHub () | |
| default constructor More... | |
| virtual | ~SignalHub () |
| default destructor More... | |
| void | operator() (Signal s) |
| send signal to all observers connected to the hub More... | |
| Size | size () const |
| number of connections to the hub More... | |
| void | block () |
| block signals from being sent More... | |
| bool | blocked () const |
| are signals blocked? More... | |
| void | clear () |
| clear all connections More... | |
| template<typename MemFn , typename Ptr > | |
| Link | connect (MemFn fn, Ptr ptr) |
| connect an observer's member function to this hub More... | |
| template<typename MemFn , typename Ptr > | |
| bool | disconnect (MemFn fn, Ptr ptr) |
| disconnect an observer's member function from this hub More... | |
| Size | receive_linkunits_from (SignalHub const &src) |
| transfer linkunits from source to this SignalHub More... | |
| Links | current_links () const |
| return a copy of the list of links currently being managed by this SignalHub More... | |
Protected Member Functions | |
| void | after_send () override |
| wait for stdin after sending a signal More... | |
| Protected Member Functions inherited from utility::signals::BufferedSignalHub< ReturnType, Signal > | |
| void | release_buffer () |
| release the signals in the buffer More... | |
| bool | signal_allowed (Signal const s) override |
| is signal allowed to be passed? More... | |
| Protected Member Functions inherited from utility::signals::SignalHub< ReturnType, Signal > | |
| virtual void | send_signal (Signal s) |
| send signal to all observers More... | |
| template<typename MemFn , typename Ptr > | |
| Link | connect (MemFn fn, Ptr ptr, LinkUnits &links) const |
| connect an observer's member function to the given LinkUnits More... | |
| template<typename MemFn , typename Ptr > | |
| bool | disconnect (MemFn fn, Ptr ptr, LinkUnits &links) const |
| disconnect an observer's member function from the given LinkUnits More... | |
| template<typename Functor > | |
| LinkUnits::iterator | find_connection (Functor f, LinkUnits &links) const |
| find a specific connection to this hub More... | |
| void | send (Signal s, LinkUnits &links) const |
| send signal to all links taking into account validity and local blocking More... | |
| void | invalidate_all (LinkUnits &links) const |
| invalidate and destroy internals of all links More... | |
| void | remove_invalid (LinkUnits &links) const |
| remove and destroy internals of invalid links More... | |
| void | deallocate (LinkUnit &lu) const |
| deallocate function stored in a LinkUnit More... | |
| LinkUnits & | linkunits () |
| returns the list of LinkUnits More... | |
Private Types | |
| typedef BufferedSignalHub< ReturnType, Signal > | Super |
Private Member Functions | |
| PausableSignalHub (PausableSignalHub const &rval) | |
| disallow copy constructor More... | |
| PausableSignalHub & | operator= (PausableSignalHub const &rval) |
| disallow copy assignment More... | |
Private Attributes | |
| bool | pausing_ |
| flag indicating blocked signals should be buffered More... | |
Additional Inherited Members | |
| Protected Types inherited from utility::signals::SignalHub< ReturnType, Signal > | |
| typedef boost::function1< ReturnType, Signal > | Function |
| typedef std::vector< LinkUnitOP > | LinkUnits |
| typedef std::vector< Link > | Links |
Detailed Description
template<typename ReturnType, typename Signal>
class utility::signals::PausableSignalHub< ReturnType, Signal >
forward declaration for PausableSignalHub
BufferedSignalHub capable of pausing and waiting for stdin.
When pause is set, a Signal that's passed in to the Hub will first be sent to all observers, and then afterwards the Hub will attempt to read from stdin, waiting for the user to press enter. Please see BufferedSignalHub documentation for other usage.
- Note
- If
#define BOINCpause behavior is non-operative.
- Warning
- PausableSignalHub objects are not copyable.
Member Typedef Documentation
◆ Size
template<typename ReturnType , typename Signal >
| typedef Super::Size utility::signals::PausableSignalHub< ReturnType, Signal >::Size |
◆ Super
template<typename ReturnType , typename Signal >
|
private |
Constructor & Destructor Documentation
◆ PausableSignalHub() [1/2]
template<typename ReturnType , typename Signal >
|
inline |
default constructor
◆ ~PausableSignalHub()
template<typename ReturnType , typename Signal >
|
inlineoverridedefault |
default destructor
◆ PausableSignalHub() [2/2]
template<typename ReturnType , typename Signal >
|
private |
disallow copy constructor
Member Function Documentation
◆ after_send()
template<typename ReturnType , typename Signal >
|
inlineoverrideprotectedvirtual |
wait for stdin after sending a signal
user presses enter to continue
- Returns
- true if successful, false otherwise
Reimplemented from utility::signals::SignalHub< ReturnType, Signal >.
References utility::io::ic::cin, utility::io::icstream::clear(), utility::io::oc::cout, and utility::signals::PausableSignalHub< ReturnType, Signal >::pausing_.
◆ operator=()
template<typename ReturnType , typename Signal >
|
private |
disallow copy assignment
◆ pause()
template<typename ReturnType , typename Signal >
|
inline |
"pause" by waiting for stdin after a signal is sent
References utility::signals::PausableSignalHub< ReturnType, Signal >::pausing_.
◆ pausing()
template<typename ReturnType , typename Signal >
|
inline |
will a pause occur after sending a signal?
References utility::signals::PausableSignalHub< ReturnType, Signal >::pausing_.
◆ unpause()
template<typename ReturnType , typename Signal >
|
inline |
do not wait for stdin after a signal is sent
References utility::signals::PausableSignalHub< ReturnType, Signal >::pausing_.
Member Data Documentation
◆ pausing_
template<typename ReturnType , typename Signal >
|
private |
flag indicating blocked signals should be buffered
Referenced by utility::signals::PausableSignalHub< ReturnType, Signal >::after_send(), utility::signals::PausableSignalHub< ReturnType, Signal >::pause(), utility::signals::PausableSignalHub< ReturnType, Signal >::pausing(), and utility::signals::PausableSignalHub< ReturnType, Signal >::unpause().
The documentation for this class was generated from the following files:
- src/utility/signals/PausableSignalHub.fwd.hh
- src/utility/signals/PausableSignalHub.hh
