com.linecorp.armeria.unsafe

Class ByteBufHttpData

java.lang.Object

com.linecorp.armeria.common.AbstractHttpData

com.linecorp.armeria.unsafe.ByteBufHttpData

All Implemented Interfaces:

HttpData, HttpObject, io.netty.buffer.ByteBufHolder, io.netty.util.ReferenceCounted

@UnstableApi
public final class ByteBufHttpData
extends AbstractHttpData
implements io.netty.buffer.ByteBufHolder

An HttpData that is backed by a ByteBuf for optimizing certain internal use cases. Not for general use.

Field Summary

Fields inherited from interface com.linecorp.armeria.common.HttpData

EMPTY_DATA

Constructor Summary

Constructors

Constructor and Description
ByteBufHttpData(io.netty.buffer.ByteBuf buf, boolean endOfStream) Constructs a new ByteBufHttpData.

Method Summary

Modifier and Type	Method and Description
byte[]	array() Returns the underlying byte array of this data.
io.netty.buffer.ByteBuf	content()
ByteBufHttpData	copy()
ByteBufHttpData	duplicate()
protected byte	getByte(int index) Gets the byte value at the given index.
boolean	isEmpty() Returns whether the HttpData.length() is 0.
boolean	isEndOfStream() Tells whether the stream should be ended when writing this object.
int	length() Returns the length of this data.
int	refCnt()
boolean	release()
boolean	release(int decrement)
ByteBufHttpData	replace(io.netty.buffer.ByteBuf content)
ByteBufHttpData	retain()
ByteBufHttpData	retain(int increment)
ByteBufHttpData	retainedDuplicate()
InputStream	toInputStream() Returns a new InputStream that is sourced from this data.
String	toString()
String	toString(Charset charset) Decodes this data into a String.
ByteBufHttpData	touch()
ByteBufHttpData	touch(Object hint)
ByteBufHttpData	withEndOfStream() Returns a new HttpData whose HTTP/2 endOfStream flag is set.

Methods inherited from class com.linecorp.armeria.common.AbstractHttpData

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.common.HttpData

copyOf, copyOf, copyOf, empty, of, of, of, of, of, of, ofAscii, ofAscii, ofAscii, offset, ofUtf8, ofUtf8, ofUtf8, toReader, toReaderAscii, toReaderUtf8, toStringAscii, toStringUtf8, wrap, wrap, wrap

Constructor Detail

ByteBufHttpData

public ByteBufHttpData(io.netty.buffer.ByteBuf buf,
                       boolean endOfStream)

Constructs a new ByteBufHttpData. Ownership of buf is taken by this ByteBufHttpData, which must not be mutated anymore.

Method Detail

isEndOfStream

public boolean isEndOfStream()

Description copied from interface: HttpObject

Tells whether the stream should be ended when writing this object. This can be useful for HttpHeaders-only responses or to more efficiently close the stream along with the last piece of HttpData. This only has meaning for HttpObject writers, not readers.

Specified by:

isEndOfStream in interface HttpObject

array

public byte[] array()

Description copied from interface: HttpData

Returns the underlying byte array of this data.

Specified by:

array in interface HttpData

length

public int length()

Description copied from interface: HttpData

Returns the length of this data.

Specified by:

length in interface HttpData

isEmpty

public boolean isEmpty()

Description copied from interface: HttpData

Returns whether the HttpData.length() is 0.

Specified by:

isEmpty in interface HttpData

refCnt

public int refCnt()

Specified by:

refCnt in interface io.netty.util.ReferenceCounted

retain

public ByteBufHttpData retain()

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface io.netty.util.ReferenceCounted

retain

public ByteBufHttpData retain(int increment)

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface io.netty.util.ReferenceCounted

touch

public ByteBufHttpData touch()

Specified by:

touch in interface io.netty.buffer.ByteBufHolder

Specified by:

touch in interface io.netty.util.ReferenceCounted

touch

public ByteBufHttpData touch(Object hint)

Specified by:

touch in interface io.netty.buffer.ByteBufHolder

Specified by:

touch in interface io.netty.util.ReferenceCounted

release

public boolean release()

Specified by:

release in interface io.netty.util.ReferenceCounted

release

public boolean release(int decrement)

Specified by:

release in interface io.netty.util.ReferenceCounted

content

public io.netty.buffer.ByteBuf content()

Specified by:

content in interface io.netty.buffer.ByteBufHolder

copy

public ByteBufHttpData copy()

Specified by:

copy in interface io.netty.buffer.ByteBufHolder

duplicate

public ByteBufHttpData duplicate()

Specified by:

duplicate in interface io.netty.buffer.ByteBufHolder

retainedDuplicate

public ByteBufHttpData retainedDuplicate()

Specified by:

retainedDuplicate in interface io.netty.buffer.ByteBufHolder

replace

public ByteBufHttpData replace(io.netty.buffer.ByteBuf content)

Specified by:

replace in interface io.netty.buffer.ByteBufHolder

getByte

protected byte getByte(int index)

Description copied from class: AbstractHttpData

Gets the byte value at the given index.

Specified by:

getByte in class AbstractHttpData

toString

public String toString(Charset charset)

Description copied from interface: HttpData

Decodes this data into a String.

Specified by:

toString in interface HttpData

Parameters:

charset - the Charset to use for decoding this data

Returns:

the decoded String

toString

public String toString()

Overrides:

toString in class Object

toInputStream

public InputStream toInputStream()

Description copied from interface: HttpData

Returns a new InputStream that is sourced from this data.

Note, if this HttpData is pooled (e.g., it is the result of a call to HttpResponse.aggregateWithPooledObjects(ByteBufAllocator)), then this InputStream will increase the reference count of the underlying buffer. Make sure to call InputStream.close(), usually using a try-with-resources invocation, to release this extra reference. And as usual, don't forget to call ReferenceCountUtil.release(Object) on this HttpData itself too.

Specified by:

toInputStream in interface HttpData

withEndOfStream

public ByteBufHttpData withEndOfStream()

Description copied from interface: HttpData

Returns a new HttpData whose HTTP/2 endOfStream flag is set.

Specified by:

withEndOfStream in interface HttpData