abstract class Event extends AnyRef
An Event that can be fired.
- Alphabetic
- By Inheritance
- Event
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Event()
Abstract Value Members
- abstract def destroy(): Unit
Clean up when destroyed.
- abstract def fire(data: Map[String, AnyRef]): Unit
Fire an event with the given structured data.
Fire an event with the given structured data.
- data
structured event data
- abstract def isEnabled(): Boolean
Whether this event is enabled for firing.
Whether this event is enabled for firing.
- returns
whether this event is enabled
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fire(data: Supplier[Map[String, AnyRef]]): Unit
Fire an event, when enabled, using the lazily supplied data.
Fire an event, when enabled, using the lazily supplied data.
- data
supplier of data, only accessed if event is enabled
- def fireLimited(data: Supplier[Map[String, AnyRef]]): Unit
Fire an event, when enabled, using the lazily supplied data.
Fire an event, when enabled, using the lazily supplied data.
This can be used by events to be notified of rate limited triggers as well, to do things like counting the total number of times being fired, even if some are not sent off to the receiver.
- data
supplier of data, only accessed if event is enabled
- def fireLimited(data: Map[String, AnyRef]): Unit
Fire an event with the given structured data.
Fire an event with the given structured data.
This can be used by events to be notified of rate limited triggers as well, to do things like counting the total number of times being fired, even if some are not sent off to the receiver.
- data
structured event data
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
This is the public API for Cinnamon.
The com.lightbend.cinnamon package contains the public Cinnamon API.
See the complete list of Cinnamon packages on the right.
Cinnamon Events and Metrics
For the custom events API see
CinnamonEvents.For the custom metrics API see
CinnamonMetrics.Stopwatch
For the Stopwatch API see
Stopwatch.Coda Hale Metrics
For creating custom Coda Hale Metrics reporters see the com.lightbend.cinnamon.chmetrics.reporter package.