<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>liblo: lo_types.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">liblo
 <span id="projectnumber">0.26</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.0 -->
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">lo_types.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:abf9b53223467de596b89e1377b0f3f3d"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="lo__types_8h.html#abf9b53223467de596b89e1377b0f3f3d">lo_address</a></td></tr>
<tr class="memdesc:abf9b53223467de596b89e1377b0f3f3d"><td class="mdescLeft"> </td><td class="mdescRight">A reference to an OSC service. <a href="#abf9b53223467de596b89e1377b0f3f3d"></a><br/></td></tr>
<tr class="memitem:a8e780f8c09e3e4dd737fe249f11d16fc"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="lo__types_8h.html#a8e780f8c09e3e4dd737fe249f11d16fc">lo_blob</a></td></tr>
<tr class="memdesc:a8e780f8c09e3e4dd737fe249f11d16fc"><td class="mdescLeft"> </td><td class="mdescRight">A object to store an opaque binary data object. <a href="#a8e780f8c09e3e4dd737fe249f11d16fc"></a><br/></td></tr>
<tr class="memitem:ad126083c98d941f00eb72d1690b38d63"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="lo__types_8h.html#ad126083c98d941f00eb72d1690b38d63">lo_message</a></td></tr>
<tr class="memdesc:ad126083c98d941f00eb72d1690b38d63"><td class="mdescLeft"> </td><td class="mdescRight">A low-level object used to represent messages passed over OSC. <a href="#ad126083c98d941f00eb72d1690b38d63"></a><br/></td></tr>
<tr class="memitem:a96254950ad34e9cfbf8a6613fc74025b"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="lo__types_8h.html#a96254950ad34e9cfbf8a6613fc74025b">lo_bundle</a></td></tr>
<tr class="memdesc:a96254950ad34e9cfbf8a6613fc74025b"><td class="mdescLeft"> </td><td class="mdescRight">A low-level object used to represent bundles of messages passed over OSC. <a href="#a96254950ad34e9cfbf8a6613fc74025b"></a><br/></td></tr>
<tr class="memitem:a66faedf5da13231d8c0166870477dce5"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="lo__types_8h.html#a66faedf5da13231d8c0166870477dce5">lo_method</a></td></tr>
<tr class="memdesc:a66faedf5da13231d8c0166870477dce5"><td class="mdescLeft"> </td><td class="mdescRight">An object representing an method on a server. <a href="#a66faedf5da13231d8c0166870477dce5"></a><br/></td></tr>
<tr class="memitem:a59067bf50cf8abb4371da6f03c9036c9"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="lo__types_8h.html#a59067bf50cf8abb4371da6f03c9036c9">lo_server</a></td></tr>
<tr class="memdesc:a59067bf50cf8abb4371da6f03c9036c9"><td class="mdescLeft"> </td><td class="mdescRight">An object representing an instance of an OSC server. <a href="#a59067bf50cf8abb4371da6f03c9036c9"></a><br/></td></tr>
<tr class="memitem:a09996ffb6bde21b8fb6106897b88feae"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="lo__types_8h.html#a09996ffb6bde21b8fb6106897b88feae">lo_server_thread</a></td></tr>
<tr class="memdesc:a09996ffb6bde21b8fb6106897b88feae"><td class="mdescLeft"> </td><td class="mdescRight">An object representing a thread containing an OSC server. <a href="#a09996ffb6bde21b8fb6106897b88feae"></a><br/></td></tr>
<tr class="memitem:aa5d2e4aa0ff9d4459fcc76e7ed5839fc"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="lo__types_8h.html#aa5d2e4aa0ff9d4459fcc76e7ed5839fc">lo_err_handler</a> )(int num, const char *msg, const char *where)</td></tr>
<tr class="memdesc:aa5d2e4aa0ff9d4459fcc76e7ed5839fc"><td class="mdescLeft"> </td><td class="mdescRight">A callback function to receive notifcation of an error in a server or server thread. <a href="#aa5d2e4aa0ff9d4459fcc76e7ed5839fc"></a><br/></td></tr>
<tr class="memitem:a3b1c86c0925d05e13b5438ce8fe80a6c"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="lo__types_8h.html#a3b1c86c0925d05e13b5438ce8fe80a6c">lo_method_handler</a> )(const char *path, const char *types, <a class="el" href="unionlo__arg.html">lo_arg</a> **argv, int argc, <a class="el" href="lo__types_8h.html#ad126083c98d941f00eb72d1690b38d63">lo_message</a> msg, void *user_data)</td></tr>
<tr class="memdesc:a3b1c86c0925d05e13b5438ce8fe80a6c"><td class="mdescLeft"> </td><td class="mdescRight">A callback function to receive notifcation of matching message arriving in the server or server thread. <a href="#a3b1c86c0925d05e13b5438ce8fe80a6c"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The liblo headerfile defining types used by this API. </p>
</div><hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="abf9b53223467de596b89e1377b0f3f3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="lo__types_8h.html#abf9b53223467de596b89e1377b0f3f3d">lo_address</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A reference to an OSC service. </p>
<p>Created by calls to <a class="el" href="group__liblo.html#gae5af61a02ab08871d3ea070c8f770cfe" title="Declare an OSC destination, given IP address and port number. Same as lo_address_new_with_proto(), but using UDP.">lo_address_new()</a> or <a class="el" href="group__liblo.html#ga1af2cb3c80393cba838f64dfcdc35620" title="Create a lo_address object from an OSC URL.">lo_address_new_from_url()</a>. </p>
</div>
</div>
<a class="anchor" id="a8e780f8c09e3e4dd737fe249f11d16fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="lo__types_8h.html#a8e780f8c09e3e4dd737fe249f11d16fc">lo_blob</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A object to store an opaque binary data object. </p>
<p>Can be passed over OSC using the 'b' type. Created by calls to <a class="el" href="group__liblo.html#gaffb2348c70cb0e1214fd50bdc7574c39" title="Create a new OSC blob type.">lo_blob_new()</a>. </p>
</div>
</div>
<a class="anchor" id="a96254950ad34e9cfbf8a6613fc74025b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="lo__types_8h.html#a96254950ad34e9cfbf8a6613fc74025b">lo_bundle</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A low-level object used to represent bundles of messages passed over OSC. </p>
<p>Created by calls to <a class="el" href="group__liblolowlevel.html#ga330a4a4e6227b185b3ec6219ff3e2859" title="Create a new bundle object.">lo_bundle_new()</a>, messages can be added with calls to <a class="el" href="group__liblolowlevel.html#ga1cc5e2eb20ce567a694f343764e25bb7" title="Adds an OSC message to an existing bundle.">lo_bundle_add_message()</a>. </p>
</div>
</div>
<a class="anchor" id="aa5d2e4aa0ff9d4459fcc76e7ed5839fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="lo__types_8h.html#aa5d2e4aa0ff9d4459fcc76e7ed5839fc">lo_err_handler</a>)(int num, const char *msg, const char *where)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A callback function to receive notifcation of an error in a server or server thread. </p>
<p>On callback the paramters will be set to the following values:</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">num</td><td>An error number that can be used to identify this condition. </td></tr>
<tr><td class="paramname">msg</td><td>An error message describing the condidtion. </td></tr>
<tr><td class="paramname">where</td><td>A string describing the place the error occured - typically either a function call or method path. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad126083c98d941f00eb72d1690b38d63"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="lo__types_8h.html#ad126083c98d941f00eb72d1690b38d63">lo_message</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A low-level object used to represent messages passed over OSC. </p>
<p>Created by calls to <a class="el" href="group__liblolowlevel.html#ga2cce2e97452e3e9d6b5d3af33bb1d153" title="Create a new lo_message object.">lo_message_new()</a>, arguments can be added with calls to lo_message_add_*(). </p>
</div>
</div>
<a class="anchor" id="a66faedf5da13231d8c0166870477dce5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="lo__types_8h.html#a66faedf5da13231d8c0166870477dce5">lo_method</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An object representing an method on a server. </p>
<p>Returned by calls to <a class="el" href="group__liblo.html#gacff9c90a8efc400448276b2d20831010" title="Add an OSC method to the specifed server thread.">lo_server_thread_add_method()</a> and <a class="el" href="group__liblolowlevel.html#ga0c183cabaac67eb9aad3265ae1efa580" title="Add an OSC method to the specifed server.">lo_server_add_method()</a>. </p>
</div>
</div>
<a class="anchor" id="a3b1c86c0925d05e13b5438ce8fe80a6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* <a class="el" href="lo__types_8h.html#a3b1c86c0925d05e13b5438ce8fe80a6c">lo_method_handler</a>)(const char *path, const char *types, <a class="el" href="unionlo__arg.html">lo_arg</a> **argv, int argc, <a class="el" href="lo__types_8h.html#ad126083c98d941f00eb72d1690b38d63">lo_message</a> msg, void *user_data)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A callback function to receive notifcation of matching message arriving in the server or server thread. </p>
<p>The return value tells the method dispatcher whether this handler has dealt with the message correctly: a return value of 0 indicates that it has been handled, and it should not attempt to pass it on to any other handlers, non-0 means that it has not been handled and the dispatcher will attempt to find more handlers that match the path and types of the incoming message.</p>
<p>On callback the paramters will be set to the following values:</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>That path that the incoming message was sent to </td></tr>
<tr><td class="paramname">types</td><td>If you specided types in your method creation call then this will match those and the incoming types will have been coerced to match, otherwise it will be the types of the arguments of the incoming message. </td></tr>
<tr><td class="paramname">argv</td><td>An array of <a class="el" href="unionlo__arg.html" title="Union used to read values from incoming messages.">lo_arg</a> types containing the values, e.g. if the first argument of the incoming message is of type 'f' then the vlaue will be found in argv[0]->f. </td></tr>
<tr><td class="paramname">argc</td><td>The number of argumets received. </td></tr>
<tr><td class="paramname">msg</td><td>A structure containing the original raw message as received. No type coercion will have occured and the data will be in OSC byte order (bigendian). </td></tr>
<tr><td class="paramname">user_data</td><td>This contains the user_data value passed in the call to lo_server_thread_add_method. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a59067bf50cf8abb4371da6f03c9036c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="lo__types_8h.html#a59067bf50cf8abb4371da6f03c9036c9">lo_server</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An object representing an instance of an OSC server. </p>
<p>Created by calls to <a class="el" href="group__liblolowlevel.html#ga78cfb23346e44465695293d4393447ae" title="Create a new server instance.">lo_server_new()</a>. If you with the library to take care of the threading as well you can just use server threads instead. </p>
</div>
</div>
<a class="anchor" id="a09996ffb6bde21b8fb6106897b88feae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="lo__types_8h.html#a09996ffb6bde21b8fb6106897b88feae">lo_server_thread</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An object representing a thread containing an OSC server. </p>
<p>Created by calls to <a class="el" href="group__liblo.html#gabe3e0c31189adfd7624de6c507b610ba" title="Create a new server thread to handle incoming OSC messages.">lo_server_thread_new()</a>. </p>
</div>
</div>
</div><!-- contents -->
<hr size="1"><address style="text-align: right;"><small>
Generated for liblo by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.8.0</small></address>
</body>
</html>
