Package org.apache.hadoop.hdfs.protocol.datatransfer

Class PipelineAck

java.lang.Object

org.apache.hadoop.hdfs.protocol.datatransfer.PipelineAck

@Private
@Evolving
public class PipelineAck
extends java.lang.Object

Pipeline Acknowledgment

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PipelineAck.ECN
static class	PipelineAck.SLOW

Field Summary

Fields

Modifier and Type	Field	Description
static long	UNKOWN_SEQNO

Constructor Summary

Constructors

Constructor	Description
PipelineAck()	default constructor
PipelineAck(long seqno, int[] replies)	Constructor assuming no next DN in pipeline
PipelineAck(long seqno, int[] replies, long downstreamAckTimeNanos)	Constructor

Method Summary

Modifier and Type	Method	Description
static int	combineHeader(PipelineAck.ECN ecn, org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status status)
static int	combineHeader(PipelineAck.ECN ecn, org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status status, PipelineAck.SLOW slow)
long	getDownstreamAckTimeNanos()	Get the time elapsed for downstream ack RTT in nanoseconds
static PipelineAck.ECN	getECNFromHeader(int header)
int	getFlag(int i)
int	getHeaderFlag(int i)	get the header flag of ith reply
short	getNumOfReplies()	Get the number of replies
org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status	getOOBStatus()	Returns the OOB status if this ack contains one.
static org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status	getRestartOOBStatus()	Get the Restart OOB ack status
long	getSeqno()	Get the sequence number
static PipelineAck.SLOW	getSLOWFromHeader(int header)
static org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status	getStatusFromHeader(int header)
static boolean	isRestartOOBStatus(org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status st)	return true if it is the restart OOB status code
boolean	isSuccess()	Check if this ack contains error status
void	readFields(java.io.InputStream in)	Writable interface
static int	setSLOWForHeader(int old, PipelineAck.SLOW slow)
static int	setStatusForHeader(int old, org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status status)
java.lang.String	toString()
void	write(java.io.OutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

UNKOWN_SEQNO

public static final long UNKOWN_SEQNO

See Also:

Constant Field Values

Constructor Detail

PipelineAck

public PipelineAck()

default constructor

PipelineAck

public PipelineAck(long seqno,
                   int[] replies)

Constructor assuming no next DN in pipeline

Parameters:

seqno - sequence number

replies - an array of replies

PipelineAck

public PipelineAck(long seqno,
                   int[] replies,
                   long downstreamAckTimeNanos)

Constructor

Parameters:

seqno - sequence number

replies - an array of replies

downstreamAckTimeNanos - ack RTT in nanoseconds, 0 if no next DN in pipeline

Method Detail

getSeqno

public long getSeqno()

Get the sequence number

Returns:

the sequence number

getNumOfReplies

public short getNumOfReplies()

Get the number of replies

Returns:

the number of replies

getHeaderFlag

public int getHeaderFlag(int i)

get the header flag of ith reply

getFlag

public int getFlag(int i)

getDownstreamAckTimeNanos

public long getDownstreamAckTimeNanos()

Get the time elapsed for downstream ack RTT in nanoseconds

Returns:

time elapsed for downstream ack in nanoseconds, 0 if no next DN in pipeline

isSuccess

public boolean isSuccess()

Check if this ack contains error status

Returns:

true if all statuses are SUCCESS

getOOBStatus

public org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status getOOBStatus()

Returns the OOB status if this ack contains one.

Returns:

null if it is not an OOB ack.

getRestartOOBStatus

public static org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status getRestartOOBStatus()

Get the Restart OOB ack status

isRestartOOBStatus

public static boolean isRestartOOBStatus(org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status st)

return true if it is the restart OOB status code

readFields

public void readFields(java.io.InputStream in)
                throws java.io.IOException

Writable interface

Throws:

java.io.IOException

write

public void write(java.io.OutputStream out)
           throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStatusFromHeader

public static org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status getStatusFromHeader(int header)

getECNFromHeader

public static PipelineAck.ECN getECNFromHeader(int header)

getSLOWFromHeader

public static PipelineAck.SLOW getSLOWFromHeader(int header)

setStatusForHeader

public static int setStatusForHeader(int old,
                                     org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status status)

setSLOWForHeader

@VisibleForTesting
public static int setSLOWForHeader(int old,
                                   PipelineAck.SLOW slow)

combineHeader

public static int combineHeader(PipelineAck.ECN ecn,
                                org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status status)

combineHeader

public static int combineHeader(PipelineAck.ECN ecn,
                                org.apache.hadoop.hdfs.protocol.proto.DataTransferProtos.Status status,
                                PipelineAck.SLOW slow)