CONTRIBUTING Copy Section

Contributing to Aeron

If you would like to contribute code you can do so through GitHub by sending a pull request or raising an issue with an attached patch.

When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.

[](https://gitter.im/aeron-io/Aeron?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) To chat with other Aeron contributors.

License Copy Chapter

By contributing your code, you agree to license your contribution under the terms of the APLv2:

https://github.com/aeron-io/aeron/blob/master/LICENSE

All files are made available under the Apache 2.0 license.

If you are adding a new file it should have the following header:

/*
 * Copyright 2014-2025 Real Logic Limited.
 *
 * 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
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 */

---

README Copy Section

Aeron
=====

[](https://github.com/aeron-io/aeron/blob/master/LICENSE)
[](https://www.javadoc.io/static/io.aeron/aeron-all)

[](https://github.com/aeron-io/aeron/actions)
[](https://github.com/aeron-io/aeron/actions)

Efficient reliable UDP unicast, UDP multicast, and IPC message transport. Java, C, and C++ clients are available in this
repository, and a .NET client is available. All
clients can exchange messages across machines, or on the same machine via IPC, very efficiently. Message streams can be
recorded by the Archive module to persistent storage
for later, or real-time, replay. Aeron Cluster
provides support for fault-tolerant services as replicated state machines based on the
Raft consensus algorithm.

Performance is the key focus. A design goal for Aeron is to be the highest throughput with the lowest and most
predictable latency of any messaging system. Aeron integrates with
Simple Binary Encoding (SBE) for the best possible message
encoding and decoding performance. Many of the data structures used in the creation of Aeron have been factored out to
the Agrona project.

For details of usage, protocol specification, FAQ, etc., please check out the
Wiki.

For the latest version information and changes, see the Change Log
with Java downloads at Maven Central.

Aeron is owned and operated by Adaptive Financial Consulting. Originally created by Martin Thompson and Todd Montgomery, the Aeron team joined Adaptive in 2022.

For Business users, to get started with Aeron Premium, please visit Aeron.io

We provide a range of services, including:
* Training for development and operations with Aeron and Aeron Cluster.
* Consulting, for example, if you’re not sure how to design your system or need help tuning your system.
* We also offer a number of proprietary enhancements on top of Aeron and Aeron Cluster, such as kernel bypass with DPDK for increased performance, and blazing fast encryption with ATS.
* If you’re building a new trading system, we have experienced Aeron developers who can help.

Please get in touch at [email protected] if you would like to learn more about any of these.

How do I use Aeron? Copy Section

1. Java Programming Guide
1. C++11 Programming Guide
1. Best Practices Guide
1. Monitoring and Debugging
1. Configuration Options
1. Channel Specific Configuration
1. Aeron Archive (Durable/Persistent Stream Storage)
1. Aeron Cluster (Fault Tolerant Services)
1. Aeron Docs

How does Aeron work? Copy Section

1. Transport Protocol Specification
1. Design Overview
1. Design Principles
1. Flow Control Semantics
1. Media Driver Operation

How do I hack on Aeron? Copy Section

1. Hacking on Aeron
1. Performance Testing
1. Building Aeron

License (See LICENSE file for full license)
-------------------------------------------
Copyright 2014-2025 Real Logic Limited.

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

https://www.apache.org/licenses/LICENSE-2.0

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.

---