restructure ToC of reST docs
- completely decouple Java/Scala and remove heading suffixes - move all images into images/ - move cluster docs into “official” place
This commit is contained in:
Roland
parent
c86cc0b8f7
commit
63c6bc7d88
89 changed files with 252 additions and 336 deletions
|
|
@ -1,13 +0,0 @@
|
||||||
package akka.ticket
|
|
||||||
|
|
||||||
import org.scalatest.WordSpec
|
|
||||||
import org.scalatest.matchers.MustMatchers
|
|
||||||
|
|
||||||
class Ticket001Spec extends WordSpec with MustMatchers {
|
|
||||||
|
|
||||||
"An XXX" must {
|
|
||||||
"do YYY" in {
|
|
||||||
1 must be(1)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _http-module:
|
.. _http-module:
|
||||||
|
|
||||||
HTTP
|
Incomplete List of HTTP Frameworks
|
||||||
####
|
##################################
|
||||||
|
|
||||||
Play
|
Play
|
||||||
====
|
====
|
||||||
|
|
@ -8,3 +8,4 @@ Additional Information
|
||||||
recipes
|
recipes
|
||||||
language-bindings
|
language-bindings
|
||||||
osgi
|
osgi
|
||||||
|
http
|
||||||
|
|
|
||||||
|
|
@ -1,9 +0,0 @@
|
||||||
Cluster
|
|
||||||
=======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
cluster
|
|
||||||
cluster-usage-java
|
|
||||||
cluster-usage-scala
|
|
||||||
|
|
@ -300,7 +300,7 @@ provide cluster elasticity.
|
||||||
State Diagram for the Member States
|
State Diagram for the Member States
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
.. image:: images/member-states.png
|
.. image:: ../images/member-states.png
|
||||||
|
|
||||||
|
|
||||||
Member States
|
Member States
|
||||||
|
|
@ -1,8 +0,0 @@
|
||||||
Common utilities
|
|
||||||
==========================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
duration
|
|
||||||
circuitbreaker
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
Information for Developers
|
Information for Akka Developers
|
||||||
==========================
|
===============================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
|
||||||
|
|
@ -5,26 +5,30 @@
|
||||||
Team
|
Team
|
||||||
######
|
######
|
||||||
|
|
||||||
=================== ========================== ====================================
|
=================== ==========================
|
||||||
Name Role Email
|
Name Role
|
||||||
=================== ========================== ====================================
|
=================== ==========================
|
||||||
Jonas Bonér Founder, Despot, Committer jonas AT jonasboner DOT com
|
Jonas Bonér Founder, Despot, Committer
|
||||||
Viktor Klang Project Owner viktor DOT klang AT gmail DOT com
|
Viktor Klang Honorary Member
|
||||||
Roland Kuhn Committer
|
Roland Kuhn Project Lead
|
||||||
Patrik Nordwall Committer patrik DOT nordwall AT gmail DOT com
|
Patrik Nordwall Core Team
|
||||||
Derek Williams Committer derek AT nebvin DOT ca
|
Björn Antonsson Core Team
|
||||||
Henrik Engström Committer
|
Endre Varga Core Team
|
||||||
Peter Vlugter Committer
|
Mathias Doenitz Committer
|
||||||
Martin Krasser Committer krasserm AT googlemail DOT com
|
Johannes Rudolph Committer
|
||||||
Raymond Roestenburg Committer
|
Raymond Roestenburg Committer
|
||||||
Piotr Gabryanczyk Committer
|
Piotr Gabryanczyk Committer
|
||||||
Helena Edelson Committer helena AT helenaedelson DOT com
|
Helena Edelson Committer
|
||||||
Debasish Ghosh Alumnus dghosh AT acm DOT org
|
Henrik Engström Alumnus
|
||||||
Ross McDonald Alumnus rossajmcd AT gmail DOT com
|
Peter Vlugter Alumnus
|
||||||
|
Martin Krasser Alumnus
|
||||||
|
Derek Williams Alumnus
|
||||||
|
Debasish Ghosh Alumnus
|
||||||
|
Ross McDonald Alumnus
|
||||||
Eckhart Hertzler Alumnus
|
Eckhart Hertzler Alumnus
|
||||||
Mikael Högqvist Alumnus
|
Mikael Högqvist Alumnus
|
||||||
Tim Perrett Alumnus
|
Tim Perrett Alumnus
|
||||||
Jeanfrancois Arcand Alumnus jfarcand AT apache DOT org
|
Jeanfrancois Arcand Alumnus
|
||||||
Jan Van Besien Alumnus
|
Jan Van Besien Alumnus
|
||||||
Michael Kober Alumnus
|
Michael Kober Alumnus
|
||||||
Peter Veentjer Alumnus
|
Peter Veentjer Alumnus
|
||||||
|
|
@ -32,5 +36,4 @@ Irmo Manie Alumnus
|
||||||
Heiko Seeberger Alumnus
|
Heiko Seeberger Alumnus
|
||||||
Hiram Chirino Alumnus
|
Hiram Chirino Alumnus
|
||||||
Scott Clasen Alumnus
|
Scott Clasen Alumnus
|
||||||
|
=================== ==========================
|
||||||
=================== ========================== ====================================
|
|
||||||
|
|
|
||||||
|
|
@ -19,7 +19,6 @@ prior deprecation.
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
../cluster/index
|
|
||||||
../dev/multi-node-testing
|
../dev/multi-node-testing
|
||||||
|
|
||||||
Another reason for marking a module as experimental is that it's too early
|
Another reason for marking a module as experimental is that it's too early
|
||||||
|
|
|
||||||
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 7.3 KiB After Width: | Height: | Size: 7.3 KiB |
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
|
|
@ -2,33 +2,7 @@ Contents
|
||||||
========
|
========
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 1
|
||||||
|
|
||||||
intro/index
|
|
||||||
general/index
|
|
||||||
common/index
|
|
||||||
java/index
|
|
||||||
scala/index
|
|
||||||
modules/index
|
|
||||||
experimental/index
|
|
||||||
dev/index
|
|
||||||
project/index
|
|
||||||
additional/index
|
|
||||||
|
|
||||||
Links
|
|
||||||
=====
|
|
||||||
|
|
||||||
* :ref:`migration`
|
|
||||||
|
|
||||||
* `Downloads <http://typesafe.com/stack/downloads/akka/>`_
|
|
||||||
|
|
||||||
* `Source Code <http://github.com/akka/akka>`_
|
|
||||||
|
|
||||||
* :ref:`scaladoc`
|
|
||||||
|
|
||||||
* :ref:`other-doc`
|
|
||||||
|
|
||||||
* :ref:`issue_tracking`
|
|
||||||
|
|
||||||
* :ref:`support`
|
|
||||||
|
|
||||||
|
java
|
||||||
|
scala
|
||||||
|
|
|
||||||
20
akka-docs/rst/java.rst
Normal file
20
akka-docs/rst/java.rst
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
.. _java-api:
|
||||||
|
|
||||||
|
Java Documentation
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
intro/index
|
||||||
|
general/index
|
||||||
|
java/index-actors
|
||||||
|
java/index-futures
|
||||||
|
java/index-network
|
||||||
|
java/index-utilities
|
||||||
|
java/howto
|
||||||
|
experimental/index
|
||||||
|
dev/index
|
||||||
|
project/index
|
||||||
|
additional/index
|
||||||
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _agents-java:
|
.. _agents-java:
|
||||||
|
|
||||||
##############
|
##############
|
||||||
Agents (Java)
|
Agents
|
||||||
##############
|
##############
|
||||||
|
|
||||||
Agents in Akka are inspired by `agents in Clojure`_.
|
Agents in Akka are inspired by `agents in Clojure`_.
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _camel-java:
|
.. _camel-java:
|
||||||
|
|
||||||
#############
|
#############
|
||||||
Camel (Java)
|
Camel
|
||||||
#############
|
#############
|
||||||
|
|
||||||
Additional Resources
|
Additional Resources
|
||||||
|
|
@ -495,7 +495,7 @@ is then forwarded to the ``HttpTransformer`` actor which replaces all occurrence
|
||||||
of *Akka* with *AKKA*. The transformation result is sent back the HttpConsumer
|
of *Akka* with *AKKA*. The transformation result is sent back the HttpConsumer
|
||||||
which finally returns it to the browser.
|
which finally returns it to the browser.
|
||||||
|
|
||||||
.. image:: ../modules/camel-async-interact.png
|
.. image:: ../images/camel-async-interact.png
|
||||||
|
|
||||||
Implementing the example actor classes and wiring them together is rather easy
|
Implementing the example actor classes and wiring them together is rather easy
|
||||||
as shown in the following snippet.
|
as shown in the following snippet.
|
||||||
|
|
@ -515,7 +515,7 @@ side. The following high-level sequence diagram illustrates that.
|
||||||
.. _Jetty continuations: http://wiki.eclipse.org/Jetty/Feature/Continuations
|
.. _Jetty continuations: http://wiki.eclipse.org/Jetty/Feature/Continuations
|
||||||
.. _Jetty's asynchronous HTTP client: http://wiki.eclipse.org/Jetty/Tutorial/HttpClient
|
.. _Jetty's asynchronous HTTP client: http://wiki.eclipse.org/Jetty/Tutorial/HttpClient
|
||||||
|
|
||||||
.. image:: ../modules/camel-async-sequence.png
|
.. image:: ../images/camel-async-sequence.png
|
||||||
|
|
||||||
Custom Camel route example
|
Custom Camel route example
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
@ -524,7 +524,7 @@ This section also demonstrates the combined usage of a ``Producer`` and a
|
||||||
``Consumer`` actor as well as the inclusion of a custom Camel route. The
|
``Consumer`` actor as well as the inclusion of a custom Camel route. The
|
||||||
following figure gives an overview.
|
following figure gives an overview.
|
||||||
|
|
||||||
.. image:: ../modules/camel-custom-route.png
|
.. image:: ../images/camel-custom-route.png
|
||||||
|
|
||||||
* A consumer actor receives a message from an HTTP client
|
* A consumer actor receives a message from an HTTP client
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _cluster_usage_java:
|
.. _cluster_usage_java:
|
||||||
|
|
||||||
######################
|
######################
|
||||||
Cluster Usage (Java)
|
Cluster Usage
|
||||||
######################
|
######################
|
||||||
|
|
||||||
.. note:: This module is :ref:`experimental <experimental>`. This document describes how to use the features implemented so far. More features are coming in Akka Coltrane. Track progress of the Coltrane milestone in `Assembla <http://www.assembla.com/spaces/akka/tickets>`_ and the `Roadmap <https://docs.google.com/document/d/18W9-fKs55wiFNjXL9q50PYOnR7-nnsImzJqHOPPbM4E/edit?hl=en_US>`_.
|
.. note:: This module is :ref:`experimental <experimental>`. This document describes how to use the features implemented so far. More features are coming in Akka Coltrane. Track progress of the Coltrane milestone in `Assembla <http://www.assembla.com/spaces/akka/tickets>`_ and the `Roadmap <https://docs.google.com/document/d/18W9-fKs55wiFNjXL9q50PYOnR7-nnsImzJqHOPPbM4E/edit?hl=en_US>`_.
|
||||||
|
|
@ -322,7 +322,7 @@ order to account for network issues that sometimes occur on such platforms.
|
||||||
The following chart illustrates how *phi* increase with increasing time since the
|
The following chart illustrates how *phi* increase with increasing time since the
|
||||||
previous heartbeat.
|
previous heartbeat.
|
||||||
|
|
||||||
.. image:: images/phi1.png
|
.. image:: ../images/phi1.png
|
||||||
|
|
||||||
Phi is calculated from the mean and standard deviation of historical
|
Phi is calculated from the mean and standard deviation of historical
|
||||||
inter arrival times. The previous chart is an example for standard deviation
|
inter arrival times. The previous chart is an example for standard deviation
|
||||||
|
|
@ -330,7 +330,7 @@ of 200 ms. If the heartbeats arrive with less deviation the curve becomes steepe
|
||||||
i.e. it is possible to determine failure more quickly. The curve looks like this for
|
i.e. it is possible to determine failure more quickly. The curve looks like this for
|
||||||
a standard deviation of 100 ms.
|
a standard deviation of 100 ms.
|
||||||
|
|
||||||
.. image:: images/phi2.png
|
.. image:: ../images/phi2.png
|
||||||
|
|
||||||
To be able to survive sudden abnormalities, such as garbage collection pauses and
|
To be able to survive sudden abnormalities, such as garbage collection pauses and
|
||||||
transient network failures the failure detector is configured with a margin,
|
transient network failures the failure detector is configured with a margin,
|
||||||
|
|
@ -339,7 +339,7 @@ adjust the :ref:`cluster_configuration_java` of this depending on you environmen
|
||||||
This is how the curve looks like for ``acceptable-heartbeat-pause`` configured to
|
This is how the curve looks like for ``acceptable-heartbeat-pause`` configured to
|
||||||
3 seconds.
|
3 seconds.
|
||||||
|
|
||||||
.. image:: images/phi3.png
|
.. image:: ../images/phi3.png
|
||||||
|
|
||||||
Death watch uses the cluster failure detector for nodes in the cluster, i.e. it
|
Death watch uses the cluster failure detector for nodes in the cluster, i.e. it
|
||||||
generates ``Terminated`` message from network failures and JVM crashes, in addition
|
generates ``Terminated`` message from network failures and JVM crashes, in addition
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.. _dispatchers-java:
|
.. _dispatchers-java:
|
||||||
|
|
||||||
Dispatchers (Java)
|
Dispatchers
|
||||||
===================
|
===================
|
||||||
|
|
||||||
An Akka ``MessageDispatcher`` is what makes Akka Actors "tick", it is the engine of the machine so to speak.
|
An Akka ``MessageDispatcher`` is what makes Akka Actors "tick", it is the engine of the machine so to speak.
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _durable-mailboxes-java:
|
.. _durable-mailboxes-java:
|
||||||
|
|
||||||
##########################
|
##########################
|
||||||
Durable Mailboxes (Java)
|
Durable Mailboxes
|
||||||
##########################
|
##########################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _event-bus-java:
|
.. _event-bus-java:
|
||||||
|
|
||||||
################
|
################
|
||||||
Event Bus (Java)
|
Event Bus
|
||||||
################
|
################
|
||||||
|
|
||||||
Originally conceived as a way to send messages to groups of actors, the
|
Originally conceived as a way to send messages to groups of actors, the
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _extending-akka-java:
|
.. _extending-akka-java:
|
||||||
|
|
||||||
########################
|
########################
|
||||||
Akka Extensions (Java)
|
Akka Extensions
|
||||||
########################
|
########################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.. _fault-tolerance-sample-java:
|
.. _fault-tolerance-sample-java:
|
||||||
|
|
||||||
Diagrams of the Fault Tolerance Sample (Java)
|
Diagrams of the Fault Tolerance Sample
|
||||||
----------------------------------------------
|
----------------------------------------------
|
||||||
|
|
||||||
.. image:: ../images/faulttolerancesample-normal-flow.png
|
.. image:: ../images/faulttolerancesample-normal-flow.png
|
||||||
|
|
@ -46,7 +46,7 @@ Step Description
|
||||||
15, 16 and tells the ``Counter`` to use the new ``Storage``
|
15, 16 and tells the ``Counter`` to use the new ``Storage``
|
||||||
=========== ==================================================================================
|
=========== ==================================================================================
|
||||||
|
|
||||||
Full Source Code of the Fault Tolerance Sample (Java)
|
Full Source Code of the Fault Tolerance Sample
|
||||||
------------------------------------------------------
|
------------------------------------------------------
|
||||||
|
|
||||||
.. includecode:: code/docs/actor/japi/FaultHandlingDocSample.java#all
|
.. includecode:: code/docs/actor/japi/FaultHandlingDocSample.java#all
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.. _fault-tolerance-java:
|
.. _fault-tolerance-java:
|
||||||
|
|
||||||
Fault Tolerance (Java)
|
Fault Tolerance
|
||||||
======================
|
======================
|
||||||
|
|
||||||
As explained in :ref:`actor-systems` each actor is the supervisor of its
|
As explained in :ref:`actor-systems` each actor is the supervisor of its
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _fsm-java:
|
.. _fsm-java:
|
||||||
|
|
||||||
###########################################
|
###########################################
|
||||||
Building Finite State Machine Actors (Java)
|
Building Finite State Machine Actors
|
||||||
###########################################
|
###########################################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.. _futures-java:
|
.. _futures-java:
|
||||||
|
|
||||||
Futures (Java)
|
Futures
|
||||||
===============
|
===============
|
||||||
|
|
||||||
Introduction
|
Introduction
|
||||||
|
|
|
||||||
13
akka-docs/rst/java/index-actors.rst
Normal file
13
akka-docs/rst/java/index-actors.rst
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
Actors
|
||||||
|
======
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
untyped-actors
|
||||||
|
typed-actors
|
||||||
|
fault-tolerance
|
||||||
|
dispatchers
|
||||||
|
routing
|
||||||
|
fsm
|
||||||
|
testing
|
||||||
10
akka-docs/rst/java/index-futures.rst
Normal file
10
akka-docs/rst/java/index-futures.rst
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
Futures and Agents
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
futures
|
||||||
|
stm
|
||||||
|
agents
|
||||||
|
transactors
|
||||||
13
akka-docs/rst/java/index-network.rst
Normal file
13
akka-docs/rst/java/index-network.rst
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
Networking
|
||||||
|
==========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
../common/cluster
|
||||||
|
cluster-usage
|
||||||
|
remoting
|
||||||
|
serialization
|
||||||
|
io
|
||||||
|
zeromq
|
||||||
|
camel
|
||||||
14
akka-docs/rst/java/index-utilities.rst
Normal file
14
akka-docs/rst/java/index-utilities.rst
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
Utilities
|
||||||
|
=========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
event-bus
|
||||||
|
logging
|
||||||
|
scheduler
|
||||||
|
../common/duration
|
||||||
|
../common/circuitbreaker
|
||||||
|
extending-akka
|
||||||
|
durable-mailbox
|
||||||
|
microkernel
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
.. _java-api:
|
|
||||||
|
|
||||||
Java API
|
|
||||||
=========
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
untyped-actors
|
|
||||||
typed-actors
|
|
||||||
logging
|
|
||||||
event-bus
|
|
||||||
scheduler
|
|
||||||
futures
|
|
||||||
fault-tolerance
|
|
||||||
dispatchers
|
|
||||||
routing
|
|
||||||
remoting
|
|
||||||
serialization
|
|
||||||
stm
|
|
||||||
agents
|
|
||||||
transactors
|
|
||||||
io
|
|
||||||
fsm
|
|
||||||
testing
|
|
||||||
extending-akka
|
|
||||||
zeromq
|
|
||||||
microkernel
|
|
||||||
camel
|
|
||||||
durable-mailbox
|
|
||||||
howto
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.. _io-java:
|
.. _io-java:
|
||||||
|
|
||||||
I/O (Java)
|
I/O
|
||||||
==========
|
==========
|
||||||
|
|
||||||
Introduction
|
Introduction
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _logging-java:
|
.. _logging-java:
|
||||||
|
|
||||||
################
|
################
|
||||||
Logging (Java)
|
Logging
|
||||||
################
|
################
|
||||||
|
|
||||||
Logging in Akka is not tied to a specific logging backend. By default
|
Logging in Akka is not tied to a specific logging backend. By default
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
|
|
||||||
.. _microkernel-java:
|
.. _microkernel-java:
|
||||||
|
|
||||||
Microkernel (Java)
|
Microkernel
|
||||||
==================
|
==================
|
||||||
|
|
||||||
The purpose of the Akka Microkernel is to offer a bundling mechanism so that you can distribute
|
The purpose of the Akka Microkernel is to offer a bundling mechanism so that you can distribute
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _remoting-java:
|
.. _remoting-java:
|
||||||
|
|
||||||
#####################
|
#####################
|
||||||
Remoting (Java)
|
Remoting
|
||||||
#####################
|
#####################
|
||||||
|
|
||||||
For an introduction of remoting capabilities of Akka please see :ref:`remoting`.
|
For an introduction of remoting capabilities of Akka please see :ref:`remoting`.
|
||||||
|
|
@ -190,7 +190,7 @@ order to account for network issues that sometimes occur on such platforms.
|
||||||
The following chart illustrates how *phi* increase with increasing time since the
|
The following chart illustrates how *phi* increase with increasing time since the
|
||||||
previous heartbeat.
|
previous heartbeat.
|
||||||
|
|
||||||
.. image:: ../cluster/images/phi1.png
|
.. image:: ../images/phi1.png
|
||||||
|
|
||||||
Phi is calculated from the mean and standard deviation of historical
|
Phi is calculated from the mean and standard deviation of historical
|
||||||
inter arrival times. The previous chart is an example for standard deviation
|
inter arrival times. The previous chart is an example for standard deviation
|
||||||
|
|
@ -198,7 +198,7 @@ of 200 ms. If the heartbeats arrive with less deviation the curve becomes steepe
|
||||||
i.e. it is possible to determine failure more quickly. The curve looks like this for
|
i.e. it is possible to determine failure more quickly. The curve looks like this for
|
||||||
a standard deviation of 100 ms.
|
a standard deviation of 100 ms.
|
||||||
|
|
||||||
.. image:: ../cluster/images/phi2.png
|
.. image:: ../images/phi2.png
|
||||||
|
|
||||||
To be able to survive sudden abnormalities, such as garbage collection pauses and
|
To be able to survive sudden abnormalities, such as garbage collection pauses and
|
||||||
transient network failures the failure detector is configured with a margin,
|
transient network failures the failure detector is configured with a margin,
|
||||||
|
|
@ -207,7 +207,7 @@ adjust the :ref:`remote-configuration-java` of this depending on you environment
|
||||||
This is how the curve looks like for ``acceptable-heartbeat-pause`` configured to
|
This is how the curve looks like for ``acceptable-heartbeat-pause`` configured to
|
||||||
3 seconds.
|
3 seconds.
|
||||||
|
|
||||||
.. image:: ../cluster/images/phi3.png
|
.. image:: ../images/phi3.png
|
||||||
|
|
||||||
Serialization
|
Serialization
|
||||||
^^^^^^^^^^^^^
|
^^^^^^^^^^^^^
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
|
|
||||||
.. _routing-java:
|
.. _routing-java:
|
||||||
|
|
||||||
Routing (Java)
|
Routing
|
||||||
==============
|
==============
|
||||||
|
|
||||||
A Router is an actor that receives messages and efficiently routes them to other actors, known as
|
A Router is an actor that receives messages and efficiently routes them to other actors, known as
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _scheduler-java:
|
.. _scheduler-java:
|
||||||
|
|
||||||
##################
|
##################
|
||||||
Scheduler (Java)
|
Scheduler
|
||||||
##################
|
##################
|
||||||
|
|
||||||
Sometimes the need for making things happen in the future arises, and where do
|
Sometimes the need for making things happen in the future arises, and where do
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _serialization-java:
|
.. _serialization-java:
|
||||||
|
|
||||||
#####################
|
#####################
|
||||||
Serialization (Java)
|
Serialization
|
||||||
#####################
|
#####################
|
||||||
|
|
||||||
Akka has a built-in Extension for serialization,
|
Akka has a built-in Extension for serialization,
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _stm-java:
|
.. _stm-java:
|
||||||
|
|
||||||
#####################################
|
#####################################
|
||||||
Software Transactional Memory (Java)
|
Software Transactional Memory
|
||||||
#####################################
|
#####################################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _akka-testkit-java:
|
.. _akka-testkit-java:
|
||||||
|
|
||||||
##############################
|
##############################
|
||||||
Testing Actor Systems (Java)
|
Testing Actor Systems
|
||||||
##############################
|
##############################
|
||||||
|
|
||||||
As with any piece of software, automated tests are a very important part of the
|
As with any piece of software, automated tests are a very important part of the
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _transactors-java:
|
.. _transactors-java:
|
||||||
|
|
||||||
####################
|
####################
|
||||||
Transactors (Java)
|
Transactors
|
||||||
####################
|
####################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
Typed Actors (Java)
|
Typed Actors
|
||||||
===================
|
===================
|
||||||
|
|
||||||
Akka Typed Actors is an implementation of the `Active Objects <http://en.wikipedia.org/wiki/Active_object>`_ pattern.
|
Akka Typed Actors is an implementation of the `Active Objects <http://en.wikipedia.org/wiki/Active_object>`_ pattern.
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _untyped-actors-java:
|
.. _untyped-actors-java:
|
||||||
|
|
||||||
################
|
################
|
||||||
Actors (Java)
|
Actors
|
||||||
################
|
################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _zeromq-java:
|
.. _zeromq-java:
|
||||||
|
|
||||||
###############
|
###############
|
||||||
ZeroMQ (Java)
|
ZeroMQ
|
||||||
###############
|
###############
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
Modules
|
|
||||||
=======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
http
|
|
||||||
|
|
@ -5,9 +5,6 @@ Project Information
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
migration-guides
|
migration-guides
|
||||||
release-notes
|
|
||||||
scaladoc
|
|
||||||
other-doc
|
|
||||||
issue-tracking
|
issue-tracking
|
||||||
licenses
|
licenses
|
||||||
sponsors
|
sponsors
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@ Tickets
|
||||||
Roadmaps
|
Roadmaps
|
||||||
^^^^^^^^
|
^^^^^^^^
|
||||||
|
|
||||||
`The roadmap for each Akka milestone is here <https://www.assembla.com/spaces/akka/milestones>`_
|
`The roadmap for each Akka milestone is here <https://docs.google.com/document/d/18W9-fKs55wiFNjXL9q50PYOnR7-nnsImzJqHOPPbM4E/pub>`_
|
||||||
|
|
||||||
|
|
||||||
Creating tickets
|
Creating tickets
|
||||||
|
|
@ -30,24 +30,6 @@ Then you also need to become a "Watcher" of the Akka space.
|
||||||
|
|
||||||
`Link to create a new ticket <https://www.assembla.com/spaces/akka/tickets/new>`__
|
`Link to create a new ticket <https://www.assembla.com/spaces/akka/tickets/new>`__
|
||||||
|
|
||||||
Thanks a lot for reporting bugs and suggesting features.
|
Thanks a lot for reporting bugs and suggesting features. *Please include the versions of Scala and Akka and relevant configuration files.*
|
||||||
|
|
||||||
|
|
||||||
Failing test
|
|
||||||
------------
|
|
||||||
|
|
||||||
Please submit a failing test on the following format:
|
|
||||||
|
|
||||||
.. code-block:: scala
|
|
||||||
|
|
||||||
import org.scalatest.WordSpec
|
|
||||||
import org.scalatest.matchers.MustMatchers
|
|
||||||
|
|
||||||
class Ticket001Spec extends WordSpec with MustMatchers {
|
|
||||||
|
|
||||||
"An XXX" must {
|
|
||||||
"do YYY" in {
|
|
||||||
1 must be (1)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
|
||||||
|
|
@ -35,33 +35,18 @@ Akka uses Git and is hosted at `Github <http://github.com>`_.
|
||||||
Releases Repository
|
Releases Repository
|
||||||
^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
The Akka Maven repository can be found at http://repo.akka.io/releases/.
|
All Akka releases are published via Sonatype to Maven Central, see
|
||||||
|
`search.maven.org
|
||||||
Typesafe provides http://repo.typesafe.com/typesafe/releases/ that proxies
|
<http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.typesafe.akka%22>`_
|
||||||
several other repositories, including akka.io. It is convenient to use the
|
|
||||||
Typesafe repository, since it includes all external dependencies of Akka. It is
|
|
||||||
a "best-effort" service, and if it is unavailable you may need to use the
|
|
||||||
underlying repositories directly.
|
|
||||||
|
|
||||||
* http://repo.akka.io/releases/
|
|
||||||
* http://repository.codehaus.org/
|
|
||||||
* http://guiceyfruit.googlecode.com/svn/repo/releases/
|
|
||||||
* http://repository.jboss.org/nexus/content/groups/public/
|
|
||||||
* http://download.java.net/maven/2/
|
|
||||||
* http://oss.sonatype.org/content/repositories/releases/
|
|
||||||
* http://download.java.net/maven/glassfish/
|
|
||||||
* http://databinder.net/repo/
|
|
||||||
|
|
||||||
|
|
||||||
Snapshots Repository
|
Snapshots Repository
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
Nightly builds are available in http://repo.akka.io/snapshots/ and proxied through
|
Nightly builds are available in http://repo.akka.io/snapshots/ as both ``SNAPSHOT`` and
|
||||||
http://repo.typesafe.com/typesafe/snapshots/ as both ``SNAPSHOT`` and
|
|
||||||
timestamped versions.
|
timestamped versions.
|
||||||
|
|
||||||
For timestamped versions, pick a timestamp from
|
For timestamped versions, pick a timestamp from
|
||||||
http://repo.typesafe.com/typesafe/snapshots/com/typesafe/akka/akka-actor_@binVersion@/.
|
http://repo.akka.io/snapshots/com/typesafe/akka/akka-actor_@binVersion@/.
|
||||||
All Akka modules that belong to the same build have the same timestamp.
|
All Akka modules that belong to the same build have the same timestamp.
|
||||||
|
|
||||||
sbt definition of snapshot repository
|
sbt definition of snapshot repository
|
||||||
|
|
@ -69,7 +54,7 @@ sbt definition of snapshot repository
|
||||||
|
|
||||||
Make sure that you add the repository to the sbt resolvers::
|
Make sure that you add the repository to the sbt resolvers::
|
||||||
|
|
||||||
resolvers += "Typesafe Snapshots" at "http://repo.typesafe.com/typesafe/snapshots/"
|
resolvers += "Typesafe Snapshots" at "http://repo.akka.io/snapshots/"
|
||||||
|
|
||||||
Define the library dependencies with the timestamp as version. For example::
|
Define the library dependencies with the timestamp as version. For example::
|
||||||
|
|
||||||
|
|
@ -83,9 +68,9 @@ Make sure that you add the repository to the maven repositories in pom.xml::
|
||||||
|
|
||||||
<repositories>
|
<repositories>
|
||||||
<repository>
|
<repository>
|
||||||
<id>typesafe-snapshots</id>
|
<id>akka-snapshots</id>
|
||||||
<name>Typesafe Snapshots</name>
|
<name>Akka Snapshots</name>
|
||||||
<url>http://repo.typesafe.com/typesafe/snapshots/</url>
|
<url>http://repo.akka.io/snapshots/</url>
|
||||||
<layout>default</layout>
|
<layout>default</layout>
|
||||||
</repository>
|
</repository>
|
||||||
</repositories>
|
</repositories>
|
||||||
|
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
|
|
||||||
.. _other-doc:
|
|
||||||
|
|
||||||
##################################
|
|
||||||
Documentation for Other Versions
|
|
||||||
##################################
|
|
||||||
|
|
||||||
|
|
||||||
Release Versions
|
|
||||||
================
|
|
||||||
|
|
||||||
2.0
|
|
||||||
---
|
|
||||||
|
|
||||||
- Akka 2.0 - http://doc.akka.io/docs/akka/2.0/ (or in `PDF format <http://doc.akka.io/docs/akka/2.0/Akka.pdf>`__)
|
|
||||||
|
|
||||||
1.3.1
|
|
||||||
-----
|
|
||||||
|
|
||||||
- Akka 1.3.1 - http://doc.akka.io/docs/akka/1.3.1/ (or in `PDF format <http://doc.akka.io/docs/akka/1.3.1/Akka.pdf>`__)
|
|
||||||
- Akka Modules 1.3.1 - http://doc.akka.io/docs/akka-modules/1.3.1/ (or in `PDF format <http://doc.akka.io/docs/akka-modules/1.3.1/AkkaModules.pdf>`__)
|
|
||||||
|
|
||||||
|
|
||||||
Akka Snapshot
|
|
||||||
=============
|
|
||||||
|
|
||||||
Automatically published documentation for the latest SNAPSHOT version of Akka can
|
|
||||||
be found here:
|
|
||||||
|
|
||||||
- Akka - http://doc.akka.io/docs/akka/snapshot/ (or in `PDF format <http://doc.akka.io/docs/akka/snapshot/Akka.pdf>`__)
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
Release Notes
|
|
||||||
==============
|
|
||||||
|
|
||||||
Release 2.1
|
|
||||||
-----------
|
|
||||||
|
|
||||||
Release notes for 2.1 will be written...
|
|
||||||
|
|
@ -1,29 +0,0 @@
|
||||||
|
|
||||||
.. _scaladoc:
|
|
||||||
|
|
||||||
##############
|
|
||||||
Scaladoc API
|
|
||||||
##############
|
|
||||||
|
|
||||||
|
|
||||||
Release Versions
|
|
||||||
================
|
|
||||||
|
|
||||||
2.0
|
|
||||||
-----
|
|
||||||
|
|
||||||
- Akka - http://doc.akka.io/api/akka/2.0/
|
|
||||||
|
|
||||||
|
|
||||||
1.3.1
|
|
||||||
-----
|
|
||||||
|
|
||||||
- Akka 1.3.1 - http://doc.akka.io/api/akka/1.3.1/
|
|
||||||
- Akka Modules 1.3.1 - http://doc.akka.io/api/akka-modules/1.3.1/
|
|
||||||
|
|
||||||
|
|
||||||
Akka Snapshot
|
|
||||||
=============
|
|
||||||
|
|
||||||
Automatically published Scaladoc API for the latest SNAPSHOT version of Akka can
|
|
||||||
be found here: http://doc.akka.io/api/akka/snapshot
|
|
||||||
20
akka-docs/rst/scala.rst
Normal file
20
akka-docs/rst/scala.rst
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
.. _scala-api:
|
||||||
|
|
||||||
|
Scala Documentation
|
||||||
|
===================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
intro/index
|
||||||
|
general/index
|
||||||
|
scala/index-actors
|
||||||
|
scala/index-futures
|
||||||
|
scala/index-network
|
||||||
|
scala/index-utilities
|
||||||
|
scala/howto
|
||||||
|
experimental/index
|
||||||
|
dev/index
|
||||||
|
project/index
|
||||||
|
additional/index
|
||||||
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _actors-scala:
|
.. _actors-scala:
|
||||||
|
|
||||||
################
|
################
|
||||||
Actors (Scala)
|
Actors
|
||||||
################
|
################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _agents-scala:
|
.. _agents-scala:
|
||||||
|
|
||||||
################
|
################
|
||||||
Agents (Scala)
|
Agents
|
||||||
################
|
################
|
||||||
|
|
||||||
Agents in Akka are inspired by `agents in Clojure`_.
|
Agents in Akka are inspired by `agents in Clojure`_.
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _camel-scala:
|
.. _camel-scala:
|
||||||
|
|
||||||
##############
|
##############
|
||||||
Camel (Scala)
|
Camel
|
||||||
##############
|
##############
|
||||||
|
|
||||||
Additional Resources
|
Additional Resources
|
||||||
|
|
@ -489,7 +489,7 @@ is then forwarded to the ``HttpTransformer`` actor which replaces all occurrence
|
||||||
of *Akka* with *AKKA*. The transformation result is sent back the HttpConsumer
|
of *Akka* with *AKKA*. The transformation result is sent back the HttpConsumer
|
||||||
which finally returns it to the browser.
|
which finally returns it to the browser.
|
||||||
|
|
||||||
.. image:: ../modules/camel-async-interact.png
|
.. image:: ../images/camel-async-interact.png
|
||||||
|
|
||||||
Implementing the example actor classes and wiring them together is rather easy
|
Implementing the example actor classes and wiring them together is rather easy
|
||||||
as shown in the following snippet.
|
as shown in the following snippet.
|
||||||
|
|
@ -506,7 +506,7 @@ side. The following high-level sequence diagram illustrates that.
|
||||||
.. _Jetty continuations: http://wiki.eclipse.org/Jetty/Feature/Continuations
|
.. _Jetty continuations: http://wiki.eclipse.org/Jetty/Feature/Continuations
|
||||||
.. _Jetty's asynchronous HTTP client: http://wiki.eclipse.org/Jetty/Tutorial/HttpClient
|
.. _Jetty's asynchronous HTTP client: http://wiki.eclipse.org/Jetty/Tutorial/HttpClient
|
||||||
|
|
||||||
.. image:: ../modules/camel-async-sequence.png
|
.. image:: ../images/camel-async-sequence.png
|
||||||
|
|
||||||
Custom Camel route example
|
Custom Camel route example
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
@ -515,7 +515,7 @@ This section also demonstrates the combined usage of a ``Producer`` and a
|
||||||
``Consumer`` actor as well as the inclusion of a custom Camel route. The
|
``Consumer`` actor as well as the inclusion of a custom Camel route. The
|
||||||
following figure gives an overview.
|
following figure gives an overview.
|
||||||
|
|
||||||
.. image:: ../modules/camel-custom-route.png
|
.. image:: ../images/camel-custom-route.png
|
||||||
|
|
||||||
* A consumer actor receives a message from an HTTP client
|
* A consumer actor receives a message from an HTTP client
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _cluster_usage_scala:
|
.. _cluster_usage_scala:
|
||||||
|
|
||||||
#######################
|
#######################
|
||||||
Cluster Usage (Scala)
|
Cluster Usage
|
||||||
#######################
|
#######################
|
||||||
|
|
||||||
.. note:: This module is :ref:`experimental <experimental>`. This document describes how to use the features implemented so far. More features are coming in Akka Coltrane. Track progress of the Coltrane milestone in `Assembla <http://www.assembla.com/spaces/akka/tickets>`_ and the `Roadmap <https://docs.google.com/document/d/18W9-fKs55wiFNjXL9q50PYOnR7-nnsImzJqHOPPbM4E/edit?hl=en_US>`_.
|
.. note:: This module is :ref:`experimental <experimental>`. This document describes how to use the features implemented so far. More features are coming in Akka Coltrane. Track progress of the Coltrane milestone in `Assembla <http://www.assembla.com/spaces/akka/tickets>`_ and the `Roadmap <https://docs.google.com/document/d/18W9-fKs55wiFNjXL9q50PYOnR7-nnsImzJqHOPPbM4E/edit?hl=en_US>`_.
|
||||||
|
|
@ -310,7 +310,7 @@ order to account for network issues that sometimes occur on such platforms.
|
||||||
The following chart illustrates how *phi* increase with increasing time since the
|
The following chart illustrates how *phi* increase with increasing time since the
|
||||||
previous heartbeat.
|
previous heartbeat.
|
||||||
|
|
||||||
.. image:: images/phi1.png
|
.. image:: ../images/phi1.png
|
||||||
|
|
||||||
Phi is calculated from the mean and standard deviation of historical
|
Phi is calculated from the mean and standard deviation of historical
|
||||||
inter arrival times. The previous chart is an example for standard deviation
|
inter arrival times. The previous chart is an example for standard deviation
|
||||||
|
|
@ -318,7 +318,7 @@ of 200 ms. If the heartbeats arrive with less deviation the curve becomes steepe
|
||||||
i.e. it is possible to determine failure more quickly. The curve looks like this for
|
i.e. it is possible to determine failure more quickly. The curve looks like this for
|
||||||
a standard deviation of 100 ms.
|
a standard deviation of 100 ms.
|
||||||
|
|
||||||
.. image:: images/phi2.png
|
.. image:: ../images/phi2.png
|
||||||
|
|
||||||
To be able to survive sudden abnormalities, such as garbage collection pauses and
|
To be able to survive sudden abnormalities, such as garbage collection pauses and
|
||||||
transient network failures the failure detector is configured with a margin,
|
transient network failures the failure detector is configured with a margin,
|
||||||
|
|
@ -327,7 +327,7 @@ adjust the :ref:`cluster_configuration_scala` of this depending on you environme
|
||||||
This is how the curve looks like for ``acceptable-heartbeat-pause`` configured to
|
This is how the curve looks like for ``acceptable-heartbeat-pause`` configured to
|
||||||
3 seconds.
|
3 seconds.
|
||||||
|
|
||||||
.. image:: images/phi3.png
|
.. image:: ../images/phi3.png
|
||||||
|
|
||||||
|
|
||||||
Death watch uses the cluster failure detector for nodes in the cluster, i.e. it
|
Death watch uses the cluster failure detector for nodes in the cluster, i.e. it
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
Dataflow Concurrency (Scala)
|
Dataflow Concurrency
|
||||||
============================
|
============================
|
||||||
|
|
||||||
Description
|
Description
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.. _dispatchers-scala:
|
.. _dispatchers-scala:
|
||||||
|
|
||||||
Dispatchers (Scala)
|
Dispatchers
|
||||||
===================
|
===================
|
||||||
|
|
||||||
An Akka ``MessageDispatcher`` is what makes Akka Actors "tick", it is the engine of the machine so to speak.
|
An Akka ``MessageDispatcher`` is what makes Akka Actors "tick", it is the engine of the machine so to speak.
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _durable-mailboxes-scala:
|
.. _durable-mailboxes-scala:
|
||||||
|
|
||||||
###########################
|
###########################
|
||||||
Durable Mailboxes (Scala)
|
Durable Mailboxes
|
||||||
###########################
|
###########################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _event-bus-scala:
|
.. _event-bus-scala:
|
||||||
|
|
||||||
#################
|
#################
|
||||||
Event Bus (Scala)
|
Event Bus
|
||||||
#################
|
#################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _extending-akka-scala:
|
.. _extending-akka-scala:
|
||||||
|
|
||||||
#########################
|
#########################
|
||||||
Akka Extensions (Scala)
|
Akka Extensions
|
||||||
#########################
|
#########################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.. _fault-tolerance-sample-scala:
|
.. _fault-tolerance-sample-scala:
|
||||||
|
|
||||||
Diagrams of the Fault Tolerance Sample (Scala)
|
Diagrams of the Fault Tolerance Sample
|
||||||
----------------------------------------------
|
----------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -48,7 +48,7 @@ Step Description
|
||||||
15, 16 and tells the ``Counter`` to use the new ``Storage``
|
15, 16 and tells the ``Counter`` to use the new ``Storage``
|
||||||
=========== ==================================================================================
|
=========== ==================================================================================
|
||||||
|
|
||||||
Full Source Code of the Fault Tolerance Sample (Scala)
|
Full Source Code of the Fault Tolerance Sample
|
||||||
------------------------------------------------------
|
------------------------------------------------------
|
||||||
|
|
||||||
.. includecode:: code/docs/actor/FaultHandlingDocSample.scala#all
|
.. includecode:: code/docs/actor/FaultHandlingDocSample.scala#all
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.. _fault-tolerance-scala:
|
.. _fault-tolerance-scala:
|
||||||
|
|
||||||
Fault Tolerance (Scala)
|
Fault Tolerance
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
As explained in :ref:`actor-systems` each actor is the supervisor of its
|
As explained in :ref:`actor-systems` each actor is the supervisor of its
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.. _futures-scala:
|
.. _futures-scala:
|
||||||
|
|
||||||
Futures (Scala)
|
Futures
|
||||||
===============
|
===============
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
14
akka-docs/rst/scala/index-actors.rst
Normal file
14
akka-docs/rst/scala/index-actors.rst
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
Actors
|
||||||
|
======
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
actors
|
||||||
|
typed-channels
|
||||||
|
typed-actors
|
||||||
|
fault-tolerance
|
||||||
|
dispatchers
|
||||||
|
routing
|
||||||
|
fsm
|
||||||
|
testing
|
||||||
11
akka-docs/rst/scala/index-futures.rst
Normal file
11
akka-docs/rst/scala/index-futures.rst
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
Futures and Agents
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
futures
|
||||||
|
dataflow
|
||||||
|
stm
|
||||||
|
agents
|
||||||
|
transactors
|
||||||
13
akka-docs/rst/scala/index-network.rst
Normal file
13
akka-docs/rst/scala/index-network.rst
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
Networking
|
||||||
|
==========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
../common/cluster
|
||||||
|
cluster-usage
|
||||||
|
remoting
|
||||||
|
serialization
|
||||||
|
io
|
||||||
|
zeromq
|
||||||
|
camel
|
||||||
14
akka-docs/rst/scala/index-utilities.rst
Normal file
14
akka-docs/rst/scala/index-utilities.rst
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
Utilities
|
||||||
|
=========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
event-bus
|
||||||
|
logging
|
||||||
|
scheduler
|
||||||
|
../common/duration
|
||||||
|
../common/circuitbreaker
|
||||||
|
extending-akka
|
||||||
|
durable-mailbox
|
||||||
|
microkernel
|
||||||
|
|
@ -1,33 +0,0 @@
|
||||||
.. _scala-api:
|
|
||||||
|
|
||||||
Scala API
|
|
||||||
=========
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
actors
|
|
||||||
typed-actors
|
|
||||||
typed-channels
|
|
||||||
logging
|
|
||||||
event-bus
|
|
||||||
scheduler
|
|
||||||
futures
|
|
||||||
dataflow
|
|
||||||
fault-tolerance
|
|
||||||
dispatchers
|
|
||||||
routing
|
|
||||||
remoting
|
|
||||||
serialization
|
|
||||||
fsm
|
|
||||||
stm
|
|
||||||
agents
|
|
||||||
transactors
|
|
||||||
io
|
|
||||||
testing
|
|
||||||
extending-akka
|
|
||||||
zeromq
|
|
||||||
microkernel
|
|
||||||
camel
|
|
||||||
durable-mailbox
|
|
||||||
howto
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.. _io-scala-old:
|
.. _io-scala-old:
|
||||||
|
|
||||||
Old IO (Scala)
|
Old IO
|
||||||
==============
|
==============
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
.. _io-scala:
|
.. _io-scala:
|
||||||
|
|
||||||
I/O (Scala)
|
I/O
|
||||||
===========
|
===========
|
||||||
|
|
||||||
Introduction
|
Introduction
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _logging-scala:
|
.. _logging-scala:
|
||||||
|
|
||||||
#################
|
#################
|
||||||
Logging (Scala)
|
Logging
|
||||||
#################
|
#################
|
||||||
|
|
||||||
Logging in Akka is not tied to a specific logging backend. By default
|
Logging in Akka is not tied to a specific logging backend. By default
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
|
|
||||||
.. _microkernel-scala:
|
.. _microkernel-scala:
|
||||||
|
|
||||||
Microkernel (Scala)
|
Microkernel
|
||||||
===================
|
===================
|
||||||
|
|
||||||
The purpose of the Akka Microkernel is to offer a bundling mechanism so that you can distribute
|
The purpose of the Akka Microkernel is to offer a bundling mechanism so that you can distribute
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _remoting-scala:
|
.. _remoting-scala:
|
||||||
|
|
||||||
#################
|
#################
|
||||||
Remoting (Scala)
|
Remoting
|
||||||
#################
|
#################
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -197,7 +197,7 @@ order to account for network issues that sometimes occur on such platforms.
|
||||||
The following chart illustrates how *phi* increase with increasing time since the
|
The following chart illustrates how *phi* increase with increasing time since the
|
||||||
previous heartbeat.
|
previous heartbeat.
|
||||||
|
|
||||||
.. image:: ../cluster/images/phi1.png
|
.. image:: ../images/phi1.png
|
||||||
|
|
||||||
Phi is calculated from the mean and standard deviation of historical
|
Phi is calculated from the mean and standard deviation of historical
|
||||||
inter arrival times. The previous chart is an example for standard deviation
|
inter arrival times. The previous chart is an example for standard deviation
|
||||||
|
|
@ -205,7 +205,7 @@ of 200 ms. If the heartbeats arrive with less deviation the curve becomes steepe
|
||||||
i.e. it is possible to determine failure more quickly. The curve looks like this for
|
i.e. it is possible to determine failure more quickly. The curve looks like this for
|
||||||
a standard deviation of 100 ms.
|
a standard deviation of 100 ms.
|
||||||
|
|
||||||
.. image:: ../cluster/images/phi2.png
|
.. image:: ../images/phi2.png
|
||||||
|
|
||||||
To be able to survive sudden abnormalities, such as garbage collection pauses and
|
To be able to survive sudden abnormalities, such as garbage collection pauses and
|
||||||
transient network failures the failure detector is configured with a margin,
|
transient network failures the failure detector is configured with a margin,
|
||||||
|
|
@ -214,7 +214,7 @@ adjust the :ref:`remote-configuration-scala` of this depending on you environmen
|
||||||
This is how the curve looks like for ``acceptable-heartbeat-pause`` configured to
|
This is how the curve looks like for ``acceptable-heartbeat-pause`` configured to
|
||||||
3 seconds.
|
3 seconds.
|
||||||
|
|
||||||
.. image:: ../cluster/images/phi3.png
|
.. image:: ../images/phi3.png
|
||||||
|
|
||||||
Serialization
|
Serialization
|
||||||
^^^^^^^^^^^^^
|
^^^^^^^^^^^^^
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
|
|
||||||
.. _routing-scala:
|
.. _routing-scala:
|
||||||
|
|
||||||
Routing (Scala)
|
Routing
|
||||||
===============
|
===============
|
||||||
|
|
||||||
A Router is an actor that receives messages and efficiently routes them to other actors, known as
|
A Router is an actor that receives messages and efficiently routes them to other actors, known as
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _scheduler-scala:
|
.. _scheduler-scala:
|
||||||
|
|
||||||
###################
|
###################
|
||||||
Scheduler (Scala)
|
Scheduler
|
||||||
###################
|
###################
|
||||||
|
|
||||||
Sometimes the need for making things happen in the future arises, and where do
|
Sometimes the need for making things happen in the future arises, and where do
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _serialization-scala:
|
.. _serialization-scala:
|
||||||
|
|
||||||
######################
|
######################
|
||||||
Serialization (Scala)
|
Serialization
|
||||||
######################
|
######################
|
||||||
|
|
||||||
Akka has a built-in Extension for serialization,
|
Akka has a built-in Extension for serialization,
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _stm-scala:
|
.. _stm-scala:
|
||||||
|
|
||||||
#######################################
|
#######################################
|
||||||
Software Transactional Memory (Scala)
|
Software Transactional Memory
|
||||||
#######################################
|
#######################################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _akka-testkit:
|
.. _akka-testkit:
|
||||||
|
|
||||||
##############################
|
##############################
|
||||||
Testing Actor Systems (Scala)
|
Testing Actor Systems
|
||||||
##############################
|
##############################
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _testkit-example:
|
.. _testkit-example:
|
||||||
|
|
||||||
########################
|
########################
|
||||||
TestKit Example (Scala)
|
TestKit Example
|
||||||
########################
|
########################
|
||||||
|
|
||||||
Ray Roestenburg's example code from `his blog <http://roestenburg.agilesquad.com/2011/02/unit-testing-akka-actors-with-testkit_12.html>`_ adapted to work with Akka 2.x.
|
Ray Roestenburg's example code from `his blog <http://roestenburg.agilesquad.com/2011/02/unit-testing-akka-actors-with-testkit_12.html>`_ adapted to work with Akka 2.x.
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
.. _transactors-scala:
|
.. _transactors-scala:
|
||||||
|
|
||||||
#####################
|
#####################
|
||||||
Transactors (Scala)
|
Transactors
|
||||||
#####################
|
#####################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
Typed Actors (Scala)
|
Typed Actors
|
||||||
====================
|
====================
|
||||||
|
|
||||||
Akka Typed Actors is an implementation of the `Active Objects <http://en.wikipedia.org/wiki/Active_object>`_ pattern.
|
Akka Typed Actors is an implementation of the `Active Objects <http://en.wikipedia.org/wiki/Active_object>`_ pattern.
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
.. _zeromq-scala:
|
.. _zeromq-scala:
|
||||||
|
|
||||||
################
|
################
|
||||||
ZeroMQ (Scala)
|
ZeroMQ
|
||||||
################
|
################
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue