Public Member Functions | Protected Attributes | Private Attributes
OCL::TcpReporting Class Reference

A component which writes data reports to a tcp/ip socket. It can serve different clients. It uses a ASCI-based protocol. More...

#include <TcpReporting.hpp>

Inheritance diagram for OCL::TcpReporting:
Inheritance graph

List of all members.

Public Member Functions

bool configureHook ()
const RTT::PropertyBaggetReport ()
bool startHook ()
void stopHook ()
 TcpReporting (std::string fr_name="ReportingComponent")
 ~TcpReporting ()

Protected Attributes


Private Attributes

bool _finishing
unsigned int port
RTT::Property< unsigned int > port_prop

Detailed Description

A component which writes data reports to a tcp/ip socket. It can serve different clients. It uses a ASCI-based protocol.


Authentication of the client:

The server accepts different kinds of commands. Before these commands are available for the client, the client has to authenticate itself.

Getting Help:

The client can get the available commands

and the syntax for each command.

Getting a list of available data:

The client can get the names of all the available data.

Subscribe to Data:

The client has to send the server the names of the available data he wants to get. Only the subscribed data will be send to the client.

Unsubscribe to Data:

The client can cancel a subscription.

Getting a list of the subscriptions:

The client can ask for the subscriptions he has made.

Start/stop streaming the data:

The client can start and stop the streaming of the subscribed data.

Close the connection with the server:

The client can close the connection with the server.

When an error occures:

When an error occurs because of wrong syntax the server will answer with an error message.

The streaming data:

When the streaming is started the server will send the following message at each timeframe.

Definition at line 170 of file TcpReporting.hpp.

Constructor & Destructor Documentation

OCL::TcpReporting::TcpReporting ( std::string  fr_name = "ReportingComponent")

Create a reporting component which starts up a server

fr_nameName of the TCP reporting component.
portPort to listen on.

Definition at line 214 of file TcpReporting.cpp.

Definition at line 222 of file TcpReporting.cpp.

Member Function Documentation

Implementation of base::TaskCore::configureHook(). Calls load().

Reimplemented from OCL::ReportingComponent.

Definition at line 232 of file TcpReporting.cpp.

Return a property bag.

Definition at line 226 of file TcpReporting.cpp.

bool OCL::TcpReporting::startHook ( ) [virtual]

Reimplemented from OCL::ReportingComponent.

Definition at line 237 of file TcpReporting.cpp.

void OCL::TcpReporting::stopHook ( ) [virtual]

Reimplemented from OCL::ReportingComponent.

Definition at line 246 of file TcpReporting.cpp.

Member Data Documentation

Flag to indicate that shutdown() has been called and changes in the list of reported data should not be reported to the client anymore.

Definition at line 179 of file TcpReporting.hpp.


Definition at line 186 of file TcpReporting.hpp.

unsigned int OCL::TcpReporting::port [private]

Definition at line 180 of file TcpReporting.hpp.

Definition at line 181 of file TcpReporting.hpp.

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

Author(s): OCL Development Team
autogenerated on Sat Jun 8 2019 18:48:55