README

Fix8 Open Source C++ FIX Engine
A modern open source C++ FIX framework featuring complete schema driven customisation, high performance and fast application development.
The system is comprised of a compiler for generating C++ message and field encoders,
decoders and instantiation tables; a runtime library to support the generated code
and framework; and a set of complete client/server test applications.
Fix8 Market Tech develops and maintains Fix8 and Fix8Pro, the commercially supported version of Fix8.
Contents

Contents
Features
Directory Layout
Documentation
Branch Layout
C++11
External Dependencies (required)
Optional Dependencies
Building on Linux/UNIX
Building on OSX
Building on Windows
Support
Downloads
Getting help or reporting problems
Making a Pull Request
License
Fix8Pro and Fix8 Market Technologies
More Information

Features


Fix8 helps you get your FIX protocol client or server up and running quickly. Using one of the standard FIX schemas you can have a FIX client or server up and running in next to no time.


Statically compile your FIX xml schema and quickly build your FIX application on top. If you need to add customised messages or fields, simply update the schema and recompile.


Fix8 is the fastest C++ Open Source FIX framework. Our testing shows that Fix8 is on average 68% faster encoding/decoding the same message than Quickfix. See Performance to see how we substantiate this shameless bragging.


Fix8 supports standard FIX4.X to FIX5.X and FIXT1.X. If you have a custom FIX variant Fix8 can use that too. New FIX versions will be supported.


Fix8 offers message recycling and a meta-data aware test harness. Incorporates lock free queues, atomics and many other modern techniques.


Fix8 contains a built-in unit test framework that's being continually revised and extended. Fix8 also has a metadata driven test harness that can be scripted to support captured or canned data playback.


Fix8 is a complete C++ FIX framework, with client/server session and connection classes (including SSL); support for the standard FIX field types; FIX printer, async logger, async message persister and XML configuration classes.


Leverage standard components. Fix8 optionally uses industry recognised components for many important functions, including Poco, TBB, Redis, Memcached, BerkeleyDB, Fastflow, Google Test, Google Performance Tools, Doxygen and more. We didn't reinvent the wheel.


Fix8 statically supports nested components and groups to any depth. The Fix8 compiler and runtime library takes the pain out of using repeating groups.


Fix8 applications are fast. On production level hardware, client NewOrderSingle encode latency is now 2.1us, and ExecutionReport decode 3.2us. Without the framework overhead, NewOrderSingle encode latency is 1.4us. This is being continually improved.


Fix8 has been designed to be extended, customised or enhanced. If you have special requirements, Fix8 provides a flexible platform to develop your application on.


Fix8 supports field and value domain validation, mandatory/optional field assertion, field ordering, well-formedness testing, retransmission and standard session semantics.


Fix8 runs under industry standard Linux on IA32, x86-64, Itanium, PowerPC and ARMv7. It also now runs on Windows and OSX. Other *NIX variants may work too.


Directory Layout



Directory
Description




./
root directory with configure


m4/
additional m4 macros needed by configure


compiler/
the f8c compiler source


contrib/
user contributed files


doc/
Fix8 documentation


doc/man
manpages for Fix8 utilities


doc/html
doxygen documentation (optionally generated when built)


include/
header files for the runtime library and compiler


include/ff/
header files for FastFlow


runtime/
runtime library source


stocklib/
stock FIX library builds


util/
additional utilities source


msvc/
Microsoft Visual Studio project files


pro/
Fix8Pro extensions (commercial version only)


schema/
quickfix FIX xml schemas


test/
test applications client/server source


utests/
unit test applications



Documentation
See our Wiki for detailed help on using Fix8. Access to this documentation is free but will require
a login. For our complete API Documentation see here. All the source code is self-documenting using doxygen.
Branch Layout



Branch
github path
Description




master
https://github.com/fix8/fix8/tree/master
This is the default branch. All stable releases are made here.


dev
https://github.com/fix8/fix8/tree/dev
This is the development stream and is updated continually. Features and bug fixes scheduled for release are developed and tested here.


dev-premain
https://github.com/fix8/fix8/tree/dev-premain
This branch is used to marshall development changes that are ready for release. When significant changes are made to the dev branch, this branch will be used to keep other changes separate.


gh-pages
https://github.com/fix8/fix8/tree/gh-pages
This branch contains the static html for the Fix8 website.



