lo_lowlevel.h(3)

📦
version 0.34 · 3 versions
, in fedora 44

✨ lo_lowlevel.h ✨

okay so bestie, welcome to lo_lowlevel.h 💖 this is the low-level header for liblo, and she is thicc. we're doing this in parts because obviously. part 1 is the little intro tour: what's in here, what structs live here, what typedefs, what enums. strap in 🎀

🌸 NAME 🌸

lo_lowlevel.h — literally the low-level header file, iykyk. it's giving "the guts of liblo exposed for you" energy 💅

✨ SYNOPSIS ✨

🦋 Data Structures

  • struct lo_server_config — a configuration struct for initializing lo_server using lo_server_new_from_config(). she's the glow-up pre-game, the outfit you pick before the server goes out 👑

🎀 Typedefs

  • typedef long double lo_hires — the type used to represent numerical values in conversions between OSC types. that's it, that's the whole vibe: long double, but make it OSC-flavoured ⭐

🌈 Enumerations

  • enum lo_slip_encoding — used with lo_address_set_stream_slip() to specify whether sent messages should be encoded with SLIP, and whether the encoding should be single- or double-ENDed. double-ENDed?? yes bestie, that's a real thing, and this enum is how you pick 🔥
ngl this part is short but it's the foundation, okay? more parts coming, don't go anywhere 💜

✨ Functions ✨

  • int lo_send_message (lo_address targ, const char *path, lo_message msg) — Sends a lo_message object to target targ. 💌 Deliver this message, bestie, no cap.
  • int lo_send_message_from (lo_address targ, lo_server serv, const char *path, lo_message msg) — Sends a lo_message object to target targ from the address of serv. 📬 Like, from this server specifically.
  • int lo_send_bundle (lo_address targ, lo_bundle b) — Sends a lo_bundle object to address targ. 📦 Bundle up, buttercup.
  • int lo_send_bundle_from (lo_address targ, lo_server serv, lo_bundle b) — Sends a lo_bundle object to address targ from the address of serv. 🎁 From serv with love.
  • lo_message lo_message_new (void) — Creates a new lo_message object. ✨ Fresh out the box, main character energy.
  • void lo_message_incref (lo_message m) — Adds one to a message's reference count. ➕ Ref count go up.
  • int lo_message_decref (lo_message m) — Subtracts one from a message's reference count. ➖ Ref count go down.
  • lo_message lo_message_clone (lo_message m) — Creates a new lo_message object by cloning an already existing one. 🧬 Clone army, but make it OSC.
  • void lo_message_free (lo_message m) — Frees memory allocated by lo_message_new() and any subsequent lo_message_add_int32 lo_message_add*() calls. 🗑️ Clean up your mess, bestie.
  • void lo_message_clear (lo_message m) — Clears elements from a lo_message but does not free allocated memory. 🧹 Just wipe the slate, keep the RAM.
  • int lo_message_add (lo_message m, const char *types,...) — Appends a number of arguments to a message. 📎 Add 'em all.
  • int lo_message_add_varargs (lo_message m, const char *types, va_list ap) — Appends a varargs list to a message. 📋 Varargs core, fr fr.
  • int lo_message_add_int32 (lo_message m, int32_t a) — Appends a data item and typechar of the specified type to a message. 🔢 This is the blueprint for all the lo_message_add_* ones, iykyk.
  • int lo_message_add_float (lo_message m, float a) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. 🌊 Float like a butterfly.
  • int lo_message_add_string (lo_message m, const char *a) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. 🧵 String theory but make it OSC.
  • int lo_message_add_blob (lo_message m, lo_blob a) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. 🫧 Blob blob blob.
  • int lo_message_add_int64 (lo_message m, int64_t a) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. 🔢 Big int energy.
  • int lo_message_add_timetag (lo_message m, lo_timetag a) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. ⏳ Time is a construct.
  • int lo_message_add_double (lo_message m, double a) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. 💫 Double the precision, double the slay.
  • int lo_message_add_symbol (lo_message m, const char *a) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. 🔣 Symbolic, literally.
  • int lo_message_add_char (lo_message m, char a) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. 🔤 One character, one vibe.
  • int lo_message_add_midi (lo_message m, uint8_t a[4]) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. 🎹 MIDI in the chat.
  • int lo_message_add_true (lo_message m) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. ✅ True story.
  • int lo_message_add_false (lo_message m) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. ❌ False alarm.
  • int lo_message_add_nil (lo_message m) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. 🕳️ Nil, the void, the abyss.
  • int lo_message_add_infinitum (lo_message m) — Appends a data item and typechar of the specified type to a message. See lo_message_add_int32() for details. ♾️ To infinity and beyond.
  • lo_address lo_message_get_source (lo_message m) — Returns the source (lo_address) of an incoming message. 📍 Where did you come from, where did you go?
  • lo_timetag lo_message_get_timestamp (lo_message m) — Returns the timestamp (lo_timetag *) of a bundled incoming message. ⏰ When did this happen? Here's the receipt.
  • char * lo_message_get_types (lo_message m) — Return the message type tag string. 🏷️ Type tags, iconic.
  • int lo_message_get_argc (lo_message m) — Return the message argument count. 🔢 How many arguments? Count 'em.
  • lo_arg ** lo_message_get_argv (lo_message m) — Return the message arguments. Do not free the returned data. 🫴 Here are the args, bestie.
Do not free the returned data. Seriously, hands off. 🙅‍♀️
  • size_t lo_message_length (lo_message m, const char *path) — Return the length of a message in bytes. 📏 Size check.
  • void * lo_message_serialise (lo_message m, const char *path, void *to, size_t *size) — Serialise the lo_message object to an area of memory and return a pointer to the serialised form. Opposite of lo_message_deserialise(). 📦 Turn it into bytes, periodt.
  • lo_message lo_message_deserialise (void *data, size_t size, int *result) — Deserialise a raw OSC message and return a new lo_message object. Opposite of lo_message_serialise(). 🔄 Bytes back to message, reverse uno.
  • int lo_server_dispatch_data (lo_server s, void *data, size_t size) — Dispatch a raw block of memory containing an OSC message. 🚀 Send it into the server void.
  • const char * lo_address_get_hostname (lo_address a) — Return the hostname of a lo_address object. 🏠 Where you at?
  • const char * lo_address_get_port (lo_address a) — Return the port/service name of a lo_address object. 🚪 Which door?
  • int lo_address_get_protocol (lo_address a) — Return the protocol of a lo_address object. 📡 What protocol we on?
  • char * lo_address_get_url (lo_address a) — Return a URL representing an OSC address. 🔗 Link in bio energy.
  • void lo_address_set_ttl (lo_address t, int ttl) — Set the Time-to-Live value for a given target address. ⏱️ TTL, don't let it expire.
  • int lo_address_get_ttl (lo_address t) — Get the Time-to-Live value for a given target address. ⏳ How long we got?
  • int lo_address_set_iface (lo_address t, const char *iface, const char *ip) — Set the network interface to use for a given target address. 🛜 Pick your interface, bestie.
  • const char * lo_address_get_iface (lo_address t) — Get the name of the network interface assigned to an OSC address. 📶 Which interface we on?
  • int lo_address_set_tcp_nodelay (lo_address t, int enable) — Set the TCP_NODELAY flag on outgoing TCP connections. 🚦 No delay, we move fast.
  • int lo_address_set_stream_slip (lo_address t, lo_slip_encoding encoding) — Set outgoing stream connections (e.g., TCP) to be transmitted using the SLIP packetizing protocol. 🐌 Slip into stream mode.
  • lo_bundle lo_bundle_new (lo_timetag tt) — Create a new bundle object. 🎁 New bundle, who dis?
  • void lo_bundle_incref (lo_bundle b) — Add one to a bundle's reference count. ➕ Ref count up for the bundle.
  • int lo_bundle_add_message (lo_bundle b, const char *path, lo_message m) — Adds an OSC message to an existing bundle. 📩 Slide into the bundle.
  • int lo_bundle_add_bundle (lo_bundle b, lo_bundle n) — Adds an OSC bundle to an existing bundle. 🪆 Bundle-ception.
  • size_t lo_bundle_length (lo_bundle b) — Return the length of a bundle in bytes. 📏 Bundle size check.
  • unsigned int lo_bundle_count (lo_bundle b) — Return the number of top-level elements in a bundle. 🔢 How many top-level elements? Count 'em.
  • lo_element_type lo_bundle_get_type (lo_bundle b, int index) — Gets the element type contained within a bundle. 🏷️ What type is this element?
  • lo_bundle lo_bundle_get_bundle (lo_bundle b, int index) — Gets a nested bundle contained within a bundle. 🪆 Nested bundle, found it.
  • lo_message lo_bundle_get_message (lo_bundle b, int index, const char **path) — Gets a message contained within a bundle. 📨 Message inside the bundle, got it.
  • lo_timetag lo_bundle_get_timestamp (lo_bundle b) — Get the timestamp associated with a bundle. ⏰ When's this bundle from?
  • void * lo_bundle_serialise (lo_bundle b, void *to, size_t *size) — Serialise the bundle object to an area of memory and return a pointer to the serialised form. 📦 Bundle to bytes.
  • void lo_bundle_free (lo_bundle b) — Frees the memory taken by a bundle object. 🗑️ Free the bundle, bye.
  • void lo_bundle_free_recursive (lo_bundle b) — Frees the memory taken by a bundle object and its messages and nested bundles recursively. 🧹 Recursive cleanup, no leftovers.
  • void lo_bundle_free_messages (lo_bundle b) — Obsolete, use lo_bundle_free_recursive instead. ⚠️ Obsolete, bestie — use lo_bundle_free_recursive instead.
  • int lo_is_numerical_type (lo_type a) — Return true if the type specified has a numerical value, such as LO_INT32, LO_FLOAT etc. 🔢 Numbers only, periodt.
  • int lo_is_string_type (lo_type a) — Return true if the type specified has a textual value, such as LO_STRING or LO_SYMBOL. 🔤 Textual healing.
  • int lo_coerce (lo_type type_to, lo_arg *to, lo_type type_from, lo_arg *from) — Attempt to convert one OSC type to another. 🔄 Type conversion, let's try.
  • lo_hires lo_hires_val (lo_type type, lo_arg *p) — Return the numerical value of the given argument with the maximum native system precision. 💎 Max precision, highkey.
  • lo_server lo_server_new (const char *port, lo_err_handler err_h) — Create a new server instance. 🖥️ New server, who dis?
  • lo_server lo_server_new_with_proto (const char *port, int proto, lo_err_handler err_h) — Create a new server instance, specifying protocol. 📡 Server with a protocol twist.
  • lo_server lo_server_new_multicast (const char *group, const char *port, lo_err_handler err_h) — Create a new server instance, and join a UDP multicast group. 📢 Multicast group chat, join us.
  • lo_server lo_server_new_multicast_iface (const char *group, const char *port, const char *iface, const char *ip, lo_err_handler err_h) — Create a new server instance, and join a UDP multicast group, optionally specifying which network interface to use. Note that usually only one of iface or ip are specified. 🛜 Multicast with interface options, usually pick one of iface or ip.
  • lo_server lo_server_new_from_url (const char *url, lo_err_handler err_h) — Create a new server instance, taking port and the optional multicast group IP from an URL string. 🔗 Server from a URL, link in bio.
  • lo_server lo_server_new_from_config (lo_server_config *config) — Create a new server instance, using a configuration struct. ⚙️ Config struct, assemble.
  • int lo_server_enable_coercion (lo_server server, int enable) — Enables or disables type coercion during message dispatch. 🔀 Coercion on or off, your call.
  • void lo_server_free (lo_server s) — Free up memory used by the lo_server object. 🗑️ Server cleanup, bye.
  • int lo_server_wait (lo_server s, int timeout) — Wait for an OSC message to be received. ⏳ Wait for it…
  • int lo_servers_wait (lo_server *s, int *status, int num_servers, int timeout) — Wait on multiple servers for an OSC message to be received. 👯 Multiple servers, one wait.
  • int lo_server_recv_noblock (lo_server s, int timeout) — Look for an OSC message waiting to be received. 👀 Non-blocking peek, no pressure.
  • int lo_servers_recv_noblock (lo_server *s, int *recvd, int num_servers, int timeout) — Look for an OSC message waiting to be received on multiple servers. 👀 Multiple servers, non-blocking peek.
  • int lo_server_recv (lo_server s) — Block, waiting for an OSC message to be received. 🛑 Blocking recv, it's giving patient.
  • lo_method lo_server_add_method (lo_server s, const char *path, const char *typespec, lo_method_handler h, const void *user_data) — Add an OSC method to the specifed server. ➕ Add a method, specifed with love.
  • void lo_server_del_method (lo_server s, const char *path, const char *typespec) — Delete an OSC method from the specified server. ➖ Delete that method.
  • int lo_server_del_lo_method (lo_server s, lo_method m) — Delete a specific OSC method from the specified server. 🗑️ Specific method, delete.
  • int lo_server_add_bundle_handlers (lo_server s, lo_bundle_start_handler sh, lo_bundle_end_handler eh, void *user_data) — Add bundle notification handlers to the specified server. 🔔 Bundle handlers, ding ding.
  • int lo_server_get_socket_fd (lo_server s) — Return the file descriptor of the server socket. 🔌 Socket fd, plug in.
  • int lo_server_get_port (lo_server s) — Return the port number that the server has bound to. 🚪 Which port? Here it is.
  • int lo_server_get_protocol (lo_server s) — tells u which protocol the server is vibing on rn 💫
  • char * lo_server_get_url (lo_server s) — hands u back an OSC URL u can actually use to reach the server, periodt 🫶
  • int lo_server_enable_queue (lo_server s, int queue_enabled, int dispatch_remaining) — toggles the event queue, bestie. When queueing is on, timetagged messages sent ahead of the current time get parked in an internal queue and then dispatched at the exact time they said they'd show up. Queueing is enabled by default btw. Use this to turn it off if u want the server processing messages immediately instead. And in that case? Use lo_message_get_timestamp() from inside a method handler to grab the message timestamp, no cap 🕐
  • int lo_server_events_pending (lo_server s) — returns true if there's scheduled events (like, from bundles yk) just chillin and waiting for the server to dispatch them ⏳
  • double lo_server_next_event_delay (lo_server s) — the time, in seconds, until the next scheduled event drops ⏰
  • int lo_server_max_msg_size (lo_server s, int req_size) — sets the biggest message size the server will accept 📏
  • char * lo_url_get_protocol (const char *url) — pulls out the protocol chunk of an OSC URL, like udp or tcp 💅
  • int lo_url_get_protocol_id (const char *url) — gives u the protocol ID of an OSC URL 🔑
  • char * lo_url_get_hostname (const char *url) — the hostname portion of an OSC URL 🏠
  • char * lo_url_get_port (const char *url) — the port portion of an OSC URL 🔌
  • char * lo_url_get_path (const char *url) — the path portion of an OSC URL 🛤️
  • int lo_strsize (const char *s) — calc's how much OSC message space a C char * needs 📐
  • uint32_t lo_blobsize (lo_blob b) — same energy but for a lo_blob object: how much OSC message space it needs 🫧
  • int lo_pattern_match (const char *str, const char *p) — tests a string against an OSC pattern glob 🎯
  • int lo_string_contains_pattern (const char *str) — checks if a string has any OSC pattern characters in it at all 👀
  • double lo_timetag_diff (lo_timetag a, lo_timetag b) — finds the time difference between two timetags ⏱️
  • void lo_timetag_now (lo_timetag *t) — returns a timetag for right now, this very second 🌟
  • size_t lo_arg_size (lo_type type, void *data) — the storage size, in bytes, of the argument u passed in 🧮
  • char * lo_get_path (void *data, ssize_t size) — give it a raw OSC message and it gives u back the message path 🗺️
  • void lo_arg_host_endian (lo_type type, void *data) — converts the specified argument to host byte order where necessary 🔄
  • void lo_arg_network_endian (lo_type type, void *data) — converts the specified argument to network byte order where necessary 🌐
  • void lo_bundle_pp (lo_bundle b) — pretty-prints a lo_bundle object ✨
  • void lo_message_pp (lo_message m) — pretty-prints a lo_message object 💌
  • void lo_arg_pp (lo_type type, void *data) — pretty-prints a set of typed arguments 🎀
  • void lo_server_pp (lo_server s) — pretty-prints a lo_server object 🖥️
  • void lo_method_pp (lo_method m) — pretty-prints a lo_method object 🪄
  • void lo_method_pp_prefix (lo_method m, const char *p) — pretty-prints a lo_method object, but it prepends whatever prefix u give it to every single field name 🏷️

✨ DETAILED DESCRIPTION ✨

It's the liblo headerfile that defines all the low-level API functions. That's the whole tea ☕

Definition lives in file lo_lowlevel.h 📁

👑 AUTHOR 👑

Generated automatically by Doxygen for liblo from the source code 🤖 no human wrote this one bestie, the machine did it fr fr

okay that's the whole page!! ty for reading my lil Unix TED talk 💖 this was liblo, Version 0.34, lo_lowlevel.h(3) — go forth and slay ur OSC servers, u absolute icon 👑✨

📦 where this page comes from