TUIO C++ Developer API
TUIO::OscReceiver Class Referenceabstract

#include <OscReceiver.h>

Inheritance diagram for TUIO::OscReceiver:
TUIO::TcpReceiver TUIO::UdpReceiver

Public Member Functions

 OscReceiver ()
 
virtual ~OscReceiver ()
 
virtual void connect (bool lock=false)=0
 
virtual void disconnect ()=0
 
bool isConnected ()
 
void addTuioClient (TuioClient *client)
 
void ProcessPacket (const char *data, int size, const IpEndpointName &remoteEndpoint)
 

Protected Member Functions

void ProcessBundle (const osc::ReceivedBundle &b, const IpEndpointName &remoteEndpoint)
 
void ProcessMessage (const osc::ReceivedMessage &message, const IpEndpointName &remoteEndpoint)
 

Protected Attributes

std::list< TuioClient * > clientList
 
bool connected
 

Detailed Description

The OscReceiver is the base class for the various OSC transport methods such as UDP, TCP ...

Author
Martin Kaltenbrunner
Version
1.1.6

Constructor & Destructor Documentation

◆ OscReceiver()

TUIO::OscReceiver::OscReceiver ( )
inline

The constructor is doing nothing in particular.

◆ ~OscReceiver()

virtual TUIO::OscReceiver::~OscReceiver ( )
inlinevirtual

The destructor is doing nothing in particular.

Member Function Documentation

◆ addTuioClient()

void OscReceiver::addTuioClient ( TuioClient client)

Attaches the provided TuioClient to this OscReceiver

Parameters
clienta pointer to the TuioClient to attach

◆ connect()

virtual void TUIO::OscReceiver::connect ( bool  lock = false)
pure virtual

The OscReceiver connects and starts receiving TUIO messages via OSC

Parameters
lockrunning in the background if set to false (default)

Implemented in TUIO::TcpReceiver, and TUIO::UdpReceiver.

◆ disconnect()

virtual void TUIO::OscReceiver::disconnect ( )
pure virtual

The OscReceiver disconnects and stops receiving TUIO messages via OSC

Implemented in TUIO::TcpReceiver, and TUIO::UdpReceiver.

◆ isConnected()

bool OscReceiver::isConnected ( )

Returns true if this OscReceiver is currently connected.

Returns
true if this OscReceiver is currently connected

◆ ProcessPacket()

void OscReceiver::ProcessPacket ( const char *  data,
int  size,
const IpEndpointName &  remoteEndpoint 
)

The OSC callback method where the incoming OSC data is received

Parameters
datathe received OSC data
sizethe size of the received OSC data
remoteEndpointthe origin of the received OSC data

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