C++11
Fix8 now requires C++11 compiler support. Fix8 will refuse to build without it. If you are using clang or gcc make sure you have the
-std=c++11

flag on your compiler command line. Some older compiler versions may no longer be supported. Sorry.
External Dependencies (required)
Fix8 requires the following third-party software (header files and
libraries) being installed to build properly:

Poco C++ Libraries basic edition

Additional libraries are needed for building on Windows, see here.
Optional Dependencies
You can either choose the internally supplied Fastflow or use...

Intel Threading Building Blocks OSS edition

If you wish to use the built-in unit tests (recommended):

googletest

If you wish to use tcmalloc (recommended):

gperftools

If you wish to build the html documentation, you will need:

Doxygen

If you wish to use Redis for message persistence:

hiredis

If you wish to use libmemcached for message persistence:

libmemcached

If you wish to use BerkeleyDB for message persistence:

Berkeley DB C++

Building on Linux/UNIX
The build system is based on automake/autoconf/libtool.
You must have libtool installed to build.
% tar xvzf 1.4.1.tar.gz
% cd fix8-1.4.1
% ./bootstrap
% ./configure
% make
% make install

If you have built the test cases, you can also run them as follows:
% make check

Building on OSX
You must have glibtool, autotools installed to build.
% tar xvzf 1.4.1.tar.gz
% cd fix8-1.4.1
% export LIBTOOLIZE=`which glibtoolize`
% ./bootstrap
% ./configure
% make
% make install

Please see this document for more instructions for building on OSX.
Building on Windows
Please see this document for detailed instructions for building on Windows.
Support
Please refer to the following pages for help:
- FAQ
- Fix8 support group
- Fix8 developer group
- API Documentation
- Jira Issues page
- Fix8 News
- Wiki
- Twitter
Downloads
Please refer to the following page:
- Downloads
Getting help or reporting problems


Review the topics on the Fix8 support group and
the Fix8 developer group.
If you cannot find any help there create a new topic and ask the support group for advice.


Please do not email us directly. Support questions sent directly to us will be redirected to the support group.


Please do not post the same question to both fix8-support and fix8-developer groups.


If you believe you have found a problem that needs fixing, go to the Jira Issues page,
register and create an issue. Provide as much detail as possible. Attach supporting files and extracts, like logfiles, stack traces,
sample configuruation files, config.log, etc.


If you have already implemented a fix, and wish to make a pull request on Github, create an issue in Jira first.
This will help us track the problem and ensure that the solution is properly tested.


When considering submitting a problem report, make sure you have identified a potential problem with Fix8 and not a problem with your application.
These aren't necessarily the same thing. For example if your application is crashing, there are many possible causes and some will relate
to your build, your code and your configuration and will not be a problem with the framework implementation. Make sure you have eliminated
these possibilities and that you have reviewed topics in the Fix8 support group and
the Fix8 developer group before submitting a problem report.


We also provide commercial support and help. See below.


We welcome genuine problem reports and encourage users to help us improve the product - for you and with your help.


If you are on LinkedIn join the LinkedIn group Fix8 Users and Developers
for more help and information about the Fix8 project.


Making a Pull Request
If you want to submit a change to the repository, it needs to be made on the dev branch. The following instructions may help:

Login to Jira, create a ticket for your changes, describing in detail the bug fix or improvement
Login to github
Create a fork of fix8
If you are using the command line git, clone your fork and choose the dev branch% git clone https://github.com/[your_repo_name]/fix8.git -b dev
Make your changes to this branch
Submit changes to your branch and push the branch to your fork
Create a pull request at fix8:dev
Wait for your pull request to be accepted to fix8:dev
Update your fork with recent fix8:dev

License
Fix8 is released under the GNU LESSER GENERAL PUBLIC LICENSE Version 3.
See License for more information.
Fix8Pro and Fix8 Market Technologies
Fix8Pro is the commercially supported version of Fix8. Fix8 Market Technologies
(Fix8MT) develops and maintains both Fix8Pro and the Fix8 open source versions.
Fix8MT has developers in Australia, China, Canada and the Russian Federation as well as partners in Australia, Japan and India.
Fix8MT is responsible for providing and managing additional support and consultancy services, and works closely with the
Fix8 open source community and partners to grow commercial support services through 3rd party ISVs.
For more information about Fix8Pro see the Fix8Pro website.
More Information
For more information, see the Fix8 website.