Fawkes API  Fawkes Development Version
fawkes::AvahiThread Class Reference

Avahi main thread. More...

#include <netcomm/dns-sd/avahi_thread.h>

Inheritance diagram for fawkes::AvahiThread:

Public Member Functions

 AvahiThread (bool enable_ipv4=true, bool enable_ipv6=true)
 Constructor. More...
 
 ~AvahiThread ()
 Destructor. More...
 
void wait_initialized ()
 Waits for the AvahiThread to be initialized. More...
 
virtual void loop ()
 Avahi thread loop. More...
 
void publish_service (NetworkService *service)
 Publish service. More...
 
void unpublish_service (NetworkService *service)
 Revoke service publication. More...
 
void watch_service (const char *service_type, ServiceBrowseHandler *h)
 Add a result handler. More...
 
void unwatch_service (const char *service_type, ServiceBrowseHandler *h)
 Remove a handler. More...
 
void resolve_name (const char *name, AvahiResolverHandler *handler)
 Order name resolution. More...
 
void resolve_address (struct sockaddr *addr, socklen_t addrlen, AvahiResolverHandler *handler)
 Order address resolution. More...
 
- Public Member Functions inherited from fawkes::Thread
virtual ~Thread ()
 Virtual destructor. More...
 
virtual void init ()
 Initialize the thread. More...
 
bool prepare_finalize ()
 Prepare finalization. More...
 
virtual bool prepare_finalize_user ()
 Prepare finalization user implementation. More...
 
virtual void finalize ()
 Finalize the thread. More...
 
void cancel_finalize ()
 Cancel finalization. More...
 
void start (bool wait=true)
 Call this method to start the thread. More...
 
void cancel ()
 Cancel a thread. More...
 
void join ()
 Join the thread. More...
 
void detach ()
 Detach the thread. More...
 
void kill (int sig)
 Send signal to a thread. More...
 
bool operator== (const Thread &thread)
 Check if two threads are the same. More...
 
void wakeup ()
 Wake up thread. More...
 
void wakeup (Barrier *barrier)
 Wake up thread and wait for barrier afterwards. More...
 
void wait_loop_done ()
 Wait for the current loop iteration to finish. More...
 
OpMode opmode () const
 Get operation mode. More...
 
pthread_t thread_id () const
 Get ID of thread. More...
 
bool started () const
 Check if thread has been started. More...
 
bool cancelled () const
 Check if thread has been cancelled. More...
 
bool detached () const
 Check if thread has been detached. More...
 
bool running () const
 Check if the thread is running. More...
 
bool waiting () const
 Check if thread is currently waiting for wakeup. More...
 
const char * name () const
 Get name of thread. More...
 
void set_flags (uint32_t flags)
 Set all flags in one go. More...
 
void set_flag (uint32_t flag)
 Set flag for the thread. More...
 
void unset_flag (uint32_t flag)
 Unset flag. More...
 
bool flagged_bad () const
 Check if FLAG_BAD was set. More...
 
void set_delete_on_exit (bool del)
 Set whether the thread should be deleted on exit. More...
 
void set_prepfin_hold (bool hold)
 Hold prepare_finalize(). More...
 
void add_notification_listener (ThreadNotificationListener *notification_listener)
 Add notification listener. More...
 
void remove_notification_listener (ThreadNotificationListener *notification_listener)
 Remove notification listener. More...
 
void notify_of_failed_init ()
 Notify of failed init. More...
 
- Public Member Functions inherited from fawkes::ServicePublisher
virtual ~ServicePublisher ()
 Virtual empty destructor. More...
 
- Public Member Functions inherited from fawkes::ServiceBrowser
virtual ~ServiceBrowser ()
 Virtual empty destructor. More...
 

Protected Member Functions

virtual void run ()
 Stub to see name in backtrace for easier debugging. More...
 
- Protected Member Functions inherited from fawkes::Thread
 Thread (const char *name)
 Constructor. More...
 
 Thread (const char *name, OpMode op_mode)
 Constructor. More...
 
void exit ()
 Exit the thread. More...
 
void test_cancel ()
 Set cancellation point. More...
 
void yield ()
 Yield the processor to another thread or process. More...
 
void set_opmode (OpMode op_mode)
 Set operation mode. More...
 
void set_prepfin_conc_loop (bool concurrent=true)
 Set concurrent execution of prepare_finalize() and loop(). More...
 
void set_coalesce_wakeups (bool coalesce=true)
 Set wakeup coalescing. More...
 
void set_name (const char *format,...)
 Set name of thread. More...
 
virtual void once ()
 Execute an action exactly once. More...
 
bool wakeup_pending ()
 Check if wakeups are pending. More...
 

Additional Inherited Members

- Public Types inherited from fawkes::Thread
enum  OpMode { OPMODE_CONTINUOUS, OPMODE_WAITFORWAKEUP }
 Thread operation mode. More...
 
enum  CancelState { CANCEL_ENABLED, CANCEL_DISABLED }
 Cancel state. More...
 
- Static Public Member Functions inherited from fawkes::Thread
static Threadcurrent_thread ()
 Get the Thread instance of the currently running thread. More...
 
static Threadcurrent_thread_noexc () throw ()
 Similar to current_thread, but does never throw an exception. More...
 
static pthread_t current_thread_id ()
 Get the ID of the currently running thread. More...
 
static void init_main ()
 Initialize Thread wrapper instance for main thread. More...
 
static void destroy_main ()
 Destroy main thread wrapper instance. More...
 
