net.bjoernpetersen.musicbot.spi.loader.ResourceCache.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of musicbot Show documentation

Core library of JMusicBot, which plays music from various providers.

There is a newer version: 0.25.0

package net.bjoernpetersen.musicbot.spi.loader

import net.bjoernpetersen.musicbot.api.player.Song

/**
 * Manages resources and actively frees unused resources.
 */
interface ResourceCache {

    /**
     * Looks up the resource from the cache, otherwise invokes [SongLoader.load].
     *
     * @return a resource
     */
    suspend fun get(song: Song): Resource

    /**
     * Frees all resources and renders this instance unusable.
     */
    suspend fun close()
}