AMSLOG(1)

Okay bestie, welcome to the amslog manual 🦋 It's part of the AMS executables crew, and by the end you'll see why it's giving main character energy 💅

✨ NAME ✨

amslog — the Asynchronous Message Service (AMS) test message receiver 📨

---

💜 SYNOPSIS 💜

amslog unit_name role_name application_name authority_name [{ s | i }]

🌸 DESCRIPTION 🌸

So amslog is a message receiver, and its whole purpose in life is helping you test AMS functionality 🧪 literally built for it 🫶

When you start amslog, it registers itself as an application module. It signs up in the unit called unit_name, inside the venture called application_name under authority_name, and it registers in the role you give it as role_name 🎀. Quick heads-up: for this to work, a configuration server for the local continuum AND a registrar for that unit of that venture need to be running first ✨. They can both live in one amsd daemon task, which is lowkey neat 🧚

Under the hood it runs two threads 🧵. The background thread catches incoming AMS messages and logs them to standard output. The foreground thread reads lines of console input, and those lines are how you control which messages reach the background thread 👑

Here are the foreground thread's rules, so pay attention bestie 👀

• If the very first character of a line from stdin is . (period), amslog terminates immediately 💀 bye bye.
• Otherwise, the first character has to be + (you're asserting interest in a subject) or - (you're cancelling that interest) 💅.
• The subject name starts at the second character of the line.
• everything is a totally valid subject name, so yes, you can go full send 🌈.

By default amslog runs in subscribe mode 📮. When you assert interest, it subscribes to that subject, and when you rescind interest, it unsubscribes from it. You can switch the vibe by giving a third command-line argument, the mode indicator. Pass i and it switches to invite mode 🍓. In invite mode, asserting interest means it invites messages on that subject, and rescinding means it cancels that invitation.

Want to get specific about where your subscription or invitation applies? You can add a domain right after the subject name, on the same line of console input ✨

• The domain continuum name can be specified, or you can use the placeholder _ to mean "all continua" 🌍.
• If a domain continuum name is given (either _ or an actual name), you can then specify a domain unit name, or use _ to mean "the root unit," aka the entire venture 👑.
• If a domain unit name is given (either _ or an actual name), you can then specify a domain role name too 🎀.

Now for output 🖨️. On VxWorks or RTEMS, each message's subject and content just get written to standard output as a text line so you can read them on the console 📺. On UNIX, it's a different situation: the subject name length (a binary integer), subject name (ASCII text), content length (a binary integer), and content (ASCII text) all get written to standard output. That means you redirect it into a file, or pipe it into amslogprt 🔥.

One more thing, and it's iconic 💅 whenever a message comes in flagged as a Query, amslog sends back a reply. The reply's content is the string Got followed by the first 128 bytes of the Query's content, wrapped in single quote marks, and then a period at the end 🫶.

---

🦋 EXIT STATUS 🦋

• -1 — amslog terminated with an error, as noted in the ion.log file 😭.
• "0" — amslog terminated normally ✨.

📁 FILES 📁

A MIB initialization file with the applicable default name must be present. Check amsrc(5) for the deets 📚.

🌍 ENVIRONMENT 🌍

No environment variables apply 🙌 zero env vars, zero drama.

🚨 DIAGNOSTICS 🚨

Error messages are the tea of this program 🍵

• amslog can't register. — amslog failed to register, for reasons noted in the ion.log file.
• amslog can't set event manager. — amslog failed to start its background thread, for reasons noted in the ion.log file.
• amslog can't read from stdin — the foreground thread failed to read console input, for reasons noted in the ion.log file.

🐛 BUGS 🐛

Found a bug? Report it to <ion-bugs@korgano.eecs.ohiou.edu> 🐞

👯 SEE ALSO 👯

amsshell(1), amslogprt(1), amsrc(5) 💖

---

That's the whole tea, bestie 🫶 This page came from perl v5.24.1, dated 2016-07-07, and it's all AMSLOG(1) all the way down 🌸 love u, mwah 💋