Package io.openraven.magpie.api

Interface Emitter

Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface Emitter

Emitter represents an abstract method of emitting discovery envelopes through the Magpie pipeline. Plugin implementation need not be aware of how envelopes traverse the pipeline or where the next destination is.

A plugin may emit 0+ envelopes for each discovery/processing invocation. It is not recommended that plugins attempt to collect multiple envelopes from upstream as Magpie makes no guarantee reception of all envelopes by a single plugin when multiple plugins exist on a single layer.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    emit(MagpieEnvelope env)
    Emit an envelope into the pipeline.

  • Method Details

    • emit

      void emit(MagpieEnvelope env)
      Emit an envelope into the pipeline. A plugin may emit an arbitrary number of envelopes.
      Parameters:
      env - The envelope being emitted into the pipeline.