OCL::TCP::Datasender Class Reference

#include <datasender.hpp>

List of all members.

Public Member Functions

bool addSubscription (const std::string name)
bool addSubscription (const std::string name)
virtual bool breakloop ()
virtual bool breakloop ()
 Datasender (RTT::SocketMarshaller *marshaller, Socket *os)
 Datasender (RTT::SocketMarshaller *marshaller, Socket *os)
RTT::SocketMarshallergetMarshaller () const
RTT::SocketMarshallergetMarshaller () const
SocketgetSocket () const
SocketgetSocket () const
bool isValid () const
bool isValid () const
void listSubscriptions ()
void listSubscriptions ()
virtual void loop ()
virtual void loop ()
void remove ()
void remove ()
bool removeSubscription (const std::string &name)
bool removeSubscription (const std::string &name)
void serialize (const PropertyBag &v)
void serialize (const PropertyBag &v)
void setLimit (unsigned long long newlimit)
void setLimit (unsigned long long newlimit)
void silence (bool newstate)
void silence (bool newstate)
virtual ~Datasender ()
virtual ~Datasender ()

Private Member Functions

void checkbag (const PropertyBag &v)
void checkbag (const PropertyBag &v)
void writeOut (const PropertyBag &v)
void writeOut (base::PropertyBase *v)
void writeOut (const PropertyBag &v)
void writeOut (base::PropertyBase *v)

Private Attributes

unsigned long long curframe
TcpReportingInterpreterinterpreter
unsigned long long limit
os::Mutex lock
RTT::SocketMarshallermarshaller
Socketos
OCL::TcpReportingreporter
bool silenced
std::vector< std::string > subscriptions

Detailed Description

This class manages the connection with one single client. It is responsible for sending data to the client and managing the state of the client.

It has a thread responsible for reading data from the socket.

Definition at line 59 of file install/include/orocos/ocl/datasender.hpp.


Constructor & Destructor Documentation

OCL::TCP::Datasender::Datasender ( RTT::SocketMarshaller marshaller,
Socket os 
)
OCL::TCP::Datasender::~Datasender (  )  [virtual]

Definition at line 54 of file datasender.cpp.

OCL::TCP::Datasender::Datasender ( RTT::SocketMarshaller marshaller,
Socket os 
)
virtual OCL::TCP::Datasender::~Datasender (  )  [virtual]

Member Function Documentation

bool OCL::TCP::Datasender::addSubscription ( const std::string  name  ) 
bool OCL::TCP::Datasender::addSubscription ( const std::string  name  ) 

Definition at line 92 of file datasender.cpp.

virtual bool OCL::TCP::Datasender::breakloop (  )  [virtual]

Try to finish this thread.

bool OCL::TCP::Datasender::breakloop (  )  [virtual]

Try to finish this thread.

Definition at line 71 of file datasender.cpp.

void OCL::TCP::Datasender::checkbag ( const PropertyBag &  v  )  [private]
void OCL::TCP::Datasender::checkbag ( const PropertyBag &  v  )  [private]

Definition at line 179 of file datasender.cpp.

RTT::SocketMarshaller* OCL::TCP::Datasender::getMarshaller (  )  const

Return the marshaller.

RTT::SocketMarshaller * OCL::TCP::Datasender::getMarshaller (  )  const

Return the marshaller.

Definition at line 77 of file datasender.cpp.

Socket& OCL::TCP::Datasender::getSocket (  )  const

Get socket associated with this datasender.

Socket & OCL::TCP::Datasender::getSocket (  )  const

Get socket associated with this datasender.

Definition at line 82 of file datasender.cpp.

bool OCL::TCP::Datasender::isValid (  )  const

Returns true if the connection of the datasender is valid, false otherwise.

bool OCL::TCP::Datasender::isValid (  )  const

Returns true if the connection of the datasender is valid, false otherwise.

Definition at line 87 of file datasender.cpp.

void OCL::TCP::Datasender::listSubscriptions (  ) 

Write a list of the current subscriptions to the socket.

void OCL::TCP::Datasender::listSubscriptions (  ) 

Write a list of the current subscriptions to the socket.

Definition at line 146 of file datasender.cpp.

virtual void OCL::TCP::Datasender::loop (  )  [virtual]

Data connection main loop

void OCL::TCP::Datasender::loop (  )  [virtual]

Data connection main loop

Definition at line 61 of file datasender.cpp.

void OCL::TCP::Datasender::remove (  ) 

Remove this connection

void OCL::TCP::Datasender::remove (  ) 

Remove this connection

Definition at line 121 of file datasender.cpp.

bool OCL::TCP::Datasender::removeSubscription ( const std::string &  name  ) 
bool OCL::TCP::Datasender::removeSubscription ( const std::string &  name  ) 

Definition at line 126 of file datasender.cpp.

void OCL::TCP::Datasender::serialize ( const PropertyBag &  v  ) 

Send data to the client.

void OCL::TCP::Datasender::serialize ( const PropertyBag &  v  ) 

Send data to the client.

Definition at line 207 of file datasender.cpp.

void OCL::TCP::Datasender::setLimit ( unsigned long long  newlimit  ) 

Only frames up to frame <newlimit> will be processed.

void OCL::TCP::Datasender::setLimit ( unsigned long long  newlimit  ) 

Only frames up to frame <newlimit> will be processed.

Definition at line 202 of file datasender.cpp.

void OCL::TCP::Datasender::silence ( bool  newstate  ) 

Disable/enable output of data

void OCL::TCP::Datasender::silence ( bool  newstate  ) 

Disable/enable output of data

Definition at line 197 of file datasender.cpp.

void OCL::TCP::Datasender::writeOut ( const PropertyBag &  v  )  [private]
void OCL::TCP::Datasender::writeOut ( base::PropertyBase *  v  )  [private]
void OCL::TCP::Datasender::writeOut ( const PropertyBag &  v  )  [private]

Definition at line 166 of file datasender.cpp.

void OCL::TCP::Datasender::writeOut ( base::PropertyBase *  v  )  [private]

Definition at line 154 of file datasender.cpp.


Member Data Documentation

unsigned long long OCL::TCP::Datasender::curframe [private]

Definition at line 71 of file install/include/orocos/ocl/datasender.hpp.

Definition at line 64 of file install/include/orocos/ocl/datasender.hpp.

unsigned long long OCL::TCP::Datasender::limit [private]

Definition at line 70 of file install/include/orocos/ocl/datasender.hpp.

os::Mutex OCL::TCP::Datasender::lock [private]

Definition at line 63 of file install/include/orocos/ocl/datasender.hpp.

Definition at line 73 of file install/include/orocos/ocl/datasender.hpp.

Definition at line 68 of file install/include/orocos/ocl/datasender.hpp.

Definition at line 69 of file install/include/orocos/ocl/datasender.hpp.

Definition at line 72 of file install/include/orocos/ocl/datasender.hpp.

std::vector< std::string > OCL::TCP::Datasender::subscriptions [private]

Definition at line 74 of file install/include/orocos/ocl/datasender.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


ocl
Author(s): OCL Development Team
autogenerated on Fri Jan 11 09:50:53 2013