ACSRC(5)

📦 version 3.2.1, in ubuntu jammy

💖 ACSRC(5) 💖

okay bestie, so this is ACSRC(5), and it lives in the BP configuration files section of the manual. it's a whole vibe about how you talk to the Aggregate Custody Signal side of your ION node, and honestly? it's giving "secret handshake energy." let's get into it 🫶

✨ NAME ✨

acsrc — the Aggregate Custody Signal management commands file. yep, that's the whole name. short, sweet, iconic 💅

🌸 DESCRIPTION 🌸

So here's the tea: Aggregate Custody Signal management commands get passed to acsadmin in one of two ways:

  • through a file of text lines, or
  • interactively at acsadmin's command prompt, which is :

Commands get interpreted line by line, and it's exactly one command per line — no doubling up, no multitasking, one command per line periodt.

The formats and effects of all those Aggregate Custody Signal management commands? Literally all described below. keep reading bestie 😌

🎀 GENERAL COMMANDS 🎀

  • ? — The help command. It displays a listing of the commands and their formats. It is the same as the h command. twin behavior fr fr
  • # — Comment line. Any line beginning with # is not interpreted. it's just vibes, no execution 🌈
  • e { 1 | 0 } — Echo control. Setting echo to 1 causes all output printed by acsadmin to be logged as well as sent to stdout. Setting echo to 0 disables this behavior. turning the mic on and off basically 🎤
  • v — Version number. Prints out the version of ION currently installed. HINT: combine with the e 1 command to log the version number at startup. lowkey a power move ✨
  • 1 <logLevel> [<heapWords>] — The initialize command. Until this command is executed, Aggregate Custody Signals are not in operation on the local ION node and most acsadmin commands will fail. so like. do this one first bestie, no cap 😭

The logLevel argument specifies at which log level the ACS appending and transmitting implementation should record its activity to the ION log file. This argument is the bitwise "OR" of the following log levels:

  • 0x01 ERROR — Errors in ACS programming are logged.
  • 0x02 WARN — Warnings like "out of memory" that don't cause ACS to fail but may change behavior are logged.
  • 0x04 INFO — Informative information like "this custody signal is a duplicate" is logged.
  • 0x08 DEBUG — Verbose information like the state of the pending ACS tree is logged.

The optional heapWords argument informs ACS to allocate that many heap words in its own DRAM SDR for constructing pending ACS. If you don't supply it, the default ACS_SDR_DEFAULT_HEAPWORDS is used. And here's the part you gotta know: once all ACS SDR is allocated, any incoming custodial bundles that would trigger an ACS will trigger a normal, non-aggregate custody signal instead, until ACS SDR is freed. So if your node keeps intermittently emitting non-aggregate custody signals when it should be emitting ACS, that's your sign to increase heapWords. she's telling you something 🦋

Also! Since ACS uses SDR only for emitting Aggregate Custody Signals, ION can still receive ACS even if this command is not executed, or all ACS SDR memory is allocated. so receiving? always fine. it's the sending that needs the setup 💅

  • h — The help command. It displays a listing of the commands and their formats. It is the same as the ? command. yes we said this already, they're the same, that's the point 🫶
  • s <minimumCustodyId> — This command sets the minimum custody ID that the local bundle agent may use in custody transfer enhancement blocks that it emits. These custody IDs must be unique in the network (for the lifetime of the bundles to which they refer). very much a "no duplicates allowed" situation 👑

The minimumCustodyId you provide is stored in SDR, and incremented every time a new custody ID is required. So, this command should be used only when the local bundle agent has discarded its SDR and restarted. not a casual everyday command bestie, it's for the specific moment 💀

🦋 CUSTODIAN COMMANDS 🦋

  • a custodianEid acsSize [acsDelay] — The add custodian command. This one provides information about the ACS characteristics of a remote custodian.

custodianEid is the custodian EID for which this command is providing information.

acsSize is the preferred size of ACS bundles sent to custodianEid; ACS bundles this implementation sends to custodianEid will aggregate until ACS are at most acsSize bytes. And okay, careful with this one: if acsSize is smaller than 19 bytes, some ACS containing only one signal will exceed acsSize and be sent anyways. Also, setting acsSize to 0 causes "aggregates" of only 1 signal to be sent. so like, zero means "no aggregation actually," iykyk 😭

acsDelay is the maximum amount of time to delay an ACS destined for this custodian before sending it, in seconds; if you don't specify it, DEFAULT_ACS_DELAY will be used. she has a default, she's self-sufficient 🌸

🌈 EXAMPLES 🌈

okay here's one that actually shows the whole vibe:

a ipn:15.0 100 27

Informs ACS on the local node that the local node should send ACS bundles destined for the custodian ipn:15.0 whenever they are 100 bytes in size or have been delayed for 27 seconds, whichever comes first. a little race, a little drama, we love to see it 🏁

👑 SEE ALSO 👑

and that's the whole page bestie!! 🎀 this one came from perl v5.24.1, dated 2016-07-07 — so yeah, she's been around a minute, but she still ate. mwah 💋 go initialize your ACS and slay ✨💖

📦 where this page comes from