Public Types | Public Member Functions | List of all members
ublox_gps::Worker Class Referenceabstract

Handles I/O reading and writing. More...

#include <worker.h>

Inheritance diagram for ublox_gps::Worker:
Inheritance graph
[legend]

Public Types

typedef boost::function< void(unsigned char *, std::size_t &)> Callback
 

Public Member Functions

virtual bool isOpen () const =0
 Whether or not the I/O stream is open. More...
 
virtual bool send (const unsigned char *data, const unsigned int size)=0
 Send the data in the buffer. More...
 
virtual void setCallback (const Callback &callback)=0
 Set the callback function for received messages. More...
 
virtual void setRawDataCallback (const Callback &callback)=0
 Set the callback function which handles raw data. More...
 
virtual void wait (const boost::posix_time::time_duration &timeout)=0
 Wait for an incoming message. More...
 
virtual ~Worker ()
 

Detailed Description

Handles I/O reading and writing.

Definition at line 40 of file worker.h.

Member Typedef Documentation

typedef boost::function<void(unsigned char*, std::size_t&)> ublox_gps::Worker::Callback

Definition at line 42 of file worker.h.

Constructor & Destructor Documentation

virtual ublox_gps::Worker::~Worker ( )
inlinevirtual

Definition at line 43 of file worker.h.

Member Function Documentation

virtual bool ublox_gps::Worker::isOpen ( ) const
pure virtual

Whether or not the I/O stream is open.

Implemented in ublox_gps::AsyncWorker< StreamT >.

virtual bool ublox_gps::Worker::send ( const unsigned char *  data,
const unsigned int  size 
)
pure virtual

Send the data in the buffer.

Parameters
datathe bytes to send
sizethe size of the buffer

Implemented in ublox_gps::AsyncWorker< StreamT >.

virtual void ublox_gps::Worker::setCallback ( const Callback callback)
pure virtual

Set the callback function for received messages.

Parameters
callbackthe callback function which process messages in the buffer

Implemented in ublox_gps::AsyncWorker< StreamT >.

virtual void ublox_gps::Worker::setRawDataCallback ( const Callback callback)
pure virtual

Set the callback function which handles raw data.

Parameters
callbackthe write callback which handles raw data

Implemented in ublox_gps::AsyncWorker< StreamT >.

virtual void ublox_gps::Worker::wait ( const boost::posix_time::time_duration &  timeout)
pure virtual

Wait for an incoming message.

Parameters
timeoutthe maximum time to wait.

Implemented in ublox_gps::AsyncWorker< StreamT >.


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


ublox_gps
Author(s): Johannes Meyer
autogenerated on Thu Jan 28 2021 03:13:52