Top Fields Constructors Methods

io.undertow.server.protocol.framed

public Class SendFrameHeader

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.protocol.framed.SendFrameHeader

Imports

java.nio.ByteBuffer, io.undertow.connector.PooledByteBuffer

Author: Stuart Douglas

Field Summary

Modifier and Type	Field and Description
private final boolean	anotherFrameRequired
private final PooledByteBuffer	byteBuffer
private final int	reminingInBuffer
private final ByteBuffer	trailer

Constructor Summary

Access	Constructor and Description
public	SendFrameHeader(int reminingInBuffer, PooledByteBuffer byteBuffer, boolean anotherFrameRequired)
public	SendFrameHeader(int reminingInBuffer, PooledByteBuffer byteBuffer, boolean anotherFrameRequired, ByteBuffer trailer)
public	SendFrameHeader(int reminingInBuffer, PooledByteBuffer byteBuffer)
public	SendFrameHeader(PooledByteBuffer byteBuffer)

Method Summary

Modifier and Type	Method and Description
public PooledByteBuffer	Returns: The header byte buffer getByteBuffer()
public int	getRemainingInBuffer()
public ByteBuffer	getTrailer()
public boolean	isAnotherFrameRequired() Returns true if another frame is required after this one.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

anotherFrameRequired	back to summary
private final boolean anotherFrameRequired

byteBuffer	back to summary
private final PooledByteBuffer byteBuffer

reminingInBuffer	back to summary
private final int reminingInBuffer

trailer	back to summary
private final ByteBuffer trailer

Constructor Detail

SendFrameHeader	back to summary
public SendFrameHeader(int reminingInBuffer, PooledByteBuffer byteBuffer, boolean anotherFrameRequired)

SendFrameHeader	back to summary
public SendFrameHeader(int reminingInBuffer, PooledByteBuffer byteBuffer, boolean anotherFrameRequired, ByteBuffer trailer)

SendFrameHeader	back to summary
public SendFrameHeader(int reminingInBuffer, PooledByteBuffer byteBuffer)

SendFrameHeader	back to summary
public SendFrameHeader(PooledByteBuffer byteBuffer)

Method Detail

getByteBuffer	back to summary
public PooledByteBuffer getByteBuffer() Returns:PooledByteBuffer The header byte buffer

getRemainingInBuffer	back to summary
public int getRemainingInBuffer()

getTrailer	back to summary
public ByteBuffer getTrailer()

isAnotherFrameRequired	back to summary
public boolean isAnotherFrameRequired() Returns true if another frame is required after this one. Note that returning false does not mean that this is the last frame. This is used for protocols that require a trailing packet after all data has been written.