Package io.github.mahmoudimus.http2

Record Class Frame.Data

java.lang.Object

java.lang.Record

io.github.mahmoudimus.http2.Frame.Data

Record Components:

streamId - the nonzero stream identifier

data - the content bytes, retained without copying

endStream - whether this frame ends the stream

padding - padding octets including the Pad Length octet, or 0 for no padding

All Implemented Interfaces:

Frame

Enclosing interface:

Frame

public static record Frame.Data(int streamId, byte[] data, boolean endStream, int padding)
extends Record
implements Frame

DATA (§6.1): part of a stream's content.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.mahmoudimus.http2.Frame

Frame.Continuation, Frame.Data, Frame.GoAway, Frame.Headers, Frame.Ping, Frame.Priority, Frame.PrioritySpec, Frame.PushPromise, Frame.RstStream, Frame.Settings, Frame.Unknown, Frame.WindowUpdate

Field Summary

Fields inherited from interface io.github.mahmoudimus.http2.Frame

MAX_STREAM_ID

Constructor Summary

Constructors

Constructor	Description
Data(int streamId, byte[] data, boolean endStream)	Creates an unpadded DATA frame.
Data(int streamId, byte[] data, boolean endStream, int padding)	Creates DATA with a nonzero stream and valid padding.

Method Summary

Modifier and Type	Method	Description
byte[]	data()	Returns the value of the data record component.
boolean	endStream()	Returns the value of the endStream record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	flowControlledLength()	The bytes this frame counts against flow-control windows: data plus padding.
final int	hashCode()	Returns a hash code value for this object.
int	padding()	Returns the value of the padding record component.
int	streamId()	Returns the value of the streamId record component.
final String	toString()	Returns a string representation of this record class.
int	type()	The frame type code, one of the FrameType constants (or any value for Frame.Unknown).

Methods inherited from class java.lang.Object

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

Constructor Details

Data

public Data(int streamId,
 byte[] data,
 boolean endStream,
 int padding)

Creates DATA with a nonzero stream and valid padding.

Parameters:

streamId - the nonzero stream identifier

data - the content bytes, retained without copying

endStream - whether this frame ends the stream

padding - padding octets including the Pad Length octet, or 0 for no padding

Data

public Data(int streamId,
 byte[] data,
 boolean endStream)

Creates an unpadded DATA frame.

Parameters:

streamId - the nonzero stream identifier

data - the content bytes, retained without copying

endStream - whether this frame ends the stream

Method Details

type

public int type()

Description copied from interface: Frame

The frame type code, one of the FrameType constants (or any value for Frame.Unknown).

Specified by:

type in interface Frame

Returns:

the unsigned frame type code

flowControlledLength

public int flowControlledLength()

The bytes this frame counts against flow-control windows: data plus padding.

Returns:

the content length plus padding, in octets

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

streamId

public int streamId()

Returns the value of the streamId record component.

Specified by:

streamId in interface Frame

Returns:

the value of the streamId record component

data

public byte[] data()

Returns the value of the data record component.

Returns:

the value of the data record component

endStream

public boolean endStream()

Returns the value of the endStream record component.

Returns:

the value of the endStream record component

padding

public int padding()

Returns the value of the padding record component.

Returns:

the value of the padding record component