Docs: fixed broken links

This commit is contained in:
Patrik Nordwall 2011-05-10 09:53:58 +02:00
parent b455dffc04
commit 1051c077e8
18 changed files with 41 additions and 22 deletions

Binary file not shown.

View file

@ -13,4 +13,4 @@ Akka Modules consist of add-on modules outside the core of Akka:
- ``akka-spring-1.1.jar`` -- Spring framework integration
- ``akka-osgi-dependencies-bundle-1.1.jar`` -- OSGi support
Documentation for Akka Modules is located `here <http://akka.io/docs/akka-modules/snapshot/>`_.
Documentation for Akka Modules is located `here <http://akka.io/docs/akka-modules/1.1/>`_.

View file

@ -9,7 +9,7 @@ Code Style
The Akka code style follows `this document <http://davetron5000.github.com/scala-style/ScalaStyleGuide.pdf>`_ .
Here is a code style settings file for ``IntelliJ IDEA``:
`Download <http://scalablesolutions.se/akka/docs/akka-0.10/files/akka-intellij-code-style.jar>`_
`Download <../_static/akka-intellij-code-style.jar>`_
Please follow the code style. Look at the code around you and mimic.
@ -26,7 +26,7 @@ There is a testing standard that should be followed: `Ticket001Spec <https://git
Actor TestKit
^^^^^^^^^^^^^
There is a useful test kit for testing actors: `akka.util.TestKit <https://github.com/jboner/akka/tree/master/akka-testkit/src/main/scala/akka/testkit/TestKit.scala>`_. It enables assertions concerning replies received and their timing, there is more documentation in the `<TestKit>`_ module.
There is a useful test kit for testing actors: `akka.util.TestKit <https://github.com/jboner/akka/tree/master/akka-testkit/src/main/scala/akka/testkit/TestKit.scala>`_. It enables assertions concerning replies received and their timing, there is more documentation in the :ref:`akka-testkit` module.
NetworkFailureTest
^^^^^^^^^^^^^^^^^^

View file

@ -80,7 +80,7 @@ Akka is very modular and has many JARs for containing different features. The co
- ``akka-slf4j-1.1.jar`` -- SLF4J Event Handler Listener
- ``akka-testkit-1.1.jar`` -- Toolkit for testing Actors
We also have Akka Modules containing add-on modules outside the core of Akka. You can download the Akka Modules distribution from TODO. It contains Akka core as well. We will not be needing any modules there today, but for your information the module JARs are these:
We also have Akka Modules containing add-on modules outside the core of Akka. You can download the Akka Modules distribution from `<http://akka.io/downloads/>`_. It contains Akka core as well. We will not be needing any modules there today, but for your information the module JARs are these:
- ``akka-kernel-1.1.jar`` -- Akka microkernel for running a bare-bones mini application server (embeds Jetty etc.)
- ``akka-amqp-1.1.jar`` -- AMQP integration

View file

@ -24,6 +24,8 @@ Links
* :ref:`scaladoc`
* `Akka Modules Documentation <http://akka.io/docs/akka-modules/1.1/>`_.
* :ref:`issue_tracking`
* :ref:`support`

View file

@ -102,7 +102,10 @@ Akka is very modular and has many JARs for containing different features. The co
- ``akka-slf4j-1.1.jar`` -- SLF4J Event Handler Listener for logging with SLF4J
- ``akka-testkit-1.1.jar`` -- Toolkit for testing Actors
We also have Akka Modules containing add-on modules outside the core of Akka. You can download the Akka Modules distribution from TODO. It contains Akka core as well. We will not be needing any modules there today, but for your information the module JARs are these:
We also have Akka Modules containing add-on modules outside the core of
Akka. You can download the Akka Modules distribution from `<http://akka.io/downloads/>`_. It contains Akka
core as well. We will not be needing any modules there today, but for your
information the module JARs are these:
- ``akka-kernel-1.1.jar`` -- Akka microkernel for running a bare-bones mini application server (embeds Jetty etc.)
- ``akka-amqp-1.1.jar`` -- AMQP integration

View file

