info.ganglia.gmetric4j.gmetric

Class AbstractProtocol

java.lang.Object

info.ganglia.gmetric4j.gmetric.AbstractProtocol

All Implemented Interfaces:

Protocol, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

Protocolv30x, Protocolv31x

public abstract class AbstractProtocol
extends java.lang.Object
implements Protocol

The base implementation for a protocol, does the socket work

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	group
protected int	port
private java.net.DatagramSocket	socket
protected java.net.InetAddress	udpAddr

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract void	announce(java.lang.String name, java.lang.String value, GMetricType type, java.lang.String units, GMetricSlope slope, int tmax, int dmax, java.lang.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 java.net.InetAddress udpAddr

port

protected int port

group

protected java.lang.String group

socket

private java.net.DatagramSocket socket

Constructor Detail

AbstractProtocol

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

Throws:

java.io.IOException

Method Detail

close

public void close()
           throws java.io.IOException

Closes the underlying socket to prevent socket leaks.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

send

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

Sends the provided byte buffer

Parameters:

buf - a buffer containing the message

len - the num of bytes to send from the buffer

Throws:

java.lang.Exception

announce

public abstract void announce(java.lang.String name,
                              java.lang.String value,
                              GMetricType type,
                              java.lang.String units,
                              GMetricSlope slope,
                              int tmax,
                              int dmax,
                              java.lang.String groupName)
                       throws java.lang.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:

java.lang.Exception

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

See Also:

Object.finalize()