wonderlo::StreamMulticaster Class Reference

A StreamMulticaster forwards any OSC messages that are sent to its StreamInPort to a multicast group. More...

#include <StreamMulticaster.h>

Public Member Functions
	StreamMulticaster (const std::string &sourceHost, const std::string &sourcePort, const std::string &mcGroup, const std::string &mcPort, const std::string &mcIfaceIp, const std::string &connectPort, const std::string &streamInPort, const std::string &streamName, const uint8_t ttl=VISUAL_MC_TTL)
	Constructor. More...
virtual	~StreamMulticaster ()
	Destructor. More...
int	getConnectPort () const
	Returns the port where incoming connect messages may be sent to. More...
int	getStreamInPort () const
	Returns the port where the incoming stream is recieved. More...
std::string	getStreamSourceHost () const
	Returns the hostname of the stream source (i.e. More...
std::string	getStreamSourcePort () const
	Returns the port of the stream source (i.e. More...
std::string	getMulticastGroup () const
	Returns the IP of the multicast group. More...
std::string	getMulticastPort () const
	Returns the port of the multicast group. More...
std::string	getMulticastIface () const
	Returns the interface identifier for the network interface used for sending to the multicast group. More...

Static Public Member Functions
static int	main (const std::string &cWonderAddr="", const std::string &type="visual")
	A function that starts a StreamMulticaster-instance. More...

Detailed Description

A StreamMulticaster forwards any OSC messages that are sent to its StreamInPort to a multicast group.

Its purpose is to connect to one of WONDER's OSC "streams" ("visual" / "timer" / "render" / "score") and forward the stream to multiple recievers.

Two threads listen on two ports:

• the StreamInPort: any messages recieved here are forwarded to the multicast group. If a /WONDER/stream/streamName/ping message is received on this port, it is both forwarded to the multicast group and replied to with the corresponding /WONDER/stream/streamName/pong message.
• the ConnectPort: if a /WONDER/stream/streamName/connect message (with any parameter constellation) is recieved here, the StreamMulticaster sends a /WONDER/stream/streamName/connect(String name) message to the stream source (i.e. cWONDER). This triggers cWONDER to resend any messages that are sent on the first connect message. Those are forwarded to the multicast group, so whenever a new client sends a /WONDER/stream/streamName/connect message to the ConnectPort, he will receive the reply he would have recieved if he had connected to cWONDER directly.

  Warning

  Due to a bug in cWONDER (version 3.1.0), cWONDER will resend all information on repeated /WONDER/stream/streamName/connect to the client that last registered for the corresponding stream (not to the client that was reconnected). If you want to use this feature, make sure you connect last or fix that bug.

Constructor & Destructor Documentation

wonderlo::StreamMulticaster::StreamMulticaster	(	const std::string &	sourceHost,
		const std::string &	sourcePort,
		const std::string &	mcGroup,
		const std::string &	mcPort,
		const std::string &	mcIfaceIp,
		const std::string &	connectPort,
		const std::string &	streamInPort,
		const std::string &	streamName,
		const uint8_t	ttl = VISUAL_MC_TTL
	)

Constructor.

Parameters

sourceHost	The hostname/IP of cWONDER.
sourcePort	The port of cWONDER.
mcGroup	The IP of the multicast group that the stream shall be forwarded to.
mcPort	The port of the multicast group that the stream shall be forwarded to.
mcIfaceIp	The IP of the local interface where the multicast messages shall be sent from.
connectPort	The port to be used for incoming /WONDER/stream/streamName/connect messages.
streamInPort	The port to be used for recieving the incoming stream.
streamName	The name of the stream that shall be forwarded. As of WONDER version 3.1.0, this can be "visual", "timer", "render" or "score".
ttl	The time-to-live value for the messages sent to the multicast group.

wonderlo::StreamMulticaster::~StreamMulticaster ( )

virtual

Destructor.

Member Function Documentation

int wonderlo::StreamMulticaster::getConnectPort

(

)

const

Returns the port where incoming connect messages may be sent to.

Returns

The port where incoming connect messages may be sent to.

std::string wonderlo::StreamMulticaster::getMulticastGroup

(

)

const

Returns the IP of the multicast group.

Returns

The IP of the multicast group.

std::string wonderlo::StreamMulticaster::getMulticastIface

(

)

const

Returns the interface identifier for the network interface used for sending to the multicast group.

Returns

The interface identifier for the network interface used for sending to the multicast group.

std::string wonderlo::StreamMulticaster::getMulticastPort

(

)

const

Returns the port of the multicast group.

Returns

The port of the multicast group.

int wonderlo::StreamMulticaster::getStreamInPort

(

)

const

Returns the port where the incoming stream is recieved.

Returns

The port where the incoming stream is recieved.

std::string wonderlo::StreamMulticaster::getStreamSourceHost

(

)

const

Returns the hostname of the stream source (i.e.

cWONDER).

Returns

The hostname of the stream source (i.e. cWONDER).

std::string wonderlo::StreamMulticaster::getStreamSourcePort

(

)

const

Returns the port of the stream source (i.e.

cWONDER).

Returns

The port of the stream source (i.e. cWONDER).

int wonderlo::StreamMulticaster::main ( const std::string &  cWonderAddr = "", const std::string &  type = "visual"  )

static

A function that starts a StreamMulticaster-instance.

Network-addresses are used as defined in WonderHeader.h, the address of cWONDER can be passed as parameter. This is meant as an OS-independent main function (to be called from the "real" main).

Parameters

cWonderAddr	A string of the format "ip:port" that will be used as the address for cWONDER. If an empty string is passed, the default address from WonderHeader.h will be used.
type	The type of the stream to be forwarded ("visual" / "timer" / "render" / "score")

Returns

0 on success, -1 on failure.