uk.co.real_logic.artio.builder

Interface Encoder

All Superinterfaces:

CharAppender

All Known Subinterfaces:

AbstractBusinessMessageRejectEncoder, AbstractHeartbeatEncoder, AbstractLogonEncoder, AbstractLogoutEncoder, AbstractRejectEncoder, AbstractResendRequestEncoder, AbstractSequenceResetEncoder, AbstractTestRequestEncoder

public interface Encoder
extends CharAppender

Field Summary

Fields

Modifier and Type	Field and Description
static int	BITS_IN_INT

Method Summary

Modifier and Type	Method and Description
Encoder	copyTo(Encoder otherEncoder) Copies the field values on the other Encoder to be the same as this Encoder.
long	encode(MutableAsciiBuffer buffer, int offset) Encode the message onto a buffer in FIX tag=value\001 format.
SessionHeaderEncoder	header()
static int	length(long result)
long	messageType() Gets the long encoded message type of the message in question.
static int	offset(long result)
void	reset() Resets the encoder.
void	resetMessage()
static long	result(int length, int offset)

Methods inherited from interface uk.co.real_logic.artio.builder.CharAppender

appendTo

Field Detail

BITS_IN_INT

static final int BITS_IN_INT

See Also:

Constant Field Values

Method Detail

length

static int length(long result)

offset

static int offset(long result)

result

static long result(int length,
                   int offset)

encode

long encode(MutableAsciiBuffer buffer,
            int offset)

Encode the message onto a buffer in FIX tag=value\001 format.

Parameters:

buffer - the buffer to encode the message to.

offset - the offset within the buffer to start encoding the message at.

Returns:

the offset and length of the encoded message on the buffer packed into a long

Throws:

EncodingException - if a required field (other than the message sequence number) is missing and codec validation is enabled.

reset

void reset()

Resets the encoder. Sets all the fields back to their uninitialized state.

messageType

long messageType()

Gets the long encoded message type of the message in question.

Returns:

the message type.

header

SessionHeaderEncoder header()

resetMessage

void resetMessage()

copyTo

Encoder copyTo(Encoder otherEncoder)

Copies the field values on the other Encoder to be the same as this Encoder. This also sets all child components and repeating group values to be the same. This method also resets the encoder before any fields are set so that missing values within this Encoder are also missing within the other Encoder.

Parameters:

otherEncoder - the encoder to set the values of.

Returns:

the encoder passed as an argument.