2015-12-14 17:22:34 +00:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2016-05-09 16:13:23 +00:00
< title > Networking and messaging — R3 Corda latest documentation< / title >
2015-12-14 17:22:34 +00:00
< link rel = "stylesheet" href = "_static/css/custom.css" type = "text/css" / >
2016-05-09 16:13:23 +00:00
< link rel = "top" title = "R3 Corda latest documentation" href = "index.html" / >
2016-10-11 09:30:55 +00:00
< link rel = "next" title = "Persistence" href = "persistence.html" / >
2016-06-30 12:49:28 +00:00
< link rel = "prev" title = "Consensus model" href = "consensus.html" / >
2015-12-14 17:22:34 +00:00
< script src = "_static/js/modernizr.min.js" > < / script >
< / head >
< body class = "wy-body-for-nav" role = "document" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
2016-03-08 17:30:51 +00:00
2015-12-14 17:22:34 +00:00
2016-05-09 16:13:23 +00:00
< a href = "index.html" class = "icon icon-home" > R3 Corda
2015-12-14 17:22:34 +00:00
< / a >
< div class = "version" >
2016-02-25 12:29:28 +00:00
latest
2015-12-14 17:22:34 +00:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
2016-03-08 17:30:51 +00:00
< br >
< a href = "api/index.html" > API reference< / a >
2015-12-14 17:22:34 +00:00
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
2015-12-22 15:15:38 +00:00
< p class = "caption" > < span class = "caption-text" > Overview< / span > < / p >
< ul class = "current" >
2015-12-14 17:22:34 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "inthebox.html" > What’ s included?< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "getting-set-up.html" > Getting set up< / a > < / li >
2015-12-22 15:15:38 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "data-model.html" > Data model< / a > < / li >
2016-06-30 12:49:28 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "transaction-data-types.html" > Data types< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "consensus.html" > Consensus model< / a > < / li >
2016-04-13 09:29:54 +00:00
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > Networking and messaging< / a > < ul >
2016-08-30 11:05:32 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#messaging-types" > Messaging types< / a > < / li >
2016-04-28 16:15:56 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "#network-map-service" > Network Map Service< / a > < / li >
2015-12-14 17:22:34 +00:00
< / ul >
< / li >
2016-10-11 09:30:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "persistence.html" > Persistence< / a > < / li >
2016-08-30 11:05:32 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "creating-a-cordapp.html" > Creating a Cordapp< / a > < / li >
2016-04-28 16:15:56 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "running-the-demos.html" > Running the demos< / a > < / li >
2016-03-04 15:15:51 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "node-administration.html" > Node administration< / a > < / li >
2016-09-23 09:55:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "corda-configuration-files.html" > The Corda Configuration File< / a > < / li >
2015-12-22 15:15:38 +00:00
< / ul >
< p class = "caption" > < span class = "caption-text" > Tutorials< / span > < / p >
< ul >
2016-05-24 11:27:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "where-to-start.html" > Where to start< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-contract.html" > Writing a contract< / a > < / li >
2016-07-12 16:52:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-contract-clauses.html" > Writing a contract using clauses< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-test-dsl.html" > Writing a contract test< / a > < / li >
2016-10-11 09:30:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-clientrpc-api.html" > Client RPC API< / a > < / li >
2015-12-14 17:22:34 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "protocol-state-machines.html" > Protocol state machines< / a > < / li >
2016-03-15 16:13:01 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "oracles.html" > Writing oracle services< / a > < / li >
2016-10-11 09:30:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "tutorial-attachments.html" > Using attachments< / a > < / li >
2016-06-30 12:49:28 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "event-scheduling.html" > Event scheduling< / a > < / li >
2016-09-23 09:55:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "secure-coding-guidelines.html" > Secure coding guidelines< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > Contracts< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "contract-catalogue.html" > Contract catalogue< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "contract-irs.html" > Interest Rate Swaps< / a > < / li >
< / ul >
< p class = "caption" > < span class = "caption-text" > Node API< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "clientrpc.html" > Client RPC< / a > < / li >
2015-12-22 15:15:38 +00:00
< / ul >
< p class = "caption" > < span class = "caption-text" > Appendix< / span > < / p >
< ul >
2016-05-24 11:27:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "release-process.html" > Release process< / a > < / li >
2016-06-13 17:27:53 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "release-process.html#steps-to-cut-a-release" > Steps to cut a release< / a > < / li >
2016-05-24 11:27:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "release-notes.html" > Release notes< / a > < / li >
2016-09-23 09:55:23 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "network-simulator.html" > Network Simulator< / a > < / li >
2016-01-27 15:01:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "codestyle.html" > Code style guide< / a > < / li >
2016-04-28 16:15:56 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "building-the-docs.html" > Building the documentation< / a > < / li >
2015-12-14 17:22:34 +00:00
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" role = "navigation" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
2016-05-09 16:13:23 +00:00
< a href = "index.html" > R3 Corda< / a >
2015-12-14 17:22:34 +00:00
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
2016-04-13 09:29:54 +00:00
2015-12-14 17:22:34 +00:00
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" > Docs< / a > » < / li >
< li > Networking and messaging< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/messaging.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "networking-and-messaging" >
< h1 > Networking and messaging< a class = "headerlink" href = "#networking-and-messaging" title = "Permalink to this headline" > ¶< / a > < / h1 >
2016-08-30 11:05:32 +00:00
< p > Corda uses AMQP/1.0 over TLS between nodes which is currently implemented using Apache Artemis, an embeddable message
queue broker. Building on established MQ protocols gives us features like persistence to disk, automatic delivery
retries with backoff and dead-letter routing, security, large message streaming and so on.< / p >
< p > Artemis is hidden behind a thin interface that also has an in-memory only implementation suitable for use in
unit tests and visualisation tools.< / p >
2015-12-14 17:22:34 +00:00
< div class = "admonition note" >
< p class = "first admonition-title" > Note< / p >
2016-08-30 11:05:32 +00:00
< p class = "last" > A future version of Corda will allow the MQ broker to be split out of the main node and run as a
separate server. We may also support non-Artemis implementations via JMS, allowing the broker to be swapped
out for alternative implementations.< / p >
2015-12-14 17:22:34 +00:00
< / div >
2016-08-30 11:05:32 +00:00
< p > There are multiple ways of interacting with the network. When writing an application you typically won’ t use the
messaging subsystem directly. Instead you will build on top of the < a class = "reference internal" href = "protocol-state-machines.html" > < span class = "doc" > protocol framework< / span > < / a > ,
which adds a layer on top of raw messaging to manage multi-step protocols and let you think in terms of identities
rather than specific network endpoints.< / p >
< div class = "section" id = "messaging-types" >
< h2 > Messaging types< a class = "headerlink" href = "#messaging-types" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Every < code class = "docutils literal" > < span class = "pre" > Message< / span > < / code > object has an associated < em > topic< / em > and may have a < em > session ID< / em > . These are wrapped in a < code class = "docutils literal" > < span class = "pre" > TopicSession< / span > < / code > .
An implementation of < code class = "docutils literal" > < span class = "pre" > MessagingService< / span > < / code > can be used to create messages and send them. You can get access to the
messaging service via the < code class = "docutils literal" > < span class = "pre" > ServiceHub< / span > < / code > object that is provided to your app. Endpoints on the network are
identified at the lowest level using < code class = "docutils literal" > < span class = "pre" > SingleMessageRecipient< / span > < / code > which may be e.g. an IP address, or in future
versions perhaps a routing path through the network.< / p >
2015-12-14 17:22:34 +00:00
< / div >
2016-04-28 16:15:56 +00:00
< div class = "section" id = "network-map-service" >
< h2 > Network Map Service< a class = "headerlink" href = "#network-map-service" title = "Permalink to this headline" > ¶< / a > < / h2 >
2016-08-30 11:05:32 +00:00
< p > Supporting the messaging layer is a network map service, which is responsible for tracking public nodes on the network.< / p >
< p > Nodes have an internal component, the network map cache, which contains a copy of the network map (which is just a
document). When a node starts up its cache fetches a copy of the full network map, and requests to be notified of
changes. The node then registers itself with the network map service, and the service notifies subscribers that a new
node has joined the network. Nodes do not automatically deregister themselves, so (for example) nodes going offline
briefly for maintenance are retained in the network map, and messages for them will be queued, minimising disruption.< / p >
< p > Nodes submit signed changes to the map service, which then forwards update notifications on to nodes which have
requested to be notified of changes.< / p >
< p > The network map currently supports:< / p >
2016-04-28 16:15:56 +00:00
< ul class = "simple" >
< li > Looking up nodes by service< / li >
< li > Looking up node for a party< / li >
2016-08-30 11:05:32 +00:00
< li > Suggesting a node providing a specific service, based on suitability for a contract and parties, for example suggesting
an appropriate interest rates oracle for a interest rate swap contract. Currently no recommendation logic is in place.
The code simply picks the first registered node that supports the required service.< / li >
2016-04-28 16:15:56 +00:00
< / ul >
< / div >
2015-12-14 17:22:34 +00:00
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2016-04-28 16:15:56 +00:00
2016-10-11 09:30:55 +00:00
< a href = "persistence.html" class = "btn btn-neutral float-right" title = "Persistence" accesskey = "n" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2015-12-14 17:22:34 +00:00
2016-06-30 12:49:28 +00:00
< a href = "consensus.html" class = "btn btn-neutral" title = "Consensus model" accesskey = "p" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2015-12-14 17:22:34 +00:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2016-05-09 16:13:23 +00:00
© Copyright 2016, Distributed Ledger Group, LLC.
2015-12-14 17:22:34 +00:00
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/snide/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
2016-02-25 12:29:28 +00:00
VERSION:'latest',
2015-12-14 17:22:34 +00:00
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
< / script >
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
< / script >
< / body >
< / html >