Package com.arpnetworking.tsdcore.sinks

Class TcpSink

java.lang.Object

com.arpnetworking.tsdcore.sinks.BaseSink

com.arpnetworking.tsdcore.sinks.TcpSink

All Implemented Interfaces:

Sink

Direct Known Subclasses:

CarbonSink

public abstract class TcpSink
extends BaseSink

Abstract publisher to send data to a server via Pekko TCP channel. This class leverages a TcpSinkActor to interact with the TCP channel.

Author:

Brandon Arp (brandonarp at gmail dot com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TcpSink.Builder<B extends BaseSink.Builder<B,S>,S extends TcpSink>	Implementation of base builder pattern for TcpSink.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()	Called to allow the publisher to clean-up.
void	recordAggregateData(PeriodicData data)	Called when additional PeriodicData instances are available for publication.
protected abstract org.apache.pekko.util.ByteString	serializeData(PeriodicData periodicData)	Serialize a PeriodicData to binary.
CompletionStage<Void>	shutdownGracefully()	Called to allow the publisher to clean-up.
protected void	start(TcpSink.Builder<?,?> builder)	Starts the actor for the sink.
Object	toLogValue()	Generate a Steno log compatible representation.

Methods inherited from class com.arpnetworking.tsdcore.sinks.BaseSink

getMetricSafeName, getName, toString

Methods inherited from class java.lang.Object

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

Constructor Details

TcpSink

protected TcpSink(TcpSink.Builder<?,?> builder)

Protected constructor.

Parameters:

builder - Instance of TcpSink.Builder.

Method Details

close

public void close()

Called to allow the publisher to clean-up. No further calls to recordAggregation will be made after a call to close.

shutdownGracefully

public CompletionStage<Void> shutdownGracefully()

Description copied from interface: Sink

Called to allow the publisher to clean-up. No further calls to recordAggregation will be made after a call to close.

Returns:

A CompletionStage that completes when the sink is closed.

toLogValue

public Object toLogValue()

Generate a Steno log compatible representation.

Overrides:

toLogValue in class BaseSink

Returns:

Steno log compatible representation.

recordAggregateData

public void recordAggregateData(PeriodicData data)

Called when additional PeriodicData instances are available for publication.

Parameters:

data - The {PeriodicData to be published.

serializeData

protected abstract org.apache.pekko.util.ByteString serializeData(PeriodicData periodicData)

Serialize a PeriodicData to binary.

Parameters:

periodicData - Data to serialize.

Returns:

ByteString representing the periodicData.

start

protected void start(TcpSink.Builder<?,?> builder)

Starts the actor for the sink. This is necessary to prevent references to 'this' from escaping the constructor.

Parameters:

builder - The builder used to create the sink.