KituraCache

KituraCache is an in-memory, thread-safe cache which allows you to store objects against a unique, Hashable key.

Swift version

The latest version of KituraCache requires Swift 4.0 but recommends using 4.1.2 or newer. You can download this version of the Swift binaries by following this link. Compatibility with other Swift versions is not guaranteed.

Usage

Add dependencies

Add the Kitura-Cache package to the dependencies within your application’s Package.swift file. Substitute "x.x.x" with the latest Kitura-Cache release.

.package(url: "https://github.com/Kitura/Kitura-Cache.git", from: "x.x.x")

Add KituraCache to your target’s dependencies:

.target(name: "example", dependencies: ["KituraCache"]),

Import package

import KituraCache

Example

To use KituraCache, add the dependencies and import the package as defined above, then initialize:

let cache = KituraCache()

If no arguments are provided, the default cache will be non-expiring and a check will be made every 10 minutes to determine whether any entries need to be removed.

To add an entry to the cache, or update an entry if the key already exists:

In the following examples, item is a struct with an integer id field.

cache.setObject(item, forKey: item.id)

To retrieve an entry from the cache:

let cache = KituraCache()
...
if let item = cache.object(forKey: 1) {
    //Object with key of 1 retrieved from cache.
    ...
}
else {
    //No object stored in cache with key of 1.
    ...
}

To delete a single entry, pass the entry’s key as a parameter:

cache.removeObject(forKey: 1)

To reset the cache and its Statistics:

cache.flush()

API Documentation

For more information visit our API reference.

Community

We love to talk server-side Swift, and Kitura. Join our Slack to meet the team!

License

This library is licensed under Apache 2.0. Full license text is available in LICENSE.