osvr::connection::VrpnBasedConnection Class Reference

Inheritance diagram for osvr::connection::VrpnBasedConnection:

Public Types
enum	ConnectionType { VRPN_LOCAL_ONLY, VRPN_SHARED, VRPN_LOOPBACK }
Public Types inherited from osvr::connection::Connection
typedef std::vector < ConnectionDevicePtr >	DeviceList
typedef std::vector< std::string >	NameList
	Type of list of device names.

Public Member Functions
	VrpnBasedConnection (ConnectionType type)
	Constructor for the VRPN connection.
	VrpnBasedConnection (boost::optional< std::string const & > iface, boost::optional< int > port)
	Constructor for a (likely) shared VRPN connection specifying the interface to listen on as well as the port.
virtual void *	getUnderlyingObject ()
	Returns the vrpn_Connection pointer.
virtual const char *	getConnectionKindID ()
	Returns some implementation-defined string based on the dynamic type of the connection.
virtual	~VrpnBasedConnection ()
Public Member Functions inherited from osvr::connection::Connection
MessageTypePtr	registerMessageType (std::string const &messageId)
	Register (or retrieve registration) of a message type. More...
ConnectionDevicePtr	createConnectionDevice (std::string const &deviceName)
	Create a ConnectionDevice by registering a full device name. This should be namespaced with the plugin name. More...
ConnectionDevicePtr	createConnectionDevice (DeviceInitObject &init)
void	addDevice (ConnectionDevicePtr device)
	Add an externally-constructed device to the device list.
void	process ()
	Process messages. This shouldn't block. More...
void	registerConnectionHandler (std::function< void()> handler)
	Register a function to be called when a client connects or pings.
void	registerDescriptorHandler (std::function< void()> handler)
	Register a function to be called when a descriptor changes.
void	triggerDescriptorHandlers ()
	Signal a descriptor update and call any/all descriptor handlers.
virtual	~Connection ()
	Destructor.
boost::iterator_range < DeviceList::const_iterator >	getDevices () const
	Get the devices, as a range.
ConnectionDevicePtr	registerAdvancedDevice (std::string const &deviceName, OSVR_DeviceUpdateCallback updateFunction, void *userdata)
	Record a full device name (namespaced with the plugin name) associated with a given callback. More...
ConnectionDevicePtr	registerAdvancedDevice (NameList const &deviceNames, OSVR_DeviceUpdateCallback updateFunction, void *userdata)
	Record more than one full device name (namespaced with the plugin name) associated with a given callback. More...

Additional Inherited Members
Static Public Member Functions inherited from osvr::connection::Connection
static ConnectionPtr	createLocalConnection ()
static ConnectionPtr	createSharedConnection (boost::optional< std::string const & > iface, boost::optional< int > port)
	Factory method to create a shared connection. More...
static std::tuple< void *, ConnectionPtr >	createLoopbackConnection ()
static ConnectionPtr	retrieveConnection (const pluginhost::RegistrationContext &ctx)
static void	storeConnection (pluginhost::RegistrationContext &ctx, ConnectionPtr conn)
	Store a connection pointer in a RegistrationContext.
Protected Member Functions inherited from osvr::connection::Connection
	Connection ()
	brief Constructor

Detailed Description

Definition at line 45 of file VrpnBasedConnection.h.

Constructor & Destructor Documentation

osvr::connection::VrpnBasedConnection::~VrpnBasedConnection ( )

virtual

Todo:

wait until all async threads are done

Definition at line 130 of file VrpnBasedConnection.cpp.

---

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

• src/osvr/Connection/VrpnBasedConnection.h
• src/osvr/Connection/VrpnBasedConnection.cpp