Class ByteBufResponseWriter

java.lang.Object

org.infinispan.server.resp.serialization.bytebuf.ByteBufResponseWriter

All Implemented Interfaces:

ResponseWriter

public final class ByteBufResponseWriter
extends Object
implements ResponseWriter

Field Summary

Fields inherited from interface org.infinispan.server.resp.serialization.ResponseWriter

ARRAY_BULK_STRING, ARRAY_DOUBLE, ARRAY_INTEGER, ARRAY_STRING, BULK_STRING, BULK_STRING_BYTES, CUSTOM, DOUBLE, INTEGER, MAP_BULK_STRING_KV, OK, SET_BULK_STRING, SIMPLE_STRING, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ByteBufResponseWriter(ByteBufPool alloc)

Method Summary

Modifier and Type	Method	Description
void	array(Collection<?> collection, Resp3Type contentType)	Serializes a collection in the array format with elements of a specified type.
<T> void	array(Collection<T> collection, JavaObjectSerializer<T> serializer)	Serializes the collection by delegating the serialization of the elements to the provided serializer.
void	arrayEmpty()	Serializes a collection in the array format.
void	arrayEnd()	Finish writing an array
void	arrayNext()	Start writing a new array element
void	arrayStart(int size)	Start writing an array
void	booleans(boolean value)	Serializes a boolean value in the RESP3 format.
void	doubles(Number value)	Serializes a double-precision floating point into the doubles format.
void	emptySet()	Serializes a set
void	error(CharSequence value)	Serializes an error message.
void	error(Throwable t)	Serializes the exception message in the RESP3 error format.
void	integers(Number value)	Serializes a 64-bit number in the integer format.
boolean	isInternal()
void	map(Map<?,?> value)	Serializes a map.
void	map(Map<?,?> value, Resp3Type contentType)	Serializes a map with key and values of the same specified type.
void	map(Map<?,?> value, Resp3Type keyType, Resp3Type valueType)	Serializes a map in the RESP3 map format with keys and values of a specified format.
void	map(Map<?,?> map, SerializationHint.KeyValueHint keyValueHint)
void	nulls()	Writes the null value.
void	ok()	Serializes a simple string with the "OK" content.
void	queued(Object ignore)	Serializes a simple string with the "QUEUED" content.
void	serialize(Object object)	Generic method to serialize an object of unknown type.
<T> void	set(Set<?> set, JavaObjectSerializer<T> serializer)
void	set(Set<?> set, Resp3Type contentType)	Serializes a set with elements of a specified type.
void	simpleString(CharSequence value)	Serializes a char sequence in a simple string format.
void	string(byte[] value)	Serializes the binary blob in a bulk string format.
void	string(CharSequence value)	Serializes a char sequence in a bulk string format.
RespVersion	version()
void	version(RespVersion version)
<T> void	write(JavaObjectSerializer<T> serializer)	Invokes the callback to write a response with the serializer.
<T> void	write(T object, JavaObjectSerializer<T> serializer)	Writes an object utilizing the specific serializer.
void	writeNumericPrefix(byte symbol, long number)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.server.resp.serialization.ResponseWriter

customError, indexOutOfRange, minOrMaxNotAValidFloat, minOrMaxNotAValidStringRange, mustBePositive, mustBePositive, nanOrInfinity, noSuchKey, syntaxError, transactionAborted, unauthorized, unknownCommand, valueNotAValidFloat, valueNotInteger, wrongArgumentCount, wrongArgumentNumber, wrongType

Constructor Details

ByteBufResponseWriter

public ByteBufResponseWriter(ByteBufPool alloc)

Method Details

version

public RespVersion version()

Specified by:

version in interface ResponseWriter

version

public void version(RespVersion version)

Specified by:

version in interface ResponseWriter

isInternal

public boolean isInternal()

Specified by:

isInternal in interface ResponseWriter

nulls

public void nulls()

Description copied from interface: ResponseWriter

Writes the null value.

Specified by:

nulls in interface ResponseWriter

ok

public void ok()

Description copied from interface: ResponseWriter

Serializes a simple string with the "OK" content.

Specified by:

ok in interface ResponseWriter

queued

public void queued(Object ignore)

Description copied from interface: ResponseWriter

Serializes a simple string with the "QUEUED" content.

Specified by:

queued in interface ResponseWriter

Parameters:

ignore - Content to ignore.

simpleString

public void simpleString(CharSequence value)

Description copied from interface: ResponseWriter

Serializes a char sequence in a simple string format.

Specified by:

simpleString in interface ResponseWriter

Parameters:

value - The ASCII string to serialize.

string

public void string(CharSequence value)

Description copied from interface: ResponseWriter

Serializes a char sequence in a bulk string format.

Specified by:

string in interface ResponseWriter

Parameters:

value - The string to serialize.

string

public void string(byte[] value)

Description copied from interface: ResponseWriter

Serializes the binary blob in a bulk string format.

Specified by:

string in interface ResponseWriter

Parameters:

value - The binary blob to serialize.

integers

public void integers(Number value)

Description copied from interface: ResponseWriter

Serializes a 64-bit number in the integer format.

Specified by:

integers in interface ResponseWriter

Parameters:

value - Number to serialize.

doubles

public void doubles(Number value)

Description copied from interface: ResponseWriter

Serializes a double-precision floating point into the doubles format.

Specified by:

doubles in interface ResponseWriter

Parameters:

value - The floating point to serialize.

booleans

public void booleans(boolean value)

Description copied from interface: ResponseWriter

Serializes a boolean value in the RESP3 format.

Specified by:

booleans in interface ResponseWriter

Parameters:

value - Boolean value to serialize.

arrayEmpty

public void arrayEmpty()

Description copied from interface: ResponseWriter

Serializes a collection in the array format.

Specified by:

arrayEmpty in interface ResponseWriter

array

public <T> void array(Collection<T> collection,
 JavaObjectSerializer<T> serializer)

Description copied from interface: ResponseWriter

Serializes the collection by delegating the serialization of the elements to the provided serializer.

Specified by:

array in interface ResponseWriter

Type Parameters:

T - The type of the elements in the collection and the serializer handles.

Parameters:

collection - Collection of elements to serialize.

serializer - Serializer for a single element in the collection.

array

public void array(Collection<?> collection,
 Resp3Type contentType)

Description copied from interface: ResponseWriter

Serializes a collection in the array format with elements of a specified type.

Specified by:

array in interface ResponseWriter

Parameters:

collection - Collection of heterogeneous values to serialize.

contentType - The type of elements contained by the sequence.

emptySet

public void emptySet()

Description copied from interface: ResponseWriter

Serializes a set

Specified by:

emptySet in interface ResponseWriter

set

public void set(Set<?> set,
 Resp3Type contentType)

Description copied from interface: ResponseWriter

Serializes a set with elements of a specified type.

Specified by:

set in interface ResponseWriter

Parameters:

set - Set of heterogeneous values to serialize.

contentType - The type of elements contained by the set.

set

public <T> void set(Set<?> set,
 JavaObjectSerializer<T> serializer)

Specified by:

set in interface ResponseWriter

map

public void map(Map<?,?> value)

Description copied from interface: ResponseWriter

Serializes a map.

Specified by:

map in interface ResponseWriter

Parameters:

value - A map with heterogeneous key-value tuples to serialize.

map

public void map(Map<?,?> value,
 Resp3Type contentType)

Description copied from interface: ResponseWriter

Serializes a map with key and values of the same specified type.

Specified by:

map in interface ResponseWriter

Parameters:

value - A map with heterogeneous key-value tuples to serialize.

contentType - The type of key and value elements.

map

public void map(Map<?,?> value,
 Resp3Type keyType,
 Resp3Type valueType)

Description copied from interface: ResponseWriter

Serializes a map in the RESP3 map format with keys and values of a specified format.

Specified by:

map in interface ResponseWriter

Parameters:

value - A map with heterogeneous key-value tuples to serialize.

keyType - The type of keys in the map.

valueType - The type of values in the map.

map

public void map(Map<?,?> map,
 SerializationHint.KeyValueHint keyValueHint)

Specified by:

map in interface ResponseWriter

error

public void error(CharSequence value)

Description copied from interface: ResponseWriter

Serializes an error message.

The first character in the error message must be the '-' symbol.

Specified by:

error in interface ResponseWriter

Parameters:

value - An ASCII char sequence with the error message.

error

public void error(Throwable t)

Description copied from interface: ResponseWriter

Serializes the exception message in the RESP3 error format.

Specified by:

error in interface ResponseWriter

Parameters:

t - The throwable to serialize.

write

public <T> void write(T object,
 JavaObjectSerializer<T> serializer)

Description copied from interface: ResponseWriter

Writes an object utilizing the specific serializer.

Implementors do not need to check for nullability in the implementation. Null response values are handled by native RESP3 serializers before passing the serialization ahead.

Specified by:

write in interface ResponseWriter

Type Parameters:

T - The type of the object.

Parameters:

object - The element to serialize.

serializer - The serializer to utilize.

write

public <T> void write(JavaObjectSerializer<T> serializer)

Description copied from interface: ResponseWriter

Invokes the callback to write a response with the serializer.

Specified by:

write in interface ResponseWriter

Parameters:

serializer - Serializer to write.

serialize

public void serialize(Object object)

Description copied from interface: ResponseWriter

Generic method to serialize an object of unknown type.

This method searches all serializers available in the registry.

Specified by:

serialize in interface ResponseWriter

Parameters:

object - The object to serialize in RESP3 format.

writeNumericPrefix

public void writeNumericPrefix(byte symbol,
 long number)

Specified by:

writeNumericPrefix in interface ResponseWriter

arrayStart

public void arrayStart(int size)

Description copied from interface: ResponseWriter

Start writing an array

Specified by:

arrayStart in interface ResponseWriter

Parameters:

size - the number of elements

arrayEnd

public void arrayEnd()

Description copied from interface: ResponseWriter

Finish writing an array

Specified by:

arrayEnd in interface ResponseWriter

arrayNext

public void arrayNext()

Description copied from interface: ResponseWriter

Start writing a new array element

Specified by:

arrayNext in interface ResponseWriter