io.stepfunc.dnp3

Enum LinkErrorMode

java.lang.Object

java.lang.Enum<LinkErrorMode>

io.stepfunc.dnp3.LinkErrorMode

All Implemented Interfaces:

Serializable, Comparable<LinkErrorMode>

public enum LinkErrorMode
extends Enum<LinkErrorMode>

Controls how errors in parsed link-layer frames are handled. This behavior is configurable for physical layers with built-in error correction like TCP as the connection might be through a terminal server.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSE Framing errors are bubbled up to calling code, closing the session.
DISCARD Framing errors are discarded.

Method Summary

Modifier and Type	Method and Description
static LinkErrorMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static LinkErrorMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISCARD

public static final LinkErrorMode DISCARD

Framing errors are discarded. The link-layer parser is reset on any error, and the parser begins scanning for 0x0564. This is always the behavior for serial ports.

CLOSE

public static final LinkErrorMode CLOSE

Framing errors are bubbled up to calling code, closing the session. Suitable for physical layers that provide error correction like TCP.

Method Detail

values

public static LinkErrorMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LinkErrorMode c : LinkErrorMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LinkErrorMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null