Fawkes API
Fawkes Development Version
|
Simple Fawkes network client. More...
#include <netcomm/fawkes/client.h>
Public Member Functions | |
FawkesNetworkClient () | |
Constructor. More... | |
FawkesNetworkClient (const char *host, unsigned short int port) | |
Constructor. More... | |
FawkesNetworkClient (unsigned int id, const char *host, unsigned short int port) | |
Constructor. More... | |
~FawkesNetworkClient () | |
Destructor. More... | |
void | connect () |
Connect to remote. More... | |
void | disconnect () |
Disconnect socket. More... | |
void | connect (const char *host, unsigned short int port) |
Connect to new ip and port, and set hostname. More... | |
void | connect (const char *hostname, const struct sockaddr *addr, socklen_t addrlen) |
Connect to specific endpoint. More... | |
void | connect (const char *hostname, const struct sockaddr_storage &addr) |
Connect to specific endpoint. More... | |
void | enqueue (FawkesNetworkMessage *message) |
Enqueue message to send. More... | |
void | enqueue_and_wait (FawkesNetworkMessage *message, unsigned int timeout_sec=15) |
Enqueue message to send and wait for answer. More... | |
void | wait (unsigned int component_id, unsigned int timeout_sec=15) |
Wait for messages for component ID. More... | |
void | wake (unsigned int component_id) |
Wake a waiting thread. More... | |
void | interrupt_connect () |
Interrupt connect(). More... | |
void | register_handler (FawkesNetworkClientHandler *handler, unsigned int component_id) |
Register handler. More... | |
void | deregister_handler (unsigned int component_id) |
Deregister handler. More... | |
bool | connected () const throw () |
Check if connection is alive. More... | |
bool | has_id () const |
Check whether the client has an id. More... | |
unsigned int | id () const |
Get the client's ID. More... | |
const char * | get_hostname () const |
Get the client's hostname. More... | |
Friends | |
class | FawkesNetworkClientSendThread |
class | FawkesNetworkClientRecvThread |
Simple Fawkes network client.
Allows access to a remote instance via the network. Encapsulates all needed interaction with the network.
fawkes::FawkesNetworkClient::FawkesNetworkClient | ( | ) |
Constructor.
Note, you cannot call the connect() without parameters the first time you establish an connection when using this ctor!
Definition at line 331 of file client.cpp.
fawkes::FawkesNetworkClient::FawkesNetworkClient | ( | const char * | host, |
unsigned short int | port | ||
) |
Constructor.
host | remote host to connect to. |
port | port to connect to. |
Definition at line 298 of file client.cpp.
fawkes::FawkesNetworkClient::FawkesNetworkClient | ( | unsigned int | id, |
const char * | host, | ||
unsigned short int | port | ||
) |
Constructor.
id | id of the client. |
host | remote host to connect to. |
port | port to connect to. |
Definition at line 365 of file client.cpp.
fawkes::FawkesNetworkClient::~FawkesNetworkClient | ( | ) |
Destructor.
Definition at line 396 of file client.cpp.
void fawkes::FawkesNetworkClient::connect | ( | ) |
Connect to remote.
SocketException | thrown by Socket::connect() |
NullPointerException | thrown if hostname has not been set |
Definition at line 417 of file client.cpp.
Referenced by LaserDeadSpotCalibrator::num_detected_spots(), fawkes::ServiceSelectorCBE::on_btn_connect_clicked(), fawkes::ServiceSelectorCBE::on_service_selected(), fawkes::RemoteBlackBoard::RemoteBlackBoard(), ConfigChangeWatcherTool::run(), fawkes::ServiceChooserDialog::run_and_connect(), fawkes::RemoteBlackBoard::try_aliveness_restore(), and NetLogGuiGtkWindow::~NetLogGuiGtkWindow().
void fawkes::FawkesNetworkClient::connect | ( | const char * | host, |
unsigned short int | port | ||
) |
Connect to new ip and port, and set hostname.
host | remote host name |
port | new port to connect to |
Definition at line 486 of file client.cpp.
void fawkes::FawkesNetworkClient::connect | ( | const char * | hostname, |
const struct sockaddr * | addr, | ||
socklen_t | addr_len | ||
) |
Connect to specific endpoint.
hostname | hostname, informational only and not used for connecting |
addr | sockaddr structure of specific endpoint to connect to |
addr_len | length of addr |
Definition at line 500 of file client.cpp.
void fawkes::FawkesNetworkClient::connect | ( | const char * | hostname, |
const struct sockaddr_storage & | addr | ||
) |
Connect to specific endpoint.
hostname | hostname, informational only and not used for connecting |
addr | sockaddr_storage structure of specific endpoint to connect to |
Definition at line 516 of file client.cpp.
bool fawkes::FawkesNetworkClient::connected | ( | ) | const | |
throw | ( | |||
) |
Check if connection is alive.
Definition at line 823 of file client.cpp.
Referenced by fawkes::LogView::clear(), fawkes::RemoteBlackBoard::close(), fawkes::RemoteBlackBoard::is_alive(), fawkes::NetworkConfiguration::NetworkConfiguration(), fawkes::ServiceSelectorCBE::on_btn_connect_clicked(), fawkes::ServiceSelectorCBE::on_service_selected(), fawkes::ConnectionDispatcher::operator bool(), fawkes::RemoteBlackBoard::RemoteBlackBoard(), fawkes::ServiceChooserDialog::run_and_connect(), fawkes::LogView::set_client(), fawkes::PluginTreeView::set_gconf_prefix(), fawkes::RemoteBlackBoard::try_aliveness_restore(), Bumblebee2CalibGtkWindow::~Bumblebee2CalibGtkWindow(), fawkes::LogView::~LogView(), NaoGuiGtkWindow::~NaoGuiGtkWindow(), NetLogGuiGtkWindow::~NetLogGuiGtkWindow(), and SkillGuiGtkWindow::~SkillGuiGtkWindow().
void fawkes::FawkesNetworkClient::deregister_handler | ( | unsigned int | component_id | ) |
Deregister handler.
Cannot be called while processing a message.
component_id | component ID |
Definition at line 665 of file client.cpp.
References fawkes::FawkesNetworkMessage::cid().
Referenced by fawkes::ConnectionDispatcher::set_cid(), fawkes::ConnectionDispatcher::set_client(), fawkes::PluginTreeView::~PluginTreeView(), and fawkes::RemoteBlackBoard::~RemoteBlackBoard().
void fawkes::FawkesNetworkClient::disconnect | ( | ) |
Disconnect socket.
Definition at line 529 of file client.cpp.
Referenced by fawkes::ServiceSelectorCBE::on_btn_connect_clicked(), fawkes::ServiceSelectorCBE::on_service_selected(), ConfigChangeWatcherTool::run(), Bumblebee2CalibGtkWindow::~Bumblebee2CalibGtkWindow(), NaoGuiGtkWindow::~NaoGuiGtkWindow(), NetLogGuiGtkWindow::~NetLogGuiGtkWindow(), fawkes::RemoteBlackBoard::~RemoteBlackBoard(), and SkillGuiGtkWindow::~SkillGuiGtkWindow().
void fawkes::FawkesNetworkClient::enqueue | ( | FawkesNetworkMessage * | message | ) |
Enqueue message to send.
This method takes ownership of the message. If you want to use the message after enqueing you must reference:
Without extra referencing the message may not be used after enqueuing.
message | message to send |
Definition at line 587 of file client.cpp.
Referenced by fawkes::LogView::clear(), fawkes::RemoteBlackBoard::close(), fawkes::RemoteBlackBoard::list(), fawkes::RemoteBlackBoard::list_all(), fawkes::BlackBoardInterfaceProxy::notify_of_data_change(), fawkes::LogView::set_client(), fawkes::PluginTreeView::set_gconf_prefix(), fawkes::BlackBoardInterfaceProxy::transmit(), fawkes::RemoteBlackBoard::try_aliveness_restore(), fawkes::LogView::~LogView(), and fawkes::PluginTreeView::~PluginTreeView().
void fawkes::FawkesNetworkClient::enqueue_and_wait | ( | FawkesNetworkMessage * | message, |
unsigned int | timeout_sec = 15 |
||
) |
Enqueue message to send and wait for answer.
It is guaranteed that an answer cannot be missed. However, if the component sends another message (which is not the answer to the query) this will also trigger the wait condition to be woken up. The component ID to wait for is taken from the message. This message also calls unref() on the message. If you want to use it after enqueuing make sure you ref() before calling this method.
message | message to send |
timeout_sec | timeout for the waiting operation in seconds, 0 to wait forever (warning, this may result in a deadlock!) |
Definition at line 605 of file client.cpp.
References fawkes::FawkesNetworkMessage::cid(), fawkes::Exception::Exception(), and fawkes::FawkesNetworkMessage::msgid().
const char * fawkes::FawkesNetworkClient::get_hostname | ( | ) | const |
Get the client's hostname.
Definition at line 856 of file client.cpp.
Referenced by Bumblebee2CalibGtkWindow::~Bumblebee2CalibGtkWindow(), NaoGuiGtkWindow::~NaoGuiGtkWindow(), and SkillGuiGtkWindow::~SkillGuiGtkWindow().
bool fawkes::FawkesNetworkClient::has_id | ( | ) | const |
Check whether the client has an id.
Definition at line 833 of file client.cpp.
unsigned int fawkes::FawkesNetworkClient::id | ( | ) | const |
Get the client's ID.
Definition at line 843 of file client.cpp.
References fawkes::Exception::Exception().
void fawkes::FawkesNetworkClient::interrupt_connect | ( | ) |
Interrupt connect().
This is for example handy to interrupt in connection_died() before a connection_established() event has been received.
Definition at line 566 of file client.cpp.
void fawkes::FawkesNetworkClient::register_handler | ( | FawkesNetworkClientHandler * | handler, |
unsigned int | component_id | ||
) |
Register handler.
Handlers are used to handle incoming packets. There may only be one handler per component! Cannot be called while processing a message.
handler | handler to register |
component_id | component ID to register the handler for. |
Definition at line 646 of file client.cpp.
References fawkes::HandlerAlreadyRegisteredException::HandlerAlreadyRegisteredException().
Referenced by fawkes::ConnectionDispatcher::ConnectionDispatcher(), fawkes::NetworkConfiguration::NetworkConfiguration(), fawkes::RemoteBlackBoard::RemoteBlackBoard(), fawkes::ConnectionDispatcher::set_cid(), and fawkes::ConnectionDispatcher::set_client().
void fawkes::FawkesNetworkClient::wait | ( | unsigned int | component_id, |
unsigned int | timeout_sec = 15 |
||
) |
Wait for messages for component ID.
This will wait for messages of the given component ID to arrive. The calling thread is blocked until messages are available.
component_id | component ID to monitor |
timeout_sec | timeout for the waiting operation in seconds, 0 to wait forever (warning, this may result in a deadlock!) |
Definition at line 780 of file client.cpp.
References fawkes::Exception::Exception().
void fawkes::FawkesNetworkClient::wake | ( | unsigned int | component_id | ) |
Wake a waiting thread.
This will wakeup all threads currently waiting for the specified component ID. This can be helpful to wake a sleeping thread if you received a signal.
component_id | component ID for threads to wake up |
Definition at line 808 of file client.cpp.