Skip to content
This repository has been archived by the owner on Jan 6, 2023. It is now read-only.

Latest commit

 

History

History
35 lines (24 loc) · 854 Bytes

plugins.adoc

File metadata and controls

35 lines (24 loc) · 854 Bytes

Plugins

Plugins serve as an abstract to compose mechanisms for getting data in and out of Onyx. See the README.md of the project for a list of official Onyx plugins, or keep reading to roll your own.

Interfaces

In order to implement a plugin, one or more protocols need to be implemented from the plugin interfaces.

Input Plugin

Required interface implementations:

  • Plugin (stop/start)

  • Input

  • Checkpointed

  • BarrierSynchronization

Output Plugin

Required interface implementations:

  • Plugin (stop/start)

  • Output

  • Checkpointed

  • BarrierSynchronization

Templates

To help move past the boilerplate of creating new plugins, use Leiningen with onyx-plugin to generate a template.