Protocol

Instantiation of various protocols such as OSC, Minuit, OSCQuery... More...

Detailed Description

Instantiation of various protocols such as OSC, Minuit, OSCQuery...

See also

ossia::net::protocol_base

Functions
OSSIA_EXPORT ossia_protocol_t	ossia_protocol_multiplex_create ()
	Instantiate a multiplexer protocol. More...
OSSIA_EXPORT void	ossia_protocol_multiplex_expose_to (ossia_protocol_t local, ossia_protocol_t other)
	Adds a protocol to the set of protocols managed by the multiplexer. More...
OSSIA_EXPORT ossia_protocol_t	ossia_protocol_osc_create (const char *ip, int remote_port, int local_port)
	Instantiate a raw OSC protocol. More...
OSSIA_EXPORT ossia_protocol_t	ossia_protocol_minuit_create (const char *local_name, const char *ip, int remote_port, int local_port)
	Instantiate a Minuit protocol. More...
OSSIA_EXPORT ossia_protocol_t	ossia_protocol_oscquery_server_create (int osc_port, int ws_port)
	Instantiate an OSCQuery server. More...
OSSIA_EXPORT ossia_protocol_t	ossia_protocol_oscquery_mirror_create (const char *host)
	Instantiate an OSCQuery client. More...
OSSIA_EXPORT void	ossia_protocol_free (ossia_protocol_t)
	Free the memory associated to a protocol. More...

Function Documentation

ossia_protocol_multiplex_create()

OSSIA_EXPORT ossia_protocol_t ossia_protocol_multiplex_create

(

)

Instantiate a multiplexer protocol.

Returns

An instance of a multiplexing protocol

See also

ossia::net::multiplex_protocol

Note

Multithread guarantees: MT-safe

ossia_protocol_multiplex_expose_to()

OSSIA_EXPORT void ossia_protocol_multiplex_expose_to	(	ossia_protocol_t	local,
		ossia_protocol_t	other
	)

Adds a protocol to the set of protocols managed by the multiplexer.

See also

ossia::net::multiplex_protocol

Note

Multithread guarantees: MT-safe

ossia_protocol_osc_create()

OSSIA_EXPORT ossia_protocol_t ossia_protocol_osc_create	(	const char *	ip,
		int	remote_port,
		int	local_port
	)

Instantiate a raw OSC protocol.

Parameters

ip	Where to connect
remote_port	Port on which this software will send messages to.
local_port	Port on which the remote software will send messages

See also

ossia::net::osc_protocol

Note

Multithread guarantees: MT-safe

ossia_protocol_minuit_create()

OSSIA_EXPORT ossia_protocol_t ossia_protocol_minuit_create	(	const char *	local_name,
		const char *	ip,
		int	remote_port,
		int	local_port
	)

Instantiate a Minuit protocol.

Parameters

local_name	Under which name the local software appears
ip	Where to connect
remote_port	Port on which this object will send messages to.
local_port	Port on which the remote software will send messages

See also

ossia::net::minuit_protocol

Note

Multithread guarantees: MT-safe

ossia_protocol_oscquery_server_create()

OSSIA_EXPORT ossia_protocol_t ossia_protocol_oscquery_server_create	(	int	osc_port,
		int	ws_port
	)

Instantiate an OSCQuery server.

Parameters

osc_port	Local OSC port
ws_port	Local websocket port

See also

ossia::oscquery::oscquery_server

Note

Multithread guarantees: MT-safe

ossia_protocol_oscquery_mirror_create()

OSSIA_EXPORT ossia_protocol_t ossia_protocol_oscquery_mirror_create

(

const char *

host

)

Instantiate an OSCQuery client.

Parameters

host	something like ws://127.0.0.1:5678

See also

ossia::oscquery::oscquery_mirror

Note

Multithread guarantees: MT-safe

ossia_protocol_free()

OSSIA_EXPORT void ossia_protocol_free

(

ossia_protocol_t

proto

)

Free the memory associated to a protocol.

Note

Multithread guarantees: MT-safe