org.eclipse.californium.scandium

Class DtlsHealthLogger

java.lang.Object

org.eclipse.californium.elements.util.CounterStatisticManager

org.eclipse.californium.scandium.DtlsHealthLogger

All Implemented Interfaces:

DtlsHealth

Direct Known Subclasses:

DtlsClusterHealthLogger

public class DtlsHealthLogger
extends org.eclipse.californium.elements.util.CounterStatisticManager
implements DtlsHealth

Health implementation using counter and logging for results.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.californium.elements.util.SimpleCounterStatistic.AlignGroup	align

Fields inherited from class org.eclipse.californium.elements.util.CounterStatisticManager

tag

Constructor Summary

Constructors

Constructor and Description
DtlsHealthLogger() Create passive dtls health logger.
DtlsHealthLogger(String tag) Create passive dtls health logger with logging tag.
DtlsHealthLogger(String tag, boolean udp, int interval, ScheduledExecutorService executor) Deprecated. use DtlsHealthLogger(String, int, ScheduledExecutorService) instead.
DtlsHealthLogger(String tag, int interval, ScheduledExecutorService executor) Create active dtls health logger with logging tag.

Method Summary

Methods

Modifier and Type	Method and Description
void	dump()
void	dump(String tag, int maxConnections, int remainingCapacity, int pendingWithoutVerify) Dump health data.
protected void	dump(String head, StringBuilder log) Dump additional health data.
void	endHandshake(boolean success) Report ended handshake.
boolean	isEnabled() Check, if collecting health data is enabled.
protected boolean	isUsed() Check, if health logger is used.
void	receivingRecord(boolean drop) Report receiving record
void	sendingRecord(boolean drop) Report sending record.
void	startHandshake() Report started handshake.

Methods inherited from class org.eclipse.californium.elements.util.CounterStatisticManager

add, add, addByKey, get, getCounter, getTag, reset, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

align

protected final org.eclipse.californium.elements.util.SimpleCounterStatistic.AlignGroup align

Constructor Detail

DtlsHealthLogger

public DtlsHealthLogger()

Create passive dtls health logger.

DtlsHealthLogger

public DtlsHealthLogger(String tag)

Create passive dtls health logger with logging tag.

Parameters:

tag - logging tag

DtlsHealthLogger

@Deprecated
public DtlsHealthLogger(String tag,
                           boolean udp,
                           int interval,
                           ScheduledExecutorService executor)

Deprecated. use DtlsHealthLogger(String, int, ScheduledExecutorService) instead.

Create active dtls health logger with logging tag.

Parameters:

tag - logging tag

udp - not used

interval - interval in seconds. 0 to disable actively calling dump().

executor - executor to schedule active calls of dump().

DtlsHealthLogger

public DtlsHealthLogger(String tag,
                int interval,
                ScheduledExecutorService executor)

Create active dtls health logger with logging tag.

Parameters:

tag - logging tag

interval - interval in seconds. 0 to disable actively calling dump().

executor - executor to schedule active calls of dump().

Since:

2.5

Method Detail

dump

public void dump()

Specified by:

dump in class org.eclipse.californium.elements.util.CounterStatisticManager

dump

public void dump(String tag,
        int maxConnections,
        int remainingCapacity,
        int pendingWithoutVerify)

Description copied from interface: DtlsHealth

Dump health data.

Specified by:

dump in interface DtlsHealth

Parameters:

tag - logging tag

maxConnections - maximum number of connections

remainingCapacity - remaining capacity for connections

pendingWithoutVerify - pending handshakes without verification

isUsed

protected boolean isUsed()

Check, if health logger is used.

Returns:

true, if used and dump must be written, false, otherwise.

Since:

2.5

dump

protected void dump(String head,
        StringBuilder log)

Dump additional health data. Intended to be overridden by derived class.

Parameters:

head - head for logging lines

log - logging lines

Since:

2.5

isEnabled

public boolean isEnabled()

Description copied from interface: DtlsHealth

Check, if collecting health data is enabled.

Specified by:

isEnabled in interface DtlsHealth

Specified by:

isEnabled in class org.eclipse.californium.elements.util.CounterStatisticManager

Returns:

true, if health is enabled, false, otherwise.

startHandshake

public void startHandshake()

Description copied from interface: DtlsHealth

Report started handshake.

Specified by:

startHandshake in interface DtlsHealth

endHandshake

public void endHandshake(boolean success)

Description copied from interface: DtlsHealth

Report ended handshake.

Specified by:

endHandshake in interface DtlsHealth

Parameters:

success - true for successful handshake, false for failed handshake.

receivingRecord

public void receivingRecord(boolean drop)

Description copied from interface: DtlsHealth

Report receiving record

Specified by:

receivingRecord in interface DtlsHealth

Parameters:

drop - true, if record is dropped, false, if record is received.

sendingRecord

public void sendingRecord(boolean drop)

Description copied from interface: DtlsHealth

Report sending record.

Specified by:

sendingRecord in interface DtlsHealth

Parameters:

drop - true, if record is dropped, false, if record is to be sent.