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:

List of all members.

Public Member Functions
bool	configureHook ()
const RTT::PropertyBag *	getReport ()
bool	startHook ()
void	stopHook ()
	TcpReporting (std::string fr_name="ReportingComponent")
	~TcpReporting ()
Protected Attributes
RTT::SocketMarshaller *	fbody
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.

usage

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.

• Send:

  "VERSION 1.0\n" 

• Receive:
  • if succesfull:

    "101 OK\n" 

  • if failed:

    "106 not supported\n" 

Getting Help:

The client can get the available commands

• Send:

  "HELP\n" 

• Receive:

           "Use HELP <command>\n
            CommandName1\n
            CommandName2\n
            ...
            CommandNameN\n."
           

and the syntax for each command.

• Send:

  "HELP CommandName\n" 

• Receive:

           "Name: CommandName\n
            Usage: CommandName CommandSyntax\n"
           

Getting a list of available data:

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

• Send:

  "HEADERS\n" 

• Receive:

           "305 DataName1\n
            305 DataName2\n
            ...
            305 DataNameN\n
            306 End of list\n"
           

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.

• Send:

  "SUBSCRIBE DataNameX\n" 

• Receive:
  • if succesfull:

    "302 DataNameX\n" 

  • if failed:

    "301 DataNameX\n" 

Unsubscribe to Data:

The client can cancel a subscription.

• Send:

  "UNSUBSCRIBE DataNameX\n" 

• Receive:
  • if succesfull:

    "303 DataNameX\n" 

  • if failed:

    "304 DataNameX\n" 

Getting a list of the subscriptions:

The client can ask for the subscriptions he has made.

• Send:

  "SUBS\n" 

• Receive:

           "305 DataNameX1\n
            305 DataNameX2\n
            ...
            305 DataNameXN\n
            306 End of list\n"
           

Start/stop streaming the data:

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

• Send: -To start:

  "SILENCE OFF\n" 

  -To stop:

  "SILENCE ON\n" 

• Receive:

  "107 SILENCE ON/OFF\n" 

Close the connection with the server:

The client can close the connection with the server.

• Send:

  "QUIT\n" 

  or

  "EXIT\n" 

• Receive:

  "104 Bye Bye\n" 

When an error occures:

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

• Send: wrong command syntax
• Receive:

  "102 Syntax: CommandNameX CommandSyntaxX\n" 

The streaming data:

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

• Receive:

           "201 framenr --- begin of frame\n
            202 DataNameX1\n
            205 DataValueX1\n
            202 DataNameX2\n
            205 DataValueX2\n
            ...
            202 DataNameXN\n
            205 DataValueXN\n
            203 framenr --- end of frame\n"
           

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

Parameters:

fr_name	Name of the TCP reporting component.
port	Port to listen on.

Definition at line 214 of file TcpReporting.cpp.

OCL::TcpReporting::~TcpReporting

(

)

Definition at line 222 of file TcpReporting.cpp.

---

Member Function Documentation

bool OCL::TcpReporting::configureHook

(

)

[virtual]

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

Reimplemented from OCL::ReportingComponent.

Definition at line 232 of file TcpReporting.cpp.

const RTT::PropertyBag * OCL::TcpReporting::getReport

(

)

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

bool OCL::TcpReporting::_finishing [private]

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.

RTT::SocketMarshaller* OCL::TcpReporting::fbody [protected]

marsh::MarshallInterface

Definition at line 186 of file TcpReporting.hpp.

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

Definition at line 180 of file TcpReporting.hpp.

RTT::Property<unsigned int> OCL::TcpReporting::port_prop [private]

Definition at line 181 of file TcpReporting.hpp.

---

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

• TcpReporting.hpp
• TcpReporting.cpp