static void set_cancel_state (CancelState new_state, CancelState *old_state=0)
 Set the cancel state of the current thread. More...
 
- Static Public Attributes inherited from fawkes::Thread
static const unsigned int FLAG_BAD = 0x00000001
 Standard thread flag: "thread is bad". More...
 
- Protected Attributes inherited from fawkes::Thread
bool finalize_prepared
 True if prepare_finalize() has been called and was not stopped with a cancel_finalize(), false otherwise. More...
 
Mutexloop_mutex
 Mutex that is used to protect a call to loop(). More...
 
Mutexloopinterrupt_antistarve_mutex
 Mutex to avoid starvation when trying to lock loop_mutex. More...
 

Detailed Description

Avahi main thread.

This thread handles all tasks related to avahi. This is the single interaction point with the Avahi adapter.

Author
Tim Niemueller

Definition at line 54 of file avahi_thread.h.

Constructor & Destructor Documentation

◆ AvahiThread()

fawkes::AvahiThread::AvahiThread ( bool  enable_ipv4 = true,
bool  enable_ipv6 = true 
)

Constructor.

You can choose whether to announce IPv4 or IPv6 only or both. If you select both, new service will be created with the "unspecified" address family in Avahi, causing it to announce the service on all supported protocols (which may or may not include both).

Parameters
enable_ipv4enable IPv4 support
enable_ipv6enable IPv6 support

Definition at line 70 of file avahi_thread.cpp.

References fawkes::Thread::set_prepfin_conc_loop().

◆ ~AvahiThread()

fawkes::AvahiThread::~AvahiThread ( )

Destructor.

Definition at line 97 of file avahi_thread.cpp.

Member Function Documentation

◆ loop()

void fawkes::AvahiThread::loop ( )
virtual

Avahi thread loop.

The avahi thread calls the simple poll iterate to poll with an infinite timeout. This way the loop blocks until an event occurs.

Reimplemented from fawkes::Thread.

Definition at line 121 of file avahi_thread.cpp.

◆ publish_service()

void fawkes::AvahiThread::publish_service ( NetworkService service)
virtual

Publish service.

Parameters
serviceservice to publish.

Implements fawkes::ServicePublisher.

Definition at line 253 of file avahi_thread.cpp.

Referenced by fawkes::FawkesNetworkManager::FawkesNetworkManager().

◆ resolve_address()

void fawkes::AvahiThread::resolve_address ( struct sockaddr *  addr,
socklen_t  addrlen,
AvahiResolverHandler handler 
)

Order address resolution.

This initiates resolution of an address. The method immediately returns and will not wait for the result.

Parameters
addraddress to resolve
addrlenlength of addr in bytes
handlerhandler to call for the result

Definition at line 965 of file avahi_thread.cpp.

References fawkes::Exception::append(), fawkes::LockList< Type >::push_back_locked(), fawkes::LockList< Type >::remove_locked(), and fawkes::WaitCondition::wake_all().

◆ resolve_name()

void fawkes::AvahiThread::resolve_name ( const char *  name,
AvahiResolverHandler handler 
)

Order name resolution.

This initiates resolution of a name. The method immediately returns and will not wait for the result.

Parameters
namename to resolve.
handlerhandler to call for the result

Definition at line 904 of file avahi_thread.cpp.

References fawkes::Thread::name().

◆ run()

virtual void fawkes::AvahiThread::run ( )
inlineprotectedvirtual

Stub to see name in backtrace for easier debugging.

See also
Thread::run()

Reimplemented from fawkes::Thread.

Definition at line 81 of file avahi_thread.h.

References fawkes::Thread::run().

◆ unpublish_service()

◆ unwatch_service()

void fawkes::AvahiThread::unwatch_service ( const char *  service_type,
ServiceBrowseHandler h 
)
virtual

Remove a handler.

The handler is removed and no further events will be emitted to the handler.

Parameters
service_typeservice type to de-register the handler for
hthe handler

Implements fawkes::ServiceBrowser.

Definition at line 512 of file avahi_thread.cpp.

References fawkes::Thread::CANCEL_DISABLED, fawkes::LockMap< KeyType, ValueType, LessKey >::erase_locked(), fawkes::LockQueue< Type >::lock(), fawkes::Thread::name(), fawkes::LockQueue< Type >::push_locked(), fawkes::Thread::set_cancel_state(), fawkes::StringConversions::to_string(), and fawkes::LockQueue< Type >::unlock().

◆ wait_initialized()

void fawkes::AvahiThread::wait_initialized ( )

Waits for the AvahiThread to be initialized.

You can use this if you want to wait until the thread has been fully initialized and may be used. Since the happens in this thread it is in general not immediately ready after start(). This will block the calling thread until the AvahiThread has been initialized. This is done by waiting for a release of an initialization mutex.

Definition at line 1160 of file avahi_thread.cpp.

References fawkes::WaitCondition::wait().

◆ watch_service()

void fawkes::AvahiThread::watch_service ( const char *  service_type,
ServiceBrowseHandler h 
)
virtual

Add a result handler.

A handler is added for the given service type. A search is initiated for the given service and the given handler is called for added or removed services or if an error occurs.

Parameters
service_typestring of the service type
hThe ServiceBrowseHandler

Implements fawkes::ServiceBrowser.

Definition at line 496 of file avahi_thread.cpp.

References fawkes::LockQueue< Type >::push_locked().

Referenced by FuseViewerGtkWindow::FuseViewerGtkWindow(), and NetLogGuiGtkWindow::NetLogGuiGtkWindow().


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