src/Pure/Concurrent/mailbox.scala
author haftmann
Mon, 16 Jun 2025 15:25:38 +0200
changeset 82730 3b98b1b57435
parent 78865 a0199212046a
permissions -rw-r--r--
more explicit theorem names for list quantifiers
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56693
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/Concurrent/mailbox.scala
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
     3
57417
29fe9bac501b more tight Mailbox: single list is sufficient for single receiver, reverse outside critical section;
wenzelm
parents: 56693
diff changeset
     4
Message exchange via mailbox, with multiple senders (non-blocking,
29fe9bac501b more tight Mailbox: single list is sufficient for single receiver, reverse outside critical section;
wenzelm
parents: 56693
diff changeset
     5
unbounded buffering) and single receiver (bulk messages).
56693
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
     6
*/
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
     7
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
     8
package isabelle
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
     9
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
    10
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 71144
diff changeset
    11
object Mailbox {
78865
a0199212046a support for mailbox limit;
wenzelm
parents: 78864
diff changeset
    12
  def apply[A](limit: Int = 0): Mailbox[A] = new Mailbox[A](limit)
56693
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
    13
}
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
    14
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
    15
78865
a0199212046a support for mailbox limit;
wenzelm
parents: 78864
diff changeset
    16
class Mailbox[A] private(limit: Int) {
61590
wenzelm
parents: 57417
diff changeset
    17
  private val mailbox = Synchronized[List[A]](Nil)
57417
29fe9bac501b more tight Mailbox: single list is sufficient for single receiver, reverse outside critical section;
wenzelm
parents: 56693
diff changeset
    18
  override def toString: String = mailbox.value.reverse.mkString("Mailbox(", ",", ")")
56693
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
    19
78865
a0199212046a support for mailbox limit;
wenzelm
parents: 78864
diff changeset
    20
  def send(msg: A): Unit =
a0199212046a support for mailbox limit;
wenzelm
parents: 78864
diff changeset
    21
    if (limit <= 0) mailbox.change(msg :: _)
a0199212046a support for mailbox limit;
wenzelm
parents: 78864
diff changeset
    22
    else mailbox.guarded_access(msgs => if (msgs.length < limit) Some(((), msg :: msgs)) else None)
56693
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
    23
71144
d6b9dead8c8d tuned signature;
wenzelm
parents: 64370
diff changeset
    24
  def receive(timeout: Option[Time] = None): List[A] =
57417
29fe9bac501b more tight Mailbox: single list is sufficient for single receiver, reverse outside critical section;
wenzelm
parents: 56693
diff changeset
    25
    (mailbox.timed_access(_ => timeout.map(t => Time.now() + t),
29fe9bac501b more tight Mailbox: single list is sufficient for single receiver, reverse outside critical section;
wenzelm
parents: 56693
diff changeset
    26
      { case Nil => None case msgs => Some((msgs, Nil)) }) getOrElse Nil).reverse
56693
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
    27
78864
2024a2298d7a tuned signature;
wenzelm
parents: 75393
diff changeset
    28
  def await_empty(): Unit =
57417
29fe9bac501b more tight Mailbox: single list is sufficient for single receiver, reverse outside critical section;
wenzelm
parents: 56693
diff changeset
    29
    mailbox.guarded_access({ case Nil => Some(((), Nil)) case _ => None })
56693
0423c957b081 added Mailbox, as in ML;
wenzelm
parents:
diff changeset
    30
}