Fostrom.Mailbox.Status (Fostrom v0.0.3)

Return value of Fostrom.Mailbox.status/0.

This struct is only returned when there is mail in the mailbox. Otherwise Fostrom.Mailbox.status/0 returns {:ok, :mailbox_empty}.

Summary

Types

t()

@type t() :: %Fostrom.Mailbox.Status{
  mailbox_size: non_neg_integer(),
  next_mail_id: non_neg_integer(),
  next_mail_name: binary()
}
  • mailbox_size: u16 integer
  • next_mail_id: u64 integer
  • next_mail_name: name of the packet schema