lo_serverthread.h man page

lo_serverthread.h —

Synopsis

Functions

lo_server_thread lo_server_thread_new (const char *port, lo_err_handler err_h)
Create a new server thread to handle incoming OSC messages.
lo_server_thread lo_server_thread_new_multicast (const char *group, const char *port, lo_err_handler err_h)
Create a new server thread to handle incoming OSC messages, and join a UDP multicast group.
lo_server_thread lo_server_thread_new_with_proto (const char *port, int proto, lo_err_handler err_h)
Create a new server thread to handle incoming OSC messages, specifying protocol.
lo_server_thread lo_server_thread_new_from_url (const char *url, lo_err_handler err_h)
Create a new server thread, taking port and the optional multicast group IP from an URL string.
void lo_server_thread_free (lo_server_thread st)
Free memory taken by a server thread.
lo_method lo_server_thread_add_method (lo_server_thread st, const char *path, const char *typespec, lo_method_handler h, void *user_data)
Add an OSC method to the specifed server thread.
void lo_server_thread_del_method (lo_server_thread st, const char *path, const char *typespec)
Delete an OSC method from the specifed server thread.
int lo_server_thread_start (lo_server_thread st)
Start the server thread.
int lo_server_thread_stop (lo_server_thread st)
Stop the server thread.
int lo_server_thread_get_port (lo_server_thread st)
Return the port number that the server thread has bound to.
char * lo_server_thread_get_url (lo_server_thread st)
Return a URL describing the address of the server thread.
lo_server lo_server_thread_get_server (lo_server_thread st)
Return the lo_server for a lo_server_thread.
int lo_server_thread_events_pending (lo_server_thread st)
Return true if there are scheduled events (eg. from bundles) waiting to be dispatched by the thread.
void lo_server_thread_pp (lo_server_thread st)
Pretty-print a lo_server_thread object.

Detailed Description

The liblo headerfile declaring thread-related functions.

Function Documentation

lo_method lo_server_thread_add_method (lo_server_thread st, const char * path, const char * typespec, lo_method_handler h, void * user_data)

Add an OSC method to the specifed server thread.

Parameters:

st The server thread the method is to be added to.
path The OSC path to register the method to. If NULL is passed the method will match all paths.
typespec The typespec the method accepts. Incoming messages with similar typespecs (e.g. ones with numerical types in the same position) will be coerced to the typespec given here.
h The method handler callback function that will be called it a matching message is received
user_data A value that will be passed to the callback function, h, when its invoked matching from this method.

void lo_server_thread_del_method (lo_server_thread st, const char * path, const char * typespec)

Delete an OSC method from the specifed server thread.

Parameters:

st The server thread the method is to be removed from.
path The OSC path of the method to delete. If NULL is passed the method will match the generic handler.
typespec The typespec the method accepts.

int lo_server_thread_events_pending (lo_server_thread st)

Return true if there are scheduled events (eg. from bundles) waiting to be dispatched by the thread.

void lo_server_thread_free (lo_server_thread st)

Free memory taken by a server thread. Frees the memory, and, if currently running will stop the associated thread.

int lo_server_thread_get_port (lo_server_thread st)

Return the port number that the server thread has bound to.

lo_server lo_server_thread_get_server (lo_server_thread st)

Return the lo_server for a lo_server_thread. This function is useful for passing a thread's lo_server to lo_send_from().

char* lo_server_thread_get_url (lo_server_thread st)

Return a URL describing the address of the server thread. Return value must be free()'d to reclaim memory.

lo_server_thread lo_server_thread_new (const char * port, lo_err_handler err_h)

Create a new server thread to handle incoming OSC messages. Server threads take care of the message reception and dispatch by transparently creating a system thread to handle incoming messages. Use this if you do not want to handle the threading yourself.

Parameters:

port If NULL is passed then an unused port will be chosen by the system, its number may be retrieved with lo_server_thread_get_port() so it can be passed to clients. Otherwise a decimal port number, service name or UNIX domain socket path may be passed.
err_h A function that will be called in the event of an error being raised. The function prototype is defined in lo_types.h

lo_server_thread lo_server_thread_new_from_url (const char * url, lo_err_handler err_h)

Create a new server thread, taking port and the optional multicast group IP from an URL string.

Parameters:

url The URL to specify the server parameters.
err_h An error callback function that will be called if there is an error in messge reception or server creation. Pass NULL if you do not want error handling.

Returns:

A new lo_server_thread instance.

lo_server_thread lo_server_thread_new_multicast (const char * group, const char * port, lo_err_handler err_h)

Create a new server thread to handle incoming OSC messages, and join a UDP multicast group. Server threads take care of the message reception and dispatch by transparently creating a system thread to handle incoming messages. Use this if you do not want to handle the threading yourself.

Parameters:

group The multicast group to join. See documentation on IP multicast for the acceptable address range; e.g., http://tldp.org/HOWTO/Multicast-HOWTO-2…
port If NULL is passed then an unused port will be chosen by the system, its number may be retrieved with lo_server_thread_get_port() so it can be passed to clients. Otherwise a decimal port number, service name or UNIX domain socket path may be passed.
err_h A function that will be called in the event of an error being raised. The function prototype is defined in lo_types.h

lo_server_thread lo_server_thread_new_with_proto (const char * port, int proto, lo_err_handler err_h)

Create a new server thread to handle incoming OSC messages, specifying protocol. Server threads take care of the message reception and dispatch by transparently creating a system thread to handle incoming messages. Use this if you do not want to handle the threading yourself.

Parameters:

port If NULL is passed then an unused port will be chosen by the system, its number may be retrieved with lo_server_thread_get_port() so it can be passed to clients. Otherwise a decimal port number, service name or UNIX domain socket path may be passed.
proto The protocol to use, should be one of LO_UDP, LO_TCP or LO_UNIX.
err_h A function that will be called in the event of an error being raised. The function prototype is defined in lo_types.h

void lo_server_thread_pp (lo_server_thread st)

Pretty-print a lo_server_thread object.

int lo_server_thread_start (lo_server_thread st)

Start the server thread.

Parameters:

st the server thread to start.

Returns:

Less than 0 on failure, 0 on success.

int lo_server_thread_stop (lo_server_thread st)

Stop the server thread.

Parameters:

st the server thread to start.

Returns:

Less than 0 on failure, 0 on success.

Author

Generated automatically by Doxygen for liblo from the source code.

Info

Thu Feb 4 2016 Version 0.28 liblo