net.named_data.jndn

Class NetworkNack

java.lang.Object

net.named_data.jndn.NetworkNack

public class NetworkNack
extends Object

NetworkNack represents a network Nack packet and includes a Nack reason.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkNack.Reason A NetworkNack.Reason specifies the reason in a NetworkNack packet.

Constructor Summary

Constructors

Constructor and Description
NetworkNack()

Method Summary

Modifier and Type	Method and Description
static NetworkNack	getFirstHeader(LpPacket lpPacket) Get the first header field in lpPacket which is a NetworkNack.
int	getOtherReasonCode() Get the reason code from the packet which is other than a recognized Reason enum value.
NetworkNack.Reason	getReason() Get the network Nack reason.
NetworkNack	setOtherReasonCode(int otherReasonCode) Set the packet's reason code to use when the reason enum is Reason.OTHER_CODE.
NetworkNack	setReason(NetworkNack.Reason reason) Set the network Nack reason.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkNack

public NetworkNack()

Method Detail

getReason

public NetworkNack.Reason getReason()

Get the network Nack reason.

Returns:

The reason enum value. If this is Reason.OTHER_CODE, then call getOtherReasonCode() to get the unrecognized reason code.

getOtherReasonCode

public int getOtherReasonCode()

Get the reason code from the packet which is other than a recognized Reason enum value. This is only meaningful if getReason() is Reason.OTHER_CODE.

Returns:

The reason code.

setReason

public NetworkNack setReason(NetworkNack.Reason reason)

Set the network Nack reason.

Parameters:

reason - The network Nack reason enum value. If the packet's reason code is not a recognized Reason enum value, use Reason.OTHER_CODE and call setOtherReasonCode().

Returns:

This NetworkNack so that you can chain calls to update values.

setOtherReasonCode

public NetworkNack setOtherReasonCode(int otherReasonCode)

Set the packet's reason code to use when the reason enum is Reason.OTHER_CODE. If the packet's reason code is a recognized enum value, just call setReason().

Parameters:

otherReasonCode - The packet's unrecognized reason code, which must be non-negative.

Returns:

This NetworkNack so that you can chain calls to update values.

getFirstHeader

public static NetworkNack getFirstHeader(LpPacket lpPacket)

Get the first header field in lpPacket which is a NetworkNack. This is an internal method which the application normally would not use.

Parameters:

lpPacket - The LpPacket with the header fields to search.

Returns:

The first NetworkNack header field, or null if not found.