Package com.arpnetworking.metrics.common.sources

Class ActorSource

java.lang.Object

com.arpnetworking.metrics.common.sources.BaseSource

com.arpnetworking.metrics.common.sources.ActorSource

All Implemented Interfaces:

com.arpnetworking.commons.observer.Observable, Source

Direct Known Subclasses:

BaseTcpSource, HttpSource, StatsdSource

public abstract class ActorSource
extends BaseSource

Serves as a base class for actor-based sources.

Author:

Brandon Arp (brandon dot arp at smartsheet dot com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActorSource.Builder<B extends ActorSource.Builder<B,S>,S extends Source>	ActorSource BaseSource.Builder implementation.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActorSource(ActorSource.Builder<?,? extends ActorSource> builder)	Protected constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract org.apache.pekko.actor.Props	createProps()	Create a props for the actor to be created at the provided path.
protected org.apache.pekko.actor.ActorRef	getActor()	Return an ActorRef to this source's Pekko actor.
protected org.apache.pekko.actor.ActorSystem	getActorSystem()	Return the ActorSystem used by this source.
void	start()	Called to allow the source to start producing records.
void	stop()	Called to allow the source to clean-up.

Methods inherited from class com.arpnetworking.metrics.common.sources.BaseSource

attach, detach, getMetricSafeName, getName, notify, toLogValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ActorSource

protected ActorSource(ActorSource.Builder<?,? extends ActorSource> builder)

Protected constructor.

Parameters:

builder - Instance of ActorSource.Builder.

Method Details

start

public void start()

Description copied from interface: Source

Called to allow the source to start producing records.

stop

public void stop()

Description copied from interface: Source

Called to allow the source to clean-up. No further records should be produced.

getActorSystem

protected org.apache.pekko.actor.ActorSystem getActorSystem()

Return the ActorSystem used by this source.

Returns:

The ActorSystem used by this source.

getActor

protected org.apache.pekko.actor.ActorRef getActor()

Return an ActorRef to this source's Pekko actor.

Returns:

An ActorRef to this source's Pekko actor.

createProps

protected abstract org.apache.pekko.actor.Props createProps()

Create a props for the actor to be created at the provided path.

Returns:

A props to create the actor with.