NetModules.Cache.MemoryCache 1.3.8

NetModules.Cache

NetModules.Cache is a basic event caching module that is built using the NetModules architecture.

This repository consists of two libraries:

• NetModules.Cache.MemoryCache: A library that contains a basic in-memory caching module.
• NetModules.Cache.Events: A library that contains helper events for testing cached events, and requesting cached data on demand.

It enables a simple in-memory caching solution for NetModules Events and can be configured to cache any event type that implements the IEvent interface, with the exception of an event that has assigned a strict handler using the EventHandlerAttribute.

Applications that frequently process identical event requests benefit from caching to reduce redundant processing and speed up response times. MemoryCacheModule provides an efficient caching layer by:

• Storing event output based on event names and input parameters.
• Allowing modules to control caching behavior dynamically.
• Providing fine-grained cache expiration management.

Features

• Event-Based Caching: Stores event output using input parameters as cache keys.
• Dynamic Expiry Control: Set custom expiration times per event.
• Metadata-Driven Behavior: Control caching at runtime using event metadata.
• Efficient Handling: Automatically retrieves cached data when available.

Getting Started

Installation

To use NetModules.Cache, MemoryCacheModule, add the library to your ModuleHost project via NuGet Package Manager:

Install-Package NetModules.Cache.MemoryCache

To use NetModules.Cache.Events, and request cache data on demand from another module, add the events library to your Module project via NuGet Package Manager:

Install-Package NetModules.Cache.Events

While not required, NetModules.Cache.Events contains events that can be handled by an event caching module, to return a cached event output on demand. A usage example could be a clustering module system, where a peer may request a cached output from another peer.

Setup and Configuration

When you install MemoryCacheModule, it will automatically register itself with the ModuleHost and start caching events using the default configuration (see included file: NetModules.Cache.MemoryCache.MemoryCacheModule.settings.default.json). You can configure the caching behavior by creating your own settings file "NetModules.Cache.MemoryCache.MemoryCacheModule.settings.json" and modifying/adding settings accordingly.

Here is an example configuration file that will cache all events for 1 hour, but only cache MyCustomModuleEvents.MyExampleEventName event for 1 second...

{
  "defaultExpire": 3600,
  "expire": {
    "NetModules.Events.LoggingEvent": 0,
    "MyCustomModuleEvents.MyExampleEventName": 1
  },
  "cacheWithMeta": true,
  "excludeMetaKeys": ["id", "handlers"],
  "cacheUniqueKeys": true
}

Contributing

We welcome contributions! To get involved:

1. Fork NetModules.Cache, make improvements, and submit a pull request.
2. Code will be reviewed upon submission.
3. Join discussions via the issues board.

License

NetModules.Cache is licensed under the MIT License, allowing unrestricted use, modification, and distribution. If you use NetModules.Cache in your own project, we’d love to hear about your experience, and possibly feature you on our website!

Full documentation coming soon!

This project references NetTools.Cache for strict ICachedObject and ICacheController implementation.

NetModules Foundation