@ -87,7 +87,10 @@ Akka is very modular and has many JARs for containing different features. The co
- ``akka-slf4j-1.1.jar`` -- SLF4J Event Handler Listener
- ``akka-testkit-1.1.jar`` -- Toolkit for testing Actors
We also have Akka Modules containing add-on modules outside the core of Akka. You can download the Akka Modules distribution from TODO. It contains Akka core as well. We will not be needing any modules there today, but for your information the module JARs are these:
We also have Akka Modules containing add-on modules outside the core of
Akka. You can download the Akka Modules distribution from `<http://akka.io/downloads/>`_. It contains Akka
core as well. We will not be needing any modules there today, but for your
information the module JARs are these:
- ``akka-kernel-1.1.jar`` -- Akka microkernel for running a bare-bones mini application server (embeds Jetty etc.)
- ``akka-amqp-1.1.jar`` -- AMQP integration

View file

@ -102,7 +102,10 @@ Akka is very modular and has many JARs for containing different features. The co
- ``akka-slf4j-1.1.jar`` -- SLF4J Event Handler Listener
- ``akka-testkit-1.1.jar`` -- Toolkit for testing Actors
We also have Akka Modules containing add-on modules outside the core of Akka. You can download the Akka Modules distribution from TODO. It contains Akka core as well. We will not be needing any modules there today, but for your information the module JARs are these:
We also have Akka Modules containing add-on modules outside the core of
Akka. You can download the Akka Modules distribution from `<http://akka.io/downloads/>`_. It contains Akka
core as well. We will not be needing any modules there today, but for your
information the module JARs are these:
- ``akka-kernel-1.1.jar`` -- Akka microkernel for running a bare-bones mini application server (embeds Jetty etc.)
- ``akka-amqp-1.1.jar`` -- AMQP integration

View file

@ -129,7 +129,7 @@ Setting this to a higher number will increase throughput but lower fairness, and
If you don't define a the 'throughput' option in the configuration file then the default value of '5' will be used.
Browse the `ScalaDoc <scaladoc>`_ or look at the code for all the options available.
Browse the :ref:`scaladoc` or look at the code for all the options available.
Priority event-based
^^^^^^^^^^^^^^^^^^^^

View file

@ -84,7 +84,7 @@ Using a configuration object:
RegistrationService service = (RegistrationService) TypedActor.newInstance(RegistrationService.class, config);
However, often you will not use these factory methods but declaratively define the Typed Actors as part of a supervisor hierarchy. More on that in the `Fault Tolerance <fault-tolerance-java>`_ section.
However, often you will not use these factory methods but declaratively define the Typed Actors as part of a supervisor hierarchy. More on that in the :ref:`fault-tolerance-java` section.
Sending messages
----------------
@ -144,7 +144,7 @@ Here is an example:
Stopping Typed Actors
---------------------
Once Typed Actors have been created with one of the TypedActor.newInstance methods they need to be stopped with TypedActor.stop to free resources allocated by the created Typed Actor (this is not needed when the Typed Actor is `supervised <fault-tolerance#supervise-active-object>`_).
Once Typed Actors have been created with one of the TypedActor.newInstance methods they need to be stopped with TypedActor.stop to free resources allocated by the created Typed Actor (this is not needed when the Typed Actor is supervised).
.. code-block:: java
@ -156,7 +156,7 @@ Once Typed Actors have been created with one of the TypedActor.newInstance metho
// Free Typed Actor resources
TypedActor.stop(service);
When the Typed Actor defines a `shutdown callback <fault-tolerance#shutdown>`_ method it will be invoked on TypedActor.stop.
When the Typed Actor defines a shutdown callback method (:ref:`fault-tolerance-java`) it will be invoked on TypedActor.stop.
How to use the TypedActorContext for runtime information access
---------------------------------------------------------------

View file

@ -20,11 +20,11 @@ be found here:
Release Versions
================
1.1-RC1
-------
1.1
---
- Akka 1.1-RC1 - http://akka.io/api/akka/1.1-RC1/
- Akka Modules 1.1-RC1 - http://akka.io/api/akka-modules/1.1-RC1/
- Akka 1.1 - http://akka.io/api/akka/1.1/
- Akka Modules 1.1 - http://akka.io/api/akka-modules/1.1/
1.0
---

View file

@ -1,3 +1,5 @@
.. _actors-scala:
Actors (Scala)
==============
@ -184,7 +186,7 @@ Using ``!!!`` will send a message to the receiving Actor asynchronously and will
val future = actor !!! "Hello"
See `Futures <futures-scala>`_ for more information.
See :ref:`futures-scala` for more information.
Forward message
^^^^^^^^^^^^^^^

