SPAOP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Member Functions | List of all members
wonder::VisualStreamReceiver Class Referenceabstract

An interface defining an OSC server thread that receives and handles the messages sent via WONDER's "visual stream". More...

#include <VisualStreamReceiver.h>

Inheritance diagram for wonder::VisualStreamReceiver:
Inheritance graph
[legend]

Classes

class  Factory
 A factory class that creates VisualStreamReceiver instances. More...
 
class  Listener
 A listener interface that can be registered with the VisualStreamReceiver. More...
 
class  PingHandler
 Another listener interface especially for incoming ping messages. More...
 

Public Member Functions

virtual ~VisualStreamReceiver ()
 Destructor. More...
 
virtual OscSendercreateSender (const std::string &host, const std::string &port)=0
 Returns a OscSender that sends from the port of this server thread to the specified destination. More...
 
virtual OscSenderThreadcreateSenderThread (const std::string &host, const std::string &port)=0
 
virtual void start ()=0
 Starts this server thread. More...
 
virtual void stop ()=0
 Stops this server thread. More...
 
virtual void join ()=0
 Joins this server thread. More...
 
virtual void setListener (Listener *listener)=0
 Sets the Listener to be called on incoming OSC messages. More...
 
virtual void setPingHandler (PingHandler *pingHandler)=0
 Sets the PingHandler to be called on incoming /WONDER/stream/visual/ping messages. More...
 
virtual int port ()=0
 Returns the port this server-thread is listening on. More...
 

Detailed Description

An interface defining an OSC server thread that receives and handles the messages sent via WONDER's "visual stream".

See Also
wonderlo::VSReceiver for a liblo-based implementation.

Constructor & Destructor Documentation

virtual wonder::VisualStreamReceiver::~VisualStreamReceiver ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual OscSender* wonder::VisualStreamReceiver::createSender ( const std::string &  host,
const std::string &  port 
)
pure virtual

Returns a OscSender that sends from the port of this server thread to the specified destination.

Parameters
hostA valid hostname or ip string (what exactly is supported (IPv6?) may depend on what OSC library is used to implement this interface).
portA validport number or service name (what exactly is supported may depend on what OSC library is used to implement this interface).
Returns
A OscSender that sends from the port of this server thread to the specified destination.

Implemented in wonderlo::VSReceiver.

virtual OscSenderThread* wonder::VisualStreamReceiver::createSenderThread ( const std::string &  host,
const std::string &  port 
)
pure virtual

Implemented in wonderlo::VSReceiver.

virtual void wonder::VisualStreamReceiver::join ( )
pure virtual

Joins this server thread.

Implemented in wonderlo::VSReceiver.

virtual int wonder::VisualStreamReceiver::port ( )
pure virtual

Returns the port this server-thread is listening on.

Implemented in wonderlo::VSReceiver.

virtual void wonder::VisualStreamReceiver::setListener ( Listener listener)
pure virtual

Sets the Listener to be called on incoming OSC messages.

Parameters
listenerThe Listener to be called on incoming OSC messages.
virtual void wonder::VisualStreamReceiver::setPingHandler ( PingHandler pingHandler)
pure virtual

Sets the PingHandler to be called on incoming /WONDER/stream/visual/ping messages.

Parameters
pingHandlerThe PingHandler to be called on incoming /WONDER/stream/visual/ping messages.

Implemented in wonderlo::VSReceiver.

virtual void wonder::VisualStreamReceiver::start ( )
pure virtual

Starts this server thread.

Implemented in wonderlo::VSReceiver.

virtual void wonder::VisualStreamReceiver::stop ( )
pure virtual

Stops this server thread.

Implemented in wonderlo::VSReceiver.