@type dispatcher() :: ([String.t()], %{required(String.t()) => String.t()} -> :ok)

Callback for dispatching notifications

BEAMNotify calls the dispatcher function whenever a message comes in. The first parameter is the list of arguments passed to $BEAM_NOTIFY. The second argument is a map containing environment variables. Whether or not the map is populated depends on the options to start_link/1.

@type options() :: [
  name: binary() | atom(),
  path: Path.t(),
  mode: non_neg_integer(),
  dispatcher: dispatcher(),
  report_env: boolean(),
  recbuf: non_neg_integer()
]

BEAMNotify takes the following options

• :name - a unique name for this notifier. This is required if you expect to run multiple BEAMNotify GenServers at a time.
• :dispatcher - a function to call when a notification comes in
• :path - the path to use for the named socket. A path in the system temporary directory is the default.
• :mode - the permissions to apply to the socket. Should be an octal number eg: 0o660 for read/write owner/group, no access to everyone else
• :report_env - set to true to report environment variables in addition to commandline argument. Defaults to false
• :recbuf - receive buffer size. If you're sending a particular large amount of data and getting errors from :erlang.binary_to_term(data), try making this bigger. Defaults to 8192.