rlmm::basic_signal_handler< Lock > Struct Template Reference
[The Readline classes.]

#include <rlmm/signal_handler.hh>

Inheritance diagram for rlmm::basic_signal_handler< Lock >:

Inheritance graph
[legend]
Collaboration diagram for rlmm::basic_signal_handler< Lock >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<typename Lock>
struct rlmm::basic_signal_handler< Lock >

signal handler utility class

Signal handling for readline.

If signal handling is enabled, the signals, INT, QUIT, TERM, ALRM, TSTP, TTOU and possibly WINCH are caught and dealt with in readline. Note, that the signal handler isn't installed until the member function install is called.


Public Member Functions

void catch_siqwinch (bool ok)
void on ()
void off ()
virtual ~basic_signal_handler ()
bool is_on () const
bool catch_sigwinch () const
void cleanup ()
void reset ()

Static Public Member Functions

static void install ()
static void remove ()

Private Member Functions

 basic_signal_handler ()
 basic_signal_handler (const basic_signal_handler &o)
basic_signal_handleroperator= (const basic_signal_handler &o)

Friends

class singleton


Constructor & Destructor Documentation

template<typename Lock>
rlmm::basic_signal_handler< Lock >::basic_signal_handler  )  [inline, private]
 

Constructor.

template<typename Lock>
rlmm::basic_signal_handler< Lock >::basic_signal_handler const basic_signal_handler< Lock > &  o  )  [inline, private]
 

Constructor.

template<typename Lock>
rlmm::basic_signal_handler< Lock >::~basic_signal_handler  )  [inline, virtual]
 

DTOR.


Member Function Documentation

template<typename Lock>
bool rlmm::basic_signal_handler< Lock >::catch_sigwinch  )  const [inline]
 

Are we also catching SIGWINCH?

Returns:
true if SIGWINCH is caught.

template<typename Lock>
void rlmm::basic_signal_handler< Lock >::catch_siqwinch bool  ok  )  [inline]
 

Also catch SIG_SIGWINCH.

template<typename Lock>
void rlmm::basic_signal_handler< Lock >::cleanup  )  [inline]
 

Cleanup after a signal.

template<typename Lock>
static void rlmm::basic_signal_handler< Lock >::install  )  [inline, static]
 

Install signal handler.

template<typename Lock>
bool rlmm::basic_signal_handler< Lock >::is_on  )  const [inline]
 

Are we catching signals?

Returns:
true if signal handling is on

template<typename Lock>
void rlmm::basic_signal_handler< Lock >::off  )  [inline]
 

Turn off singal handling.

template<typename Lock>
void rlmm::basic_signal_handler< Lock >::on  )  [inline]
 

Turn on singal handling.

template<typename Lock>
basic_signal_handler& rlmm::basic_signal_handler< Lock >::operator= const basic_signal_handler< Lock > &  o  )  [inline, private]
 

Constructor.

template<typename Lock>
static void rlmm::basic_signal_handler< Lock >::remove  )  [inline, static]
 

Remove the signal handler.

template<typename Lock>
void rlmm::basic_signal_handler< Lock >::reset  )  [inline]
 

Reset signal handler after signal.


Friends And Related Function Documentation

template<typename Lock>
friend class singleton [friend]
 

Base class is a friend.


The documentation for this struct was generated from the following file:
Top of page
Last update Fri Aug 26 15:19:53 2005
Christian Holm
Created by DoxyGen 1.4.4