org.xbill.DNS

Class TcpKeepaliveOption

java.lang.Object

org.xbill.DNS.EDNSOption

org.xbill.DNS.TcpKeepaliveOption

public class TcpKeepaliveOption
extends EDNSOption

TCP Keepalive EDNS0 Option, as defined in https://tools.ietf.org/html/rfc7828

See Also:

OPTRecord

Nested Class Summary

Nested classes/interfaces inherited from class org.xbill.DNS.EDNSOption

EDNSOption.Code

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Integer	timeout the timeout
private static java.time.Duration	UPPER_LIMIT upper limit of the duration (exclusive)

Constructor Summary

Constructors

Constructor and Description
TcpKeepaliveOption() Constructor for an option with no timeout
TcpKeepaliveOption(java.time.Duration t) Constructor for an option with a given timeout.
TcpKeepaliveOption(int t) Constructor for an option with a given timeout.

Method Summary

Modifier and Type	Method and Description
java.util.OptionalInt	getTimeout() Returns the timeout.
java.util.Optional<java.time.Duration>	getTimeoutDuration() Returns the timeout as a Duration.
(package private) void	optionFromWire(DNSInput in) Converts the wire format of an EDNS Option (the option data only) into the type-specific format.
(package private) java.lang.String	optionToString() Returns a string representation of the option parameters.
(package private) void	optionToWire(DNSOutput out) Converts an EDNS Option (the type-specific option data only) into wire format.

Methods inherited from class org.xbill.DNS.EDNSOption

equals, fromWire, fromWire, getCode, getData, hashCode, toString, toWire, toWire

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

timeout

private java.lang.Integer timeout

the timeout

UPPER_LIMIT

private static final java.time.Duration UPPER_LIMIT

upper limit of the duration (exclusive)

Constructor Detail

TcpKeepaliveOption

public TcpKeepaliveOption()

Constructor for an option with no timeout

TcpKeepaliveOption

public TcpKeepaliveOption(int t)

Constructor for an option with a given timeout.

Parameters:

t - the timeout time in 100ms units, may not be negative or larger than 65535

TcpKeepaliveOption

public TcpKeepaliveOption(java.time.Duration t)

Constructor for an option with a given timeout. As the timeout has a coarser granularity than the Duration class, values are rounded down.

Parameters:

t - the timeout time, must not be negative and must be lower than 6553.5 seconds

Method Detail

getTimeout

public java.util.OptionalInt getTimeout()

Returns the timeout.

Returns:

the timeout in 100ms units

getTimeoutDuration

public java.util.Optional<java.time.Duration> getTimeoutDuration()

Returns the timeout as a Duration.

Returns:

the timeout

optionFromWire

void optionFromWire(DNSInput in)
             throws java.io.IOException

Converts the wire format of an EDNS Option (the option data only) into the type-specific format.

Specified by:

optionFromWire in class EDNSOption

Parameters:

in - The input stream.

Throws:

java.io.IOException

optionToWire

void optionToWire(DNSOutput out)

Converts an EDNS Option (the type-specific option data only) into wire format.

Specified by:

optionToWire in class EDNSOption

Parameters:

out - The output stream.

optionToString

java.lang.String optionToString()

Returns a string representation of the option parameters.

Specified by:

optionToString in class EDNSOption

Returns:

the string representation