Toit
Libraries
bignum
binary
bitmap
ble
bytes
core
crypto
device
encoding
esp32
expect
fixed-point
flash
font
gpio
i2c
i2s
icons
io
line-wrap
log
math
monitor
net
pulse-counter
reader
reader-writer
rmt
serial
spi
statistics
system
tls
uart
uuid
writer
zlib

Class Mailbox

A two-way communication channel between tasks with replies to each message. Multiple messages (objects) can be sent, but only one can be in flight at a time.
Inheritance
This class must not be extended.

Class summary

send message/any -> any
Sends the message to another task.
receive -> any
Receives a message from another task.
reply message/any -> none
Replies to the other task with a reply message (object).
operator == other/any -> bool
Whether this object is equal to the other.
stringify -> string
Stringifies this object.
await [condition] -> none
Yields until the condition block returns true.
try-await --deadline/int [condition] -> any
Yields until the condition block returns true or until the given deadline is reached.

Methods

await [condition] -> none
Yields until the condition block returns true.
This should be called from a locked method.
The condition is not allowed to change the state, only query it.
operator == other/any -> bool
Whether this object is equal to the other.
By default, identical is used for equality.
Inheritance
Classes overwrite this operator to get an equality specific to their needs. Equality operators often compare the type and field contents. For example:

class Pin:
  number/int

  constructor .number:

  operator == other:
    if other is not Pin: return false
    return number == other.number
A class doesn't have to follow the above format, but it must keep the operator in sync with any hash-code method. That is, if a class has a hash-code member, then the equality and hash-code must agree. If two instances are equal (a == b), then their hash codes must also be equal (a.hash-code == b.hash-code).
receive -> any
Receives a message from another task.
This operation blocks until the other task sends a message.
This task must respond to the message, using reply. Failure to do so leads to indefinitely blocked tasks.
reply message/any -> none
Replies to the other task with a reply message (object).
This unblocks the other task, which is waiting in send.
send message/any -> any
Sends the message to another task.
This operation blocks until the other task replies.
stringify -> string
Stringifies this object.
Inheritance
Objects that need a human-friendly string representation should overwrite this method. The default string is based on the internal class-ID.
try-await --deadline/int [condition] -> any
Yields until the condition block returns true or until the given deadline is reached.
Returns true if the condition has been met or false if we have reached the deadline.
This should be called from a locked method.
The condition is not allowed to change the state, only query it.