uk.co.real_logic.artio.util

Class MessageTypeEncoding

java.lang.Object

uk.co.real_logic.artio.util.MessageTypeEncoding

public final class MessageTypeEncoding
extends java.lang.Object

Class for handling the encoding and decoding of Artio's packed message types. FIX uses 1 or 2 character ascii sequences as a way of representing the message type of messages. Some venues have a longer representation with more message types in. Artio has a packed representation where the bytes of the message type are encoded into a long.

Constructor Summary

Constructors

Constructor and Description
MessageTypeEncoding()

Method Summary

Modifier and Type	Method and Description
static org.agrona.collections.LongHashSet	packAllMessageTypes(java.util.Set<java.lang.String> messageTypes)
static long	packMessageType(byte[] messageType, int offset, int length) Creates a packed message type from a byte[] and length.
static long	packMessageType(char[] messageType, int length) Creates a packed message type from a char[] and length.
static long	packMessageType(java.lang.String messageType) Creates a packed message type from a string.
static int	unpackMessageType(long packedMessageType, byte[] dest) Unpacks a packed message type into a byte array so that it can be encoded into different formats.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageTypeEncoding

public MessageTypeEncoding()

Method Detail

packMessageType

public static long packMessageType(java.lang.String messageType)

Creates a packed message type from a string.

Parameters:

messageType - message type as ascii string.

Returns:

the packed message type.

Throws:

java.lang.IllegalArgumentException - if messageType parameter is too long.

packAllMessageTypes

public static org.agrona.collections.LongHashSet packAllMessageTypes(java.util.Set<java.lang.String> messageTypes)

packMessageType

public static long packMessageType(char[] messageType,
                                   int length)

Creates a packed message type from a char[] and length.

Parameters:

messageType - message type as ascii char[].

length - the number of characters within messageType to use.

Returns:

the packed message type.

Throws:

java.lang.IllegalArgumentException - if messageType parameter is too long.

packMessageType

public static long packMessageType(byte[] messageType,
                                   int offset,
                                   int length)

Creates a packed message type from a byte[] and length.

Parameters:

messageType - message type as ascii byte[].

offset - the offset within the messagetype to start looking

length - the number of characters within messageType to use.

Returns:

the packed message type.

Throws:

java.lang.IllegalArgumentException - if messageType parameter is too long.

unpackMessageType

public static int unpackMessageType(long packedMessageType,
                                    byte[] dest)

Unpacks a packed message type into a byte array so that it can be encoded into different formats. Note: this only supports up to 2 character message types, which is enough for most normal FIX dictionaries but not the "ultra-packed" message type that the packMessageType() methods can support for unusual dictionaries. The unpacked value is a byte[] that contains the ascii encoded String of the message type.

Parameters:

packedMessageType - the FIX message type in packed format.

dest - a destination byte array where the unpacked value is put, should be at least two bytes long.

Returns:

the length of the unpacked value

Throws:

java.lang.ArrayIndexOutOfBoundsException - if dest is too short.