Fawkes API
Fawkes Development Version
|
Worker thread for NetworkNameResolver. More...
#include <>>
Public Member Functions | |
NetworkNameResolverThread (NetworkNameResolver *resolver, AvahiThread *avahi_thread=NULL) | |
Constructor. More... | |
~NetworkNameResolverThread () | |
Destructor. More... | |
void | resolve_name (const std::string &name) |
Enqueue name for resolution. More... | |
void | resolve_address (struct sockaddr *addr, socklen_t addrlen) |
Enqueue address for resolution. More... | |
bool | resolve_name_immediately (const std::string &name, struct sockaddr **addr, socklen_t *addr_len) |
Immediately resolve a name. More... | |
bool | resolve_address_immediately (struct sockaddr *addr, std::string &name, bool &namefound) |
Immediately resolve address. More... | |
virtual void | resolved_name (char *name, struct sockaddr *addr, socklen_t addrlen) |
Name has been successfully resolved. More... | |
virtual void | resolved_address (struct sockaddr *addr, socklen_t addrlen, char *name) |
Address has been successfully resolved. More... | |
virtual void | name_resolution_failed (char *name) |
Name resolution failed. More... | |
virtual void | address_resolution_failed (struct sockaddr *addr, socklen_t addrlen) |
Address resolution failed. More... | |
virtual void | loop () |
Thread loop. More... | |
![]() | |
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... | |
Protected Member Functions | |
virtual void | run () |
Stub to see name in backtrace for easier debugging. More... | |
![]() | |
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 | |
![]() | |
enum | OpMode { OPMODE_CONTINUOUS, OPMODE_WAITFORWAKEUP } |
Thread operation mode. More... | |
enum | CancelState { CANCEL_ENABLED, CANCEL_DISABLED } |
Cancel state. More... | |
![]() | |
static Thread * | current_thread () |
Get the Thread instance of the currently running thread. More... | |
static Thread * | current_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 const unsigned int | FLAG_BAD = 0x00000001 |
Standard thread flag: "thread is bad". More... | |
![]() | |
bool | finalize_prepared |
True if prepare_finalize() has been called and was not stopped with a cancel_finalize(), false otherwise. More... | |
Mutex * | loop_mutex |
Mutex that is used to protect a call to loop(). More... | |
Mutex * | loopinterrupt_antistarve_mutex |
Mutex to avoid starvation when trying to lock loop_mutex. More... | |
Worker thread for NetworkNameResolver.
This thread does the work for the NetworkNameResolver. It runs concurrently to the rest of the software and executes name and address lookups in a non-blocking fashion.
This class should not be used directly, but NetworkNameResolver should be used instead.
Definition at line 52 of file resolver_thread.h.
fawkes::NetworkNameResolverThread::NetworkNameResolverThread | ( | NetworkNameResolver * | resolver, |
AvahiThread * | avahi_thread = NULL |
||
) |
Constructor.
Available only if Avahi is available at compile time.
resolver | network name resolver to call for results |
avahi_thread | Avahi thread, may be NULL in which case mDNS via Avahi is not used. |
Definition at line 62 of file resolver_thread.cpp.
fawkes::NetworkNameResolverThread::~NetworkNameResolverThread | ( | ) |
Destructor.
Definition at line 84 of file resolver_thread.cpp.
References fawkes::Mutex::lock(), and fawkes::Mutex::unlock().
|
virtual |
Address resolution failed.
The given address could not be resolved. Note that the parameter addr is given to the handler's ownership. This means especially that the handler is responsible for freeing the memory with free() after it is done with the variable.
addr | address whose lookup failed |
addrlen | length of address |
Definition at line 304 of file resolver_thread.cpp.
|
virtual |
Thread loop.
This will carry out all enqueued resolution operations.
Reimplemented from fawkes::Thread.
Definition at line 314 of file resolver_thread.cpp.
References fawkes::Mutex::lock(), fawkes::Thread::name(), resolve_address_immediately(), resolve_name_immediately(), fawkes::sock_addr_size(), and fawkes::Mutex::unlock().
|
virtual |
Name resolution failed.
The given hostname could not be resolved. Note that the parameter name is given to the handler's ownership. This means especially that the handler is responsible for freeing the memory with free() after it is done with the variable.
name | name whose lookup failed |
Definition at line 289 of file resolver_thread.cpp.
void fawkes::NetworkNameResolverThread::resolve_address | ( | struct sockaddr * | addr, |
socklen_t | addrlen | ||
) |
Enqueue address for resolution.
The address is enqueued and the resolver thread woken up. The result is reported to the resolver given to the constructor.
addr | address to resolve, must be a struct sockaddr |
addrlen | length of addr |
Definition at line 229 of file resolver_thread.cpp.
References fawkes::Mutex::lock(), fawkes::Mutex::unlock(), and fawkes::Thread::wakeup().
Referenced by fawkes::NetworkNameResolver::resolve_address().
bool fawkes::NetworkNameResolverThread::resolve_address_immediately | ( | struct sockaddr * | addr, |
std::string & | name, | ||
bool & | namefound | ||
) |
Immediately resolve address.
This tries to lookup the address with the getnameinfo(). If that fails a textual representation of the address is created. Additionally if an Avahi thread has
addr | pointer to a struct of type struct sockaddr with the address to lookup |
name | contains a newly allocated buffer upon successful return that you have to free after use using free(). |
namefound | true, if the name could be resolved, false if it was just transformed to a textual representation |
Definition at line 176 of file resolver_thread.cpp.
Referenced by loop().
void fawkes::NetworkNameResolverThread::resolve_name | ( | const std::string & | name | ) |
Enqueue name for resolution.
The name is enqueued and the resolver thread woken up. The result is reported to the resolver given to the constructor.
name | name to resolve |
Definition at line 209 of file resolver_thread.cpp.
References fawkes::Mutex::lock(), fawkes::Mutex::unlock(), and fawkes::Thread::wakeup().
Referenced by fawkes::NetworkNameResolver::resolve_name().
bool fawkes::NetworkNameResolverThread::resolve_name_immediately | ( | const std::string & | name, |
struct sockaddr ** | addr, | ||
socklen_t * | addr_len | ||
) |
Immediately resolve a name.
This tries to lookup a name with the getaddrinfo() and if the name ends with .local (the host is in the .local domain) and an Avahi thread has been supplied Avahi is used to lookup the hostname as well, but this does not happen immediately because this can take some time.
name | host name to lookup |
addr | upon return and success the address result will be stored here in a newly allocated buffer which you have to free after use using free(). |
addr_len | upon return and success contains the length of addr in bytes |
Definition at line 123 of file resolver_thread.cpp.
Referenced by loop(), and fawkes::NetworkNameResolver::resolve_name_blocking().
|
virtual |
Address has been successfully resolved.
The ordered name lookup was successful for the given address resulting in the given name. Note that all of the parameters are given to the handler's ownership, that means especially that the handler is responsible for freeing the associated memory after it is done with the result using free() on name and addr.
name | the resulting hostname |
addr | addr record, currently always of type struct sockaddr_in (only IPv4) |
addrlen | length of addr in bytes |
Definition at line 274 of file resolver_thread.cpp.
|
virtual |
Name has been successfully resolved.
The ordered name lookup was successful for the given name resulting in the given addr of addrlen bytes length. Note that all of the parameters are given to the handler's ownership, that means especially that the handler is responsible for freeing the associated memory after it is done with the result using free() on name and addr.
name | name that was resolved |
addr | resulting addr record, currently always of type struct sockaddr_in (only IPv4) |
addrlen | length of addr in bytes |
Definition at line 256 of file resolver_thread.cpp.
|
inlineprotectedvirtual |
Stub to see name in backtrace for easier debugging.
Reimplemented from fawkes::Thread.
Definition at line 75 of file resolver_thread.h.
References fawkes::Thread::run().