View file

@ -8,7 +8,7 @@ Dataflow Concurrency (Scala)
Description
-----------
Akka implements `Oz-style dataflow concurrency <http://www.mozart-oz.org/documentation/tutorial/node8.html#chapter.concurrency>`_ by using a special API for `Futures <futures>`_ that allows single assignment variables and multiple lightweight (event-based) processes/threads.
Akka implements `Oz-style dataflow concurrency <http://www.mozart-oz.org/documentation/tutorial/node8.html#chapter.concurrency>`_ by using a special API for :ref:`futures-scala` that allows single assignment variables and multiple lightweight (event-based) processes/threads.
Dataflow concurrency is deterministic. This means that it will always behave the same. If you run it once and it yields output 5 then it will do that **every time**, run it 10 million times, same result. If it on the other hand deadlocks the first time you run it, then it will deadlock **every single time** you run it. Also, there is **no difference** between sequential code and concurrent code. These properties makes it very easy to reason about concurrency. The limitation is that the code needs to be side-effect free, e.g. deterministic. You can't use exceptions, time, random etc., but need to treat the part of your program that uses dataflow concurrency as a pure function with input and output.

View file

@ -1,3 +1,5 @@
.. _fault-tolerance-scala:
Fault Tolerance Through Supervisor Hierarchies (Scala)
======================================================

View file

@ -1,3 +1,5 @@
.. _futures-scala:
Futures (Scala)
===============
@ -200,7 +202,7 @@ This is just a sample of what can be done, but to use more advanced techniques i
Scalaz
^^^^^^
Akka also has a `Scalaz module <scalaz>`_ for a more complete support of programming in a functional style.
Akka also has a Scalaz module (:ref:`add-on-modules`) for a more complete support of programming in a functional style.
Exceptions
----------

View file

@ -1,3 +1,5 @@
.. _akka-testkit:
#####################
Testing Actor Systems
#####################

View file

@ -36,7 +36,7 @@ Actors encapsulate state and behavior into a lightweight process/thread. In a se
Creating Actors
---------------
Akka has both a `Scala API <actors>`_ and a `Java API <active-objects>`_. In this article we will only look at the Scala API since that is the most expressive one. The article assumes some basic Scala knowledge, but even if you don't know Scala I don't think it will not be too hard to follow along anyway.
Akka has both a Scala API (:ref:`actors-scala`) and a Java API (:ref:`untyped-actors-java`). In this article we will only look at the Scala API since that is the most expressive one. The article assumes some basic Scala knowledge, but even if you don't know Scala I don't think it will not be too hard to follow along anyway.
Akka has adopted the same style of writing Actors as Erlang in which each Actor has an explicit message handler which does pattern matching to match on the incoming messages.

View file

@ -80,7 +80,7 @@ Using a configuration object:
val service = TypedActor.newInstance(classOf[RegistrationService], classOf[RegistrationServiceImpl], config)
However, often you will not use these factory methods but declaratively define the Typed Actors as part of a supervisor hierarchy. More on that in the `Fault Tolerance <fault-tolerance-scala>`_ section.
However, often you will not use these factory methods but declaratively define the Typed Actors as part of a supervisor hierarchy. More on that in the :ref:`fault-tolerance-scala` section.
Sending messages
----------------
@ -137,7 +137,7 @@ Here is an example:
Stopping Typed Actors
---------------------
Once Typed Actors have been created with one of the TypedActor.newInstance methods they need to be stopped with TypedActor.stop to free resources allocated by the created Typed Actor (this is not needed when the Typed Actor is `supervised <fault-tolerance#supervise-active-object>`_).
Once Typed Actors have been created with one of the TypedActor.newInstance methods they need to be stopped with TypedActor.stop to free resources allocated by the created Typed Actor (this is not needed when the Typed Actor is supervised).
.. code-block:: scala
@ -149,7 +149,7 @@ Once Typed Actors have been created with one of the TypedActor.newInstance metho
// Free Typed Actor resources
TypedActor.stop(service)
When the Typed Actor defines a `shutdown callback <fault-tolerance#shutdown>`_ method it will be invoked on TypedActor.stop.
When the Typed Actor defines a shutdown callback method (:ref:`fault-tolerance-scala`) it will be invoked on TypedActor.stop.
How to use the TypedActorContext for runtime information access
---------------------------------------------------------------