Trait/Object

de.sciss.filecache

TxnConsumer

Related Docs: object TxnConsumer | package filecache

Permalink

trait TxnConsumer[-A, +B] extends AnyRef

A Consumer simplifies resource management by maintaining a use count for each cached value. Furthermore, it combines a producer with a production function.

A

the key type

B

the value type

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TxnConsumer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def acquire(key: A)(implicit tx: InTxn): Future[B]

    Permalink

    Logically acquires a resource.

    Logically acquires a resource. If this is the first time acquire is called, this may call acquire on the underlying producer. Otherwise, it will simply re-use the already acquired resource and internally increment a use counter.

    key

    the resource key

    returns

    the resource value, possibly an uncompleted future if the value was not cached

  2. abstract def dispose()(implicit tx: InTxn): Unit

    Permalink

    Disposes the underlying producer (and thus invalidates this consumer as well).

    Disposes the underlying producer (and thus invalidates this consumer as well).

    See also

    TxnProducer#dispose

  3. abstract def release(key: A)(implicit tx: InTxn): Boolean

    Permalink

    Logically releases a resources.

    Logically releases a resources. This internally decrements a use counter. If the counter reaches zero, it actually calls release on the underlying producer.

    key

    the resource key

    returns

    true if the resource was actually released from the producer.

  4. abstract def usage(implicit tx: InTxn): Limit

    Permalink

    Reports the cache usage of the underlying producer.

    Reports the cache usage of the underlying producer.

    See also

    TxnProducer#usage

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped