scip2::Connection Class Reference

#include <connection.h>

Inheritance diagram for scip2::Connection:

Public Types
using	Ptr = std::shared_ptr< Connection >

Public Member Functions
	Connection ()
void	registerCloseCallback (CallbackClose cb)
void	registerConnectCallback (CallbackConnect cb)
void	registerReceiveCallback (CallbackReceive cb)
virtual void	send (const std::string &, CallbackSend=CallbackSend())=0
virtual void	spin ()=0
virtual void	startWatchdog (const boost::posix_time::time_duration &)=0
virtual void	stop ()=0

Protected Types
using	CallbackClose = boost::function< void(void)>
using	CallbackConnect = boost::function< void(void)>
using	CallbackReceive = boost::function< void(boost::asio::streambuf &, const boost::posix_time::ptime &)>
using	CallbackSend = boost::function< void(const boost::posix_time::ptime &)>

Protected Member Functions
void	close ()
void	connect ()
void	receive (boost::asio::streambuf &buf, const boost::posix_time::ptime &time_read)

Protected Attributes
CallbackClose	cb_close_
CallbackConnect	cb_connect_
CallbackReceive	cb_receive_

Friends
class	Protocol

Detailed Description

Definition at line 33 of file connection.h.

Member Typedef Documentation

CallbackClose

using scip2::Connection::CallbackClose = boost::function<void(void)>

protected

Definition at line 39 of file connection.h.

CallbackConnect

using scip2::Connection::CallbackConnect = boost::function<void(void)>

protected

Definition at line 38 of file connection.h.

CallbackReceive

using scip2::Connection::CallbackReceive = boost::function<void( boost::asio::streambuf&, const boost::posix_time::ptime&)>

protected

Definition at line 41 of file connection.h.

CallbackSend

using scip2::Connection::CallbackSend = boost::function<void( const boost::posix_time::ptime&)>

protected

Definition at line 43 of file connection.h.

Ptr

using scip2::Connection::Ptr = std::shared_ptr<Connection>

Definition at line 68 of file connection.h.

Constructor & Destructor Documentation

Connection()

scip2::Connection::Connection ( )

inline

Definition at line 87 of file connection.h.

Member Function Documentation

close()

void scip2::Connection::close ( )

inlineprotected

Definition at line 49 of file connection.h.

connect()

void scip2::Connection::connect ( )

inlineprotected

Definition at line 54 of file connection.h.

receive()

void scip2::Connection::receive ( boost::asio::streambuf &  buf, const boost::posix_time::ptime &  time_read  )

inlineprotected

Definition at line 59 of file connection.h.

registerCloseCallback()

void scip2::Connection::registerCloseCallback ( CallbackClose  cb )

inline

Definition at line 75 of file connection.h.

registerConnectCallback()

void scip2::Connection::registerConnectCallback ( CallbackConnect  cb )

inline

Definition at line 83 of file connection.h.

registerReceiveCallback()

void scip2::Connection::registerReceiveCallback ( CallbackReceive  cb )

inline

Definition at line 79 of file connection.h.

send()

virtual void scip2::Connection::send ( const std::string &  , CallbackSend  = CallbackSend()  )

pure virtual

Implemented in scip2::ConnectionTcp, and ConnectionDummy.

spin()

virtual void scip2::Connection::spin ( )

pure virtual

Implemented in ConnectionDummy, and scip2::ConnectionTcp.

startWatchdog()

virtual void scip2::Connection::startWatchdog ( const boost::posix_time::time_duration &  )

pure virtual

Implemented in scip2::ConnectionTcp, and ConnectionDummy.

stop()

virtual void scip2::Connection::stop ( )

pure virtual

Implemented in ConnectionDummy, and scip2::ConnectionTcp.

Friends And Related Function Documentation

Protocol

friend class Protocol

friend

Definition at line 35 of file connection.h.

Member Data Documentation

cb_close_

CallbackClose scip2::Connection::cb_close_

protected

Definition at line 46 of file connection.h.

cb_connect_

CallbackConnect scip2::Connection::cb_connect_

protected

Definition at line 45 of file connection.h.

cb_receive_

CallbackReceive scip2::Connection::cb_receive_

protected

Definition at line 47 of file connection.h.

---

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

• connection.h