info.ganglia.gmetric4j.gmetric

Class AbstractProtocol

java.lang.Object

info.ganglia.gmetric4j.gmetric.AbstractProtocol

All Implemented Interfaces:

Protocol, Closeable, AutoCloseable

Direct Known Subclasses:

Protocolv30x, Protocolv31x

public abstract class AbstractProtocol
extends Object
implements Protocol

The base implementation for a protocol, does the socket work

Field Summary

Fields

Modifier and Type	Field and Description
protected String	group
protected int	port
protected InetAddress	udpAddr

Constructor Summary

Constructors

Constructor and Description
AbstractProtocol(String group, int port, GMetric.UDPAddressingMode mode, int ttl)

Method Summary

Modifier and Type	Method and Description
abstract void	announce(String name, String value, GMetricType type, String units, GMetricSlope slope, int tmax, int dmax, String groupName) Announces a metric
void	close() Closes the underlying socket to prevent socket leaks.
protected void	finalize()
protected void	send(byte[] buf, int len) Sends the provided byte buffer

Methods inherited from class java.lang.Object

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

Field Detail

udpAddr

protected InetAddress udpAddr

port

protected int port

group

protected String group

Constructor Detail

AbstractProtocol

public AbstractProtocol(String group,
                        int port,
                        GMetric.UDPAddressingMode mode,
                        int ttl)
                 throws IOException

Throws:

IOException

Method Detail

close

public void close()
           throws IOException

Closes the underlying socket to prevent socket leaks.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

send

protected void send(byte[] buf,
                    int len)
             throws Exception

Sends the provided byte buffer

Parameters:

buf - a buffer containing the message

len - the num of bytes to send from the buffer

Throws:

Exception

announce

public abstract void announce(String name,
                              String value,
                              GMetricType type,
                              String units,
                              GMetricSlope slope,
                              int tmax,
                              int dmax,
                              String groupName)
                       throws Exception

Description copied from interface: Protocol

Announces a metric

Specified by:

announce in interface Protocol

Parameters:

name - the metric name

value - the metric value

type - the metric type

units - the units

slope - the slope

tmax - the tmax

dmax - the dmax

groupName - the metric group

Throws:

Exception

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

See Also:

Object.finalize()