Collage  1.0.0
Object-Oriented C++ Network Library
RelNotes.md
1 Release Notes {#mainpage}
2 ============
3 
4 [TOC]
5 
6 # Introduction {#Introduction}
7 
8 Welcome to Collage, a high-performance C++ library for developing
9 object-oriented distributed applications. This release introduces the
10 official 1.0 API of the former Equalizer network library.
11 
12 Collage 1.0 is a stable release of over eight years of development and
13 decades of experience into a high-performance and mature C++ library. It
14 is intended for all C++ developers creating distributed applications
15 with high-level abstractions. Collage 1.0 can be retrieved by
16 downloading the source code or one of the precompiled packages.
17 
18 ## Features {#Features}
19 
20 Collage provides different levels of abstraction to facilitate the
21 development distributed applications:
22 
23 * Network Connections: stream-oriented point-to-point and reliable
24  multicast connections for TCP/IP, SDP, InfiniBand RDMA, UDT, events,
25  named and anonymous pipes, memory buffers and reliable multicast over
26  UDP.
27 * Peer-to-Peer Messaging: Endian-safe node-to-node message communication
28  with thread-aware message dispatch.
29 * Synchronization: Distributed barriers and synchronous messaging.
30 * Object data distribution: high-performance, object-oriented, versioned
31  data distribution for C++ objects based on delta serialization.
32 
33 # New in this release {#New}
34 
35 Collage 1.0 contains the following features, enhancements, bug fixes and
36 documentation changes over the Equalizer 1.4 release:
37 
38 ## New Features {#NewFeatures}
39 
40 * Endian-safe messaging
41 * RDMA connection supported on Windows
42 
43 ## Enhancements {#Enhancements}
44 
45 * Improved co::ObjectMap API and implementation
46 
47 ## Optimizations {#Optimizations}
48 
49 * co::WorkerThread uses bulk message retrieval from co::CommandQueue
50 
51 ## Tools {#Tools}
52 
53 * New coNodePerf application to benchmark node-to-node messaging performance
54 
55 ## Documentation {#Documentation}
56 
57 The following documentation has been added or substantially improved
58 since the last release:
59 
60 * Full documentation for the public Collage API
61 * Expanded Collage content in the Equalizer Programming and User Guide
62 
63 ## Bug Fixes {#Fixes}
64 
65 Collage 1.0 includes various bugfixes over the Equalizer 1.4 release,
66 including the following:
67 
68 * [25](https://github.com/Eyescale/Collage/issues/25): mapObject races
69  with commit
70 * [22](https://github.com/Eyescale/Collage/issues/22): Crash during
71  concurrent object deregister and map
72 * [13](https://github.com/Eyescale/Collage/issues/13): Global argument
73  parsing broken
74 * [3](https://github.com/Eyescale/Collage/issues/3): Snappy compressor
75  does not work on PPC
76 
77 ## Known Bugs {#Bugs}
78 
79 The following bugs were known at release time. Please file a [Bug Report](https://github.com/Eyescale/Collage/issues) if you find any other issue with this release.
80 
81 * [16](https://github.com/Eyescale/Collage/issues/16): RSP Interface not
82  bound on Linux
83 * [15](https://github.com/Eyescale/Collage/issues/15): RDMAConnection
84  not endian-safe
85 * [14](https://github.com/Eyescale/Collage/issues/14): coNetperf server
86  occasionally crashes on client disconnect
87 * [2](https://github.com/Eyescale/Collage/issues/2): Multiple dispatcher
88  inheritance not working with xlC
89 
90 # About {#About}
91 
92 Collage is a cross-platform library, designed to run on any modern
93 operating system, including all Unix variants and the Windows operating
94 system. Collage uses CMake and
95 [Buildyard](https://github.com/Eyescale/Buildyard) to create a
96 platform-specific build environment. The following platforms and build
97 environments are tested for version 1.0:
98 
99 * Linux: Ubuntu 12.04, 12.10, 13.04, RHEL 6.3 (Makefile, i386, x64)
100 * Windows: 7 (Visual Studio 2008, i386, x64)
101 * Mac OS X: 10.8 (Makefile, XCode, i386, x64)
102 
103 The Equalizer Programming and User Guide covers the basics of Collage
104 programming. The API documentation can be found on
105 [github](http://eyescale.github.io/).
106 
107 As with any open source project, the available source code, in
108 particular the shipped tools provide a reference for developing or
109 porting applications.
110 
111 Technical questions can be posted to the eq-dev Mailing List, or
112 directly to info@equalizergraphics.com.
113 
114 Commercial support, custom software development and porting services are
115 available from [Eyescale](http://www.eyescale.ch). Please contact
116 [info@eyescale.ch](mailto:info@eyescale.ch?subject=Collage%20support)
117 for further information.
118 
119 # Errata
std::vector< ConnectionPtr > Connections
A vector of ConnectionPtr's.
Definition: types.h:116
A distributed object registry.
Definition: objectMap.h:39
A worker thread processing items out of a CommandQueue.
Definition: types.h:69
A thread-safe queue for ICommand buffers.
Definition: commandQueue.h:32