net.openhft.fix.include.util

Class FixMessagePool

java.lang.Object

net.openhft.fix.include.util.FixMessagePool

All Implemented Interfaces:

Externalizable, Serializable, FixPoolFactory<FixMessage>

public class FixMessagePool
extends Object
implements FixPoolFactory<FixMessage>

Off-heap, lock-free FixMessage object pool. All checkouts from the pool are ThreadLocal-based and can be obtained even before the threadlocal releases it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FixMessagePool.FixMessageContainer Static Inner class used as a container for FixMessage objects.

Constructor Summary

Constructors

Constructor and Description
FixMessagePool(FixPoolFactory<FixMessage> fixPoolFactory, int poolSize, boolean useDefault) Constructor to create FixMessage objects and initialize the pool with default FixConfig.

Method Summary

Methods

Modifier and Type	Method and Description
FixMessage	create(boolean useDefault) This method creates a new instance of FixMessage object to be used by the FixMessagePool.
FixMessagePool.FixMessageContainer	getFixMessageContainer() Checks out an unused FixMessage object from the pool.
void	putFixMessageContainer(FixMessagePool.FixMessageContainer fixMsgContainer)
void	readExternal(ObjectInput in)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

FixMessagePool

public FixMessagePool(FixPoolFactory<FixMessage> fixPoolFactory,
              int poolSize,
              boolean useDefault)

Constructor to create FixMessage objects and initialize the pool with default FixConfig. fixPoolFactory should be null for implementation of FixPoolFactory as this class.

Parameters:

fixPoolFactory - -factory used for create a new FixMessage Object

poolSize - -usually, should equal to the number of processors on the machine

useDefault - -instructs to create from FixConfig. Currently, only default=true implemented.

Method Detail

getFixMessageContainer

public FixMessagePool.FixMessageContainer getFixMessageContainer()

Checks out an unused FixMessage object from the pool. The FixMessage object needs to be obtained from its FixMessageContainer

Returns:

FixMessageContainer

putFixMessageContainer

public void putFixMessageContainer(FixMessagePool.FixMessageContainer fixMsgContainer)
                            throws Exception

Parameters:

fixMsgContainer - -checks in this FixMessage object from FixMessageContainer.

Throws:

Exception- - For invalid position address

Exception

create

public FixMessage create(boolean useDefault)

Description copied from interface: FixPoolFactory

This method creates a new instance of FixMessage object to be used by the FixMessagePool. A FixMessage created from this method should have all its fields initialized for pre-allocation of memory required to be re-used for each one of its fields. Each Field object of this FixMessage object uses ByteBufferBytes for re-use purpose.

Specified by:

create in interface FixPoolFactory<FixMessage>

Parameters:

useDefault - -Choose to use defaults inside FixConfig

Returns:

-a newly created FixMessage Object

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException