NetworkCommPort Class Reference

Interfaces to a machine over the internet, TCP/IP or UDP/IP. More...

#include <NetworkCommPort.h>

Inheritance diagram for NetworkCommPort:

Detailed Description

Interfaces to a machine over the internet, TCP/IP or UDP/IP.

You probably want to use UDP if you're sending high-frequency, full-state updates, and use TCP if you're sending low-frequency or partial-state updates.

Definition at line 14 of file NetworkCommPort.h.

List of all members.

Public Member Functions
	NetworkCommPort (const std::string &name)
virtual	~NetworkCommPort ()
	destructor, checks that sbuf has already been closed
virtual std::string	getClassName () const
	Returns the name of the class (aka its type).
virtual streambuf &	getReadStreambuf ()
	Returns a std::basic_streambuf, which is expected to implement the actual work.
virtual streambuf &	getWriteStreambuf ()
	Returns a std::basic_streambuf, which is expected to implement the actual work.
virtual bool	isWriteable ()
	Allows you to check whether the reference from getWriteStreambuf() is currently functional (if checking is supported!).
virtual bool	isReadable ()
	Allows you to check whether the reference from getReadStreambuf() is currently functional (if checking is supported!).
virtual bool	open ()
	activates the sbuf based on the current configuration settings
virtual bool	close ()
	closes sbuf
virtual void	plistValueChanged (const plist::PrimitiveBase &pl)
Public Attributes
plist::Primitive< std::string >	host
plist::Primitive< unsigned short >	port
plist::NamedEnumeration < Config::transports >	transport
plist::Primitive< bool >	server
plist::Primitive< bool >	verbose
plist::Primitive< bool >	block
Protected Member Functions
virtual void	connectionError (const std::string &msg, bool fatal)
	Displays message on stderr and if fatal is set, calls closeFD().
virtual bool	doOpen (bool dispError)
	attempts to make a connection, checking that the previous attempt wasn't too recent
virtual void	keepOpen ()
Protected Attributes
basic_netbuf< std::ios::char_type >	sbuf
IPaddr	curaddr
Config::transports	curtrans
unsigned int	openedCnt
CallbackThread	recon
Static Protected Attributes
static const std::string	autoRegisterNetworkCommPort = CommPort::getRegistry().registerType<NetworkCommPort>("NetworkCommPort")
	holds the class name, set via registration with the CommPort registry

Constructor & Destructor Documentation

NetworkCommPort ( const std::string & name ) [explicit]

Definition at line 16 of file NetworkCommPort.h.

virtual ~NetworkCommPort ( ) [virtual]

destructor, checks that sbuf has already been closed

Definition at line 32 of file NetworkCommPort.h.

Member Function Documentation

bool close ( ) [virtual]

closes sbuf

Implements CommPort.

Definition at line 91 of file NetworkCommPort.cc.

Referenced by connectionError(), and plistValueChanged().

virtual void connectionError	(	const std::string &	msg,
		bool	fatal
	)			`[protected, virtual]`

Displays message on stderr and if fatal is set, calls closeFD().

Definition at line 61 of file NetworkCommPort.h.

Referenced by doOpen(), and ~NetworkCommPort().

bool doOpen ( bool dispError ) [protected, virtual]

attempts to make a connection, checking that the previous attempt wasn't too recent

Definition at line 47 of file NetworkCommPort.cc.

Referenced by isReadable(), keepOpen(), and open().

virtual std::string getClassName ( ) const [virtual]

Returns the name of the class (aka its type).

Suggested implementation is to declare a static string member, set it to the result of calling the registry's registerType, and then return that member here

Implements CommPort.

Definition at line 37 of file NetworkCommPort.h.

Referenced by plistValueChanged().

virtual streambuf& getReadStreambuf ( ) [virtual]

Returns a std::basic_streambuf, which is expected to implement the actual work.

You can pass this to an istream to use the nice C++ style input and output, or you can call the streambuf functions directly. However, if you're going the latter route, probably easier to just call CommPort's own read() and write().

Depending on implementation, the streambuf this returns might be a different instance than getWriteStreambuf. If they are the same instance, then you could use an iostream instead of separate istream and ostream.

Implements CommPort.

Definition at line 39 of file NetworkCommPort.h.

virtual streambuf& getWriteStreambuf ( ) [virtual]

Returns a std::basic_streambuf, which is expected to implement the actual work.

You can pass this to an ostream to use the nice C++ style input and output, or you can call the streambuf functions directly. However, if you're going the latter route, probably easier to just call CommPort's own read() and write().

Depending on implementation, the streambuf this returns might be a different instance than getReadStreambuf. If they are the same instance, then you could use an iostream instead of separate istream and ostream.

Implements CommPort.

Definition at line 40 of file NetworkCommPort.h.

Referenced by Subscription< T >::closing(), Subscription< T >::doUnfreeze(), ImageSubscription::opened(), DepthSubscription::opened(), SensorSubscription::opened(), ImageSubscription::plistValueChanged(), DepthSubscription::plistValueChanged(), and Subscription< T >::requestFrame().