IXPMSG(3)

💖 IXPMSG(3) — Library Functions Manual 💖

okay so bestie, welcome to IXPMSG(3) from the Library Functions Manual — we're talking IxpMsg, IxpMsgMode, and ixp_message, and it's giving binary-message main character energy ✨.

✨ NAME ✨

IxpMsg, IxpMsgMode, and ixp_message — that's the trio, and yes they're all iconic 💅.

🎀 SYNOPSIS 🎀

#include <ixp.h>

typedef struct IxpMsg IxpMsg;
struct IxpMsg {
        char*   data; /* Begining of buffer. */
        char*   pos;  /* Current position in buffer. */
        char*   end;  /* End of message. */
        uint    size; /* Size of buffer. */
        uint    mode; /* MsgPack or MsgUnpack. */
}

enum IxpMsgMode {
        MsgPack,
        MsgUnpack,
}

IxpMsg ixp_message(char *data, uint length, uint mode);

💖 DESCRIPTION 💖

okay so the IxpMsg struct is literally a binary message, and libixp uses it extensively for converting messages to and from wire format — no cap, it's the whole plumbing vibe 🫶.

• data holds the beginning of the buffer (yes, the original says "Begining" — we're leaving that icon alone 💀).
• size holds the size of the buffer.
• pos points at the spot in the message currently being packed or unpacked.
• end points at the end of the message.

The packing functions move pos forward as they go, and they're always making sure they don't read or write past end — boundaries are slay, periodt 🚧✨.

When a message is entirely packed or unpacked, pos should be less than or equal to end (the original says "whould", and honestly? we respect the lore 💀). Any other state indicates error — like, not a vibe check you want to fail, bestie. ERROR. 😭

And ixp_message? It's the convenience function that packs a construct an IxpMsg from a buffer of a given length and a given mode — yes, "pack a construct", we're not editing the manual's quirky little sentences 💅. It sets pos and data to data, and end to data + length. Boom. Done. Iconic. 🎀

🌈 SEE ALSO 🌈

• ixp_pu8(3)
• ixp_pu16(3)
• ixp_pu32(3)
• ixp_pu64(3)
• ixp_pstring(3)
• ixp_pstrings(3)

go read these next, bestie — the whole pack is linked 💖

xoxo, this has been the libixp Manual, 2012 Dec edition — mwah 💋