Struct hotmic::Sink [−][src]
pub struct Sink<T> { /* fields omitted */ }Metrics sink which aggregates and processes samples.
Methods
impl<T: Send + Eq + Hash + Display + Debug + Clone> Sink<T>[src]
impl<T: Send + Eq + Hash + Display + Debug + Clone> Sink<T>pub fn builder() -> Configuration<T>[src]
pub fn builder() -> Configuration<T>Gets a builder to configure a Sink instance with.
pub fn get_source(&self) -> Source<T>[src]
pub fn get_source(&self) -> Source<T>Creates a Source attached to this sink.
pub fn get_controller(&self) -> Controller<T>[src]
pub fn get_controller(&self) -> Controller<T>Creates a Controller attached to this sink.
pub fn turn(&mut self)[src]
pub fn turn(&mut self)Turns the sink, performing a single iteration of processing.
A single turn involves performing upkeep (adjusting histograms to make sure their windowing is correct) and doing a single poll to see if any new data or control messages are available.
By default, the poll delay, or how long the call to poll will wait before timing out, is
set at 100ms. This is important as we want to ensure the poll eventually returns during
periods of inactivity so it can be be recalled (when running via run) and perform
continued upkeep.
pub fn run(&mut self)[src]
pub fn run(&mut self)Runs the sink endlessly.
pub fn add_facet(&mut self, facet: Facet<T>)[src]
pub fn add_facet(&mut self, facet: Facet<T>)Registers a facet with the sink.
pub fn remove_facet(&mut self, facet: Facet<T>)[src]
pub fn remove_facet(&mut self, facet: Facet<T>)Deregisters a facet from the sink.