dbus-cxx logo
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
DBus::Timeout Class Reference

Provides timeouts that can be armed/disarmed as necessary. More...

#include <timeout.h>

Public Types

typedef DBusCxxPointer< Timeoutpointer
 
typedef DBusCxxWeakPointer
< Timeout
weak_pointer
 

Public Member Functions

 ~Timeout ()
 
bool is_valid () const
 
 operator bool () const
 
int interval () const
 
bool is_enabled () const
 
bool handle ()
 
bool operator== (const Timeout &other) const
 
bool operator!= (const Timeout &other) const
 
void arm (bool should_arm=true)
 
bool is_armed ()
 
DBusTimeout * cobj ()
 
 operator DBusTimeout * ()
 

Static Public Member Functions

static pointer create (DBusTimeout *cobj=NULL)
 

Protected Member Functions

 Timeout (DBusTimeout *cobj=NULL)
 

Static Protected Member Functions

static void timer_callback_proxy (sigval_t sv)
 

Protected Attributes

DBusTimeout * m_cobj
 
timer_t m_timer_id
 
bool m_is_armed
 
pthread_mutex_t m_arming_mutex
 

Detailed Description

Provides timeouts that can be armed/disarmed as necessary.

Typically used by connections as requested by the underlying dbus library.

Author
Rick L Vinyard Jr rviny.nosp@m.ard@.nosp@m.cs.nm.nosp@m.su.e.nosp@m.du

Member Typedef Documentation

typedef DBusCxxPointer<Timeout> DBus::Timeout::pointer
typedef DBusCxxWeakPointer<Timeout> DBus::Timeout::weak_pointer

Constructor & Destructor Documentation

DBus::Timeout::Timeout ( DBusTimeout *  cobj = NULL)
protected

References m_arming_mutex, and m_cobj.

Referenced by create().

DBus::Timeout::~Timeout ( )

Member Function Documentation

void DBus::Timeout::arm ( bool  should_arm = true)
DBusTimeout * DBus::Timeout::cobj ( )

References m_cobj.

Timeout::pointer DBus::Timeout::create ( DBusTimeout *  cobj = NULL)
static
bool DBus::Timeout::handle ( )

References is_valid(), and m_cobj.

Referenced by timer_callback_proxy().

int DBus::Timeout::interval ( ) const

References is_valid(), and m_cobj.

Referenced by arm().

bool DBus::Timeout::is_armed ( )

References m_is_armed.

bool DBus::Timeout::is_enabled ( ) const

References is_valid(), and m_cobj.

bool DBus::Timeout::is_valid ( ) const

References m_cobj.

Referenced by handle(), interval(), is_enabled(), and timer_callback_proxy().

DBus::Timeout::operator bool ( ) const
DBus::Timeout::operator DBusTimeout * ( )
bool DBus::Timeout::operator!= ( const Timeout other) const

References m_cobj.

bool DBus::Timeout::operator== ( const Timeout other) const

References m_cobj.

void DBus::Timeout::timer_callback_proxy ( sigval_t  sv)
staticprotected

References handle(), and is_valid().

Referenced by arm().

Member Data Documentation

pthread_mutex_t DBus::Timeout::m_arming_mutex
protected

Referenced by arm(), Timeout(), and ~Timeout().

DBusTimeout* DBus::Timeout::m_cobj
protected
bool DBus::Timeout::m_is_armed
protected

Referenced by arm(), is_armed(), and ~Timeout().

timer_t DBus::Timeout::m_timer_id
protected

Referenced by arm(), and ~Timeout().


The documentation for this class was generated from the following files:

Generated on Sun Mar 19 2017 14:54:27 for dbus-cxx by doxygen 1.8.8