wvlet.airframe.canvas.Memory.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of airframe-canvas_3 Show documentation

Airframe off-heap memory library

There is a newer version: 24.11.0

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package wvlet.airframe.canvas
import java.lang.ref.{PhantomReference, ReferenceQueue}

/**
  */
sealed abstract class Memory {

  /**
    * Allocated memory address
    * @return
    */
  def address: Long

  /**
    * Memory size
    */
  def size: Long

  def memoryAllocator: OffHeapMemoryAllocator
  def release: Unit
}

case class OffHeapMemory(address: Long, size: Long, memoryAllocator: OffHeapMemoryAllocator) extends Memory {
  override def release: Unit = memoryAllocator.release(this)
}

final class MemoryReference(m: Memory, queue: ReferenceQueue[Memory]) extends PhantomReference[Memory](m, queue) {
  final val address = m.address
}