-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
338faf3
commit bc5524f
Showing
1 changed file
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# eProsima Fast RTPS | ||
|
||
<a href="http://www.eprosima.com"><img src="https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcSd0PDlVz1U_7MgdTe0FRIWD0Jc9_YH-gGi0ZpLkr-qgCI6ZEoJZ5GBqQ" align="left" hspace="8" vspace="2" width="100" height="100" ></a> | ||
|
||
*eprosima Fast RTPS* is a C++ implementation of the RTPS (Real Time Publish Subscribe) protocol, which provides publisher-subscriber communications over unreliable transports such as UDP, | ||
as defined and maintained by the Object Management Group (OMG) consortium. RTPS is also the wire interoperability protocol defined for the Data Distribution | ||
Service (DDS) standard, again by the OMG. *eProsima Fast RTPS* holds the benefit of being standalone and up-to-date, as most vendor solutions either implement RTPS as a tool to implement | ||
DDS or use past versions of the specification. | ||
|
||
Some of the main features of this library are: | ||
|
||
* Configurable best-effort and reliable publish-subscribe communication policies for real-time | ||
applications. | ||
* Plug and play connectivity so that any new applications are automatically discovered by any other | ||
members of the network. | ||
* Modularity and scalability to allow continuous growth with complex and simple devices in the | ||
network. | ||
* Configurable network behavior and interchangeable transport layer: Choose the best protocol and | ||
system input/output channel combination for each deployment. | ||
* Two API Layers: a high-level Publisher-Subscriber one focused on usability and a lower-level Writer-Reader one that provides finer access to the inner workings of the RTPS protocol. | ||
|
||
## Installation Guide | ||
You can get either a binary distribution of *eprosima Fast RTPS* or compile the library yourself from source. | ||
|
||
### Installation from binaries | ||
The latest, up to date binary release of *eprosima Fast RTPS* can be obtained from the <a href='http://www.eprosima.com'>company website</a>. | ||
|
||
### Installation from Source | ||
To compile *eprosima Fast RTPS* from source, at least Cmake version 2.8.12 and Boost 1.61 are needed. | ||
Clone the project from GitHub: | ||
|
||
$ git clone https://github.com/eProsima/Fast-RTPS | ||
|
||
If you are on Linux, execute: | ||
|
||
$ cmake ../ -DEPROSIMA_BUILD=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=install | ||
$ make | ||
$ make install | ||
|
||
If you are on Windows, choose your version of Visual Studio: | ||
|
||
> cmake ../ -G"Visual Studio 14 2015 Win64" -DEPROSIMA_BUILD=ON -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=installationpath | ||
> cmake --build . --target install | ||
|
||
If you want to compile the performance tests, you will need to add the argument `-DPERFORMANCE_TESTS=ON` when calling Cmake. | ||
|
||
## Documentation | ||
|
||
You can access the documentation online, which is hosted on [Read the Docs](http://eprosima-fast-rtps.readthedocs.io). | ||
|
||
* [Installation manual](http://eprosima-fast-rtps.readthedocs.io/en/latest/requirements.html) | ||
* [User manual](http://eprosima-fast-rtps.readthedocs.io/en/latest/introduction.html) | ||
* [FastRTPSGen manual](http://eprosima-fast-rtps.readthedocs.io/en/latest/geninfo.html) | ||
* [Release notes](http://eprosima-fast-rtps.readthedocs.io/notes.html) | ||
|
||
## Getting Help | ||
|
||
If you need support you can reach us by mail at `support@eProsima.com` or by phone at `+34 91 804 34 48`. | ||
|
||
|