Public Member Functions | Private Member Functions
industrial::ping_handler::PingHandler Class Reference

Message handler that handles ping messages. More...

#include <ping_handler.h>

Inheritance diagram for industrial::ping_handler::PingHandler:
Inheritance graph
[legend]

List of all members.

Public Member Functions

bool init (industrial::smpl_msg_connection::SmplMsgConnection *connection)
 Class initializer.
bool init (int msg_type, industrial::smpl_msg_connection::SmplMsgConnection *connection)
 Class initializer (Direct call to base class with the same name) I couldn't get the "using" form to work/.

Private Member Functions

bool internalCB (industrial::simple_message::SimpleMessage &in)
 Callback executed upon receiving a ping message.

Detailed Description

Message handler that handles ping messages.

Responds to ping message types. A ping is a simple message that is meant to test communications channels. A ping simply responds with a copy of the data it was sent.

THIS CLASS IS NOT THREAD-SAFE

Definition at line 66 of file ping_handler.h.


Member Function Documentation

Class initializer.

Parameters:
connectionsimple message connection that will be used to send replies.
Returns:
true on success, false otherwise (an invalid message type)

Definition at line 54 of file ping_handler.cpp.

Class initializer (Direct call to base class with the same name) I couldn't get the "using" form to work/.

Parameters:
connectionsimple message connection that will be used to send replies.
Returns:
true on success, false otherwise (an invalid message type)

Reimplemented from industrial::message_handler::MessageHandler.

Definition at line 87 of file ping_handler.h.

Callback executed upon receiving a ping message.

Parameters:
inincoming message
Returns:
true on success, false otherwise

Implements industrial::message_handler::MessageHandler.

Definition at line 59 of file ping_handler.cpp.


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


simple_message
Author(s): Shaun Edwards
autogenerated on Fri Jan 3 2014 11:26:56