de.sciss.lucre.synth.BlockAllocator.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of lucresynth_2.11 Show documentation

Transactional extension for ScalaCollider

There is a newer version: 3.30.0

/*
 *  BlockAllocator.scala
 *  (SoundProcesses)
 *
 *  Copyright (c) 2010-2019 Hanns Holger Rutz. All rights reserved.
 *
 *	This software is published under the GNU Lesser General Public License v2.1+
 *
 *
 *  For further information, please contact Hanns Holger Rutz at
 *  [email protected]
 */

package de.sciss.lucre.synth

import impl.{BlockAllocatorImpl => Impl}
import scala.concurrent.stm.InTxn

object BlockAllocator {
  /**
   * Creates a new block allocator with the given address range.
   *
   * @param start   the start address (inclusive)
   * @param stop    the stop address (exclusive)
   */
  def apply(name: String, stop: Int, start: Int = 0): BlockAllocator = Impl(name, start = start, stop = stop)
}

trait BlockAllocator {
  /** Allocates a new block with a given size.
    *
    * @param size the size (or number of channels) to allocate.
    * @return     the allocated address, or `-1` if no free blocks are available
    */
  def alloc(size: Int = 1)(implicit tx: InTxn): Int

  /** Frees a block with given address and size.
    *
    * @param address the address of the allocated block
    * @param size    the size (or number of channels) of the allocated block
    */
  def free(address: Int, size: Int)(implicit tx: InTxn): Unit

  def consistencyCheck()(implicit tx: InTxn): Unit
}