Simple Binary Encoding (SBE)
SBE is an OSI layer 6 presentation for encoding and decoding binary application messages for low-latency financial applications. This repository contains the reference implementations in Java, C++, Golang, and C#.
Further details on the background and usage of SBE can be found on the Wiki.
The Java and C++ SBE implementations are designed with work very efficiently with the Aeron messaging system for low-latency and high-throughput communications. The Java SBE implementation has a dependency on Agrona for its buffer implementations.
Binaries and dependency information for Maven, Ivy, Gradle, and others can be found at http://search.maven.org.
Example for Maven:
<dependency> <groupId>uk.co.real-logic</groupId> <artifactId>sbe-all</artifactId> <version>1.8.8</version> </dependency>
Full clean build:
Run the Java examples
$ ./gradlew runJavaExamples
Jars for the executable, source, and javadoc for the various modules can be found in the following directories:
sbe-benchmarks/build/libs sbe-samples/build/libs sbe-tool/build/libs sbe-all/build/libs
An example to execute a Jar from command line using the 'all' jar which includes the Agrona dependency:
java -Dsbe.generate.ir=true -Dsbe.target.language=Cpp -Dsbe.target.namespace=sbe -Dsbe.output.dir=include/gen -Dsbe.errorLog=yes -jar sbe-all/build/libs/sbe-all-1.8.9-SNAPSHOT.jar my_sbe_input.xml
Note: The Jars in directory
build/libs do not contain
META-INF/MANIFEST.MF and the error "no main manifest attribute" will occur when trying to execute it.
C++ Build using CMake
NOTE: Linux, Mac OS, and Windows only for the moment. See FAQ. Windows builds have been tested with Visual Studio Express 12.
First build using Gradle to generate the SBE jar.
For convenience, a script is provided that does a full clean, build, and test of all targets as a Release build.
If you are comfortable with using CMake, then a full clean, build, and test looks like:
$ mkdir -p cppbuild/Debug $ cd cppbuild/Debug $ cmake ../.. $ cmake --build . --clean-first $ ctest
First build using Gradle to generate the SBE jar and then use it to generate the golang code for testing
$ ./gradlew $ ./gradlew generateGolangCodecs
For convenience on Linux, a gnu Makefile is provided that runs some tests and contains some examples
$ cd gocode # make # test, examples, bench
Users of golang generated code should see the user documentation.
Developers wishing to enhance the golang generator should see the developer documentation
As of May 2017, the CSharp build is considered a preview release. API stability is not yet guaranteed. User and Developer guides are not yet released or are incomplete.
First build using Gradle to generate the SBE jar and then use it to generate the C# code used for testing and the examples.
$ ./gradlew $ ./gradlew generateCSharpCodecs
Users of CSharp generated code should see the user documentation (coming).
Developers wishing to enhance the CSharp generator should see the developer documentation (coming)
License (See LICENSE file for full license)
Copyright 2014-2018 Real Logic Limited
Copyright 2017 MarketFactory Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.