Interface MessageWriter
-
public interface MessageWriterCommunication message writer.Allows to customize the binary format of communication messages.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidafterInnerMessageWrite(boolean finished)Callback called after inner message is written.voidbeforeInnerMessageWrite()Callback called before inner message is written.voidincrementState()Increments state.booleanisHeaderWritten()voidonHeaderWritten()Callback called when header of the message is written.voidreset()Resets this writer.voidsetBuffer(ByteBuffer buf)Sets but buffer to write to.voidsetCurrentWriteClass(Class<? extends Message> msgCls)Sets type of message currently written.intstate()Gets current message state.booleanwriteAffinityTopologyVersion(String name, org.apache.ignite.internal.processors.affinity.AffinityTopologyVersion val)WritesAffinityTopologyVersion.booleanwriteBitSet(String name, BitSet val)WritesBitSet.booleanwriteBoolean(String name, boolean val)Writesbooleanvalue.booleanwriteBooleanArray(String name, boolean[] val)Writesbooleanarray.booleanwriteByte(String name, byte val)Writesbytevalue.booleanwriteByteArray(String name, byte[] val)Writesbytearray.booleanwriteByteArray(String name, byte[] val, long off, int len)Writesbytearray.booleanwriteChar(String name, char val)Writescharvalue.booleanwriteCharArray(String name, char[] val)Writeschararray.<T> booleanwriteCollection(String name, Collection<T> col, MessageCollectionItemType itemType)Writes collection.booleanwriteDouble(String name, double val)Writesdoublevalue.booleanwriteDoubleArray(String name, double[] val)Writesdoublearray.booleanwriteFloat(String name, float val)Writesfloatvalue.booleanwriteFloatArray(String name, float[] val)Writesfloatarray.booleanwriteHeader(short type, byte fieldCnt)Writes message header.booleanwriteIgniteUuid(String name, IgniteUuid val)WritesIgniteUuid.booleanwriteInt(String name, int val)Writesintvalue.booleanwriteIntArray(String name, int[] val)Writesintarray.booleanwriteLong(String name, long val)Writeslongvalue.booleanwriteLongArray(String name, long[] val)Writeslongarray.booleanwriteLongArray(String name, long[] val, int len)Writeslongarray.<K,V>
booleanwriteMap(String name, Map<K,V> map, MessageCollectionItemType keyType, MessageCollectionItemType valType)Writes map.booleanwriteMessage(String name, Message val)Writes nested message.<T> booleanwriteObjectArray(String name, T[] arr, MessageCollectionItemType itemType)Writes array of objects.booleanwriteShort(String name, short val)Writesshortvalue.booleanwriteShortArray(String name, short[] val)Writesshortarray.booleanwriteString(String name, String val)WritesString.booleanwriteUuid(String name, UUID val)WritesUUID.
-
-
-
Method Detail
-
setBuffer
void setBuffer(ByteBuffer buf)
Sets but buffer to write to.- Parameters:
buf- Byte buffer.
-
setCurrentWriteClass
void setCurrentWriteClass(Class<? extends Message> msgCls)
Sets type of message currently written.- Parameters:
msgCls- Message type.
-
writeHeader
boolean writeHeader(short type, byte fieldCnt)Writes message header.- Parameters:
type- Message type.fieldCnt- Fields count.- Returns:
trueif successfully. Otherwise returnsfalse.
-
writeByte
boolean writeByte(String name, byte val)
Writesbytevalue.- Parameters:
name- Field name.val-bytevalue.- Returns:
- Whether value was fully written.
-
writeShort
boolean writeShort(String name, short val)
Writesshortvalue.- Parameters:
name- Field name.val-shortvalue.- Returns:
- Whether value was fully written.
-
writeInt
boolean writeInt(String name, int val)
Writesintvalue.- Parameters:
name- Field name.val-intvalue.- Returns:
- Whether value was fully written.
-
writeLong
boolean writeLong(String name, long val)
Writeslongvalue.- Parameters:
name- Field name.val-longvalue.- Returns:
- Whether value was fully written.
-
writeFloat
boolean writeFloat(String name, float val)
Writesfloatvalue.- Parameters:
name- Field name.val-floatvalue.- Returns:
- Whether value was fully written.
-
writeDouble
boolean writeDouble(String name, double val)
Writesdoublevalue.- Parameters:
name- Field name.val-doublevalue.- Returns:
- Whether value was fully written.
-
writeChar
boolean writeChar(String name, char val)
Writescharvalue.- Parameters:
name- Field name.val-charvalue.- Returns:
- Whether value was fully written.
-
writeBoolean
boolean writeBoolean(String name, boolean val)
Writesbooleanvalue.- Parameters:
name- Field name.val-booleanvalue.- Returns:
- Whether value was fully written.
-
writeByteArray
boolean writeByteArray(String name, byte[] val)
Writesbytearray.- Parameters:
name- Field name.val-bytearray.- Returns:
- Whether array was fully written.
-
writeByteArray
boolean writeByteArray(String name, byte[] val, long off, int len)
Writesbytearray.- Parameters:
name- Field name.val-bytearray.off- Offset.len- Length.- Returns:
- Whether array was fully written.
-
writeShortArray
boolean writeShortArray(String name, short[] val)
Writesshortarray.- Parameters:
name- Field name.val-shortarray.- Returns:
- Whether array was fully written.
-
writeIntArray
boolean writeIntArray(String name, int[] val)
Writesintarray.- Parameters:
name- Field name.val-intarray.- Returns:
- Whether array was fully written.
-
writeLongArray
boolean writeLongArray(String name, long[] val)
Writeslongarray.- Parameters:
name- Field name.val-longarray.- Returns:
- Whether array was fully written.
-
writeLongArray
boolean writeLongArray(String name, long[] val, int len)
Writeslongarray.- Parameters:
name- Field name.val-longarray.len- Length.- Returns:
- Whether array was fully written.
-
writeFloatArray
boolean writeFloatArray(String name, float[] val)
Writesfloatarray.- Parameters:
name- Field name.val-floatarray.- Returns:
- Whether array was fully written.
-
writeDoubleArray
boolean writeDoubleArray(String name, double[] val)
Writesdoublearray.- Parameters:
name- Field name.val-doublearray.- Returns:
- Whether array was fully written.
-
writeCharArray
boolean writeCharArray(String name, char[] val)
Writeschararray.- Parameters:
name- Field name.val-chararray.- Returns:
- Whether array was fully written.
-
writeBooleanArray
boolean writeBooleanArray(String name, boolean[] val)
Writesbooleanarray.- Parameters:
name- Field name.val-booleanarray.- Returns:
- Whether array was fully written.
-
writeString
boolean writeString(String name, String val)
WritesString.- Parameters:
name- Field name.val-String.- Returns:
- Whether value was fully written.
-
writeBitSet
boolean writeBitSet(String name, BitSet val)
WritesBitSet.- Parameters:
name- Field name.val-BitSet.- Returns:
- Whether value was fully written.
-
writeUuid
boolean writeUuid(String name, UUID val)
WritesUUID.- Parameters:
name- Field name.val-UUID.- Returns:
- Whether value was fully written.
-
writeIgniteUuid
boolean writeIgniteUuid(String name, IgniteUuid val)
WritesIgniteUuid.- Parameters:
name- Field name.val-IgniteUuid.- Returns:
- Whether value was fully written.
-
writeAffinityTopologyVersion
boolean writeAffinityTopologyVersion(String name, org.apache.ignite.internal.processors.affinity.AffinityTopologyVersion val)
WritesAffinityTopologyVersion.- Parameters:
name- Field name.val-AffinityTopologyVersion.- Returns:
- Whether value was fully written.
-
writeMessage
boolean writeMessage(String name, Message val)
Writes nested message.- Parameters:
name- Field name.val- Message.- Returns:
- Whether value was fully written.
-
writeObjectArray
<T> boolean writeObjectArray(String name, T[] arr, MessageCollectionItemType itemType)
Writes array of objects.- Type Parameters:
T- Type of the objects that array contains.- Parameters:
name- Field name.arr- Array of objects.itemType- Array component type.- Returns:
- Whether array was fully written.
-
writeCollection
<T> boolean writeCollection(String name, Collection<T> col, MessageCollectionItemType itemType)
Writes collection.- Type Parameters:
T- Type of the objects that collection contains.- Parameters:
name- Field name.col- Collection.itemType- Collection item type.- Returns:
- Whether value was fully written.
-
writeMap
<K,V> boolean writeMap(String name, Map<K,V> map, MessageCollectionItemType keyType, MessageCollectionItemType valType)
Writes map.- Type Parameters:
K- Initial key types of the map to write.V- Initial value types of the map to write.- Parameters:
name- Field name.map- Map.keyType- Map key type.valType- Map value type.- Returns:
- Whether value was fully written.
-
isHeaderWritten
boolean isHeaderWritten()
- Returns:
- Whether header of current message is already written.
-
onHeaderWritten
void onHeaderWritten()
Callback called when header of the message is written.
-
state
int state()
Gets current message state.- Returns:
- State.
-
incrementState
void incrementState()
Increments state.
-
beforeInnerMessageWrite
void beforeInnerMessageWrite()
Callback called before inner message is written.
-
afterInnerMessageWrite
void afterInnerMessageWrite(boolean finished)
Callback called after inner message is written.- Parameters:
finished- Whether message was fully written.
-
reset
void reset()
Resets this writer.
-
-