DOC: Formatting issues, see #2723

(cherry picked from commit 15abee84875cdb534056986b9172a38b57d24d92)
This commit is contained in:
Patrik Nordwall 2012-11-20 17:18:37 +01:00
parent 6a348e3c76
commit b06b0fa087
13 changed files with 56 additions and 30 deletions

View file

@ -15,6 +15,7 @@ import akka.util.internal._
import concurrent.ExecutionContext import concurrent.ExecutionContext
import scala.concurrent.duration.FiniteDuration import scala.concurrent.duration.FiniteDuration
// The Scheduler trait is included in the documentation. KEEP THE LINES SHORT!!!
//#scheduler //#scheduler
/** /**
* An Akka scheduler service. This one needs one special behavior: if * An Akka scheduler service. This one needs one special behavior: if
@ -50,7 +51,8 @@ trait Scheduler {
*/ */
def schedule( def schedule(
initialDelay: FiniteDuration, initialDelay: FiniteDuration,
interval: FiniteDuration)(f: Unit)(implicit executor: ExecutionContext): Cancellable interval: FiniteDuration)(f: Unit)(
implicit executor: ExecutionContext): Cancellable
/** /**
* Schedules a function to be run repeatedly with an initial delay and * Schedules a function to be run repeatedly with an initial delay and
@ -93,7 +95,8 @@ trait Scheduler {
* Scala API * Scala API
*/ */
def scheduleOnce( def scheduleOnce(
delay: FiniteDuration)(f: Unit)(implicit executor: ExecutionContext): Cancellable delay: FiniteDuration)(f: Unit)(
implicit executor: ExecutionContext): Cancellable
} }
//#scheduler //#scheduler

View file

@ -46,7 +46,8 @@ class TimerBasedThrottlerSpec extends TestKit(ActorSystem("TimerBasedThrottlerSp
} }
})) }))
// The throttler for this example, setting the rate // The throttler for this example, setting the rate
val throttler = system.actorOf(Props(new TimerBasedThrottler(3 msgsPer (1.second.dilated)))) val throttler = system.actorOf(Props(new TimerBasedThrottler(
3 msgsPer (1.second.dilated))))
// Set the target // Set the target
throttler ! SetTarget(Some(printer)) throttler ! SetTarget(Some(printer))
// These three messages will be sent to the echoer immediately // These three messages will be sent to the echoer immediately

View file

@ -482,7 +482,8 @@ Run it without parameters to see instructions about how to use the script::
is-available - Checks if the member node is available is-available - Checks if the member node is available
is-running - Checks if the member node is running is-running - Checks if the member node is running
has-convergence - Checks if there is a cluster convergence has-convergence - Checks if there is a cluster convergence
Where the <node-url> should be on the format of 'akka://actor-system-name@hostname:port' Where the <node-url> should be on the format of
'akka://actor-system-name@hostname:port'
Examples: bin/akka-cluster localhost:9999 is-available Examples: bin/akka-cluster localhost:9999 is-available
bin/akka-cluster localhost:9999 join akka://MySystem@darkstar:2552 bin/akka-cluster localhost:9999 join akka://MySystem@darkstar:2552

View file

@ -496,7 +496,8 @@ Run it without parameters to see instructions about how to use the script::
is-available - Checks if the member node is available is-available - Checks if the member node is available
is-running - Checks if the member node is running is-running - Checks if the member node is running
has-convergence - Checks if there is a cluster convergence has-convergence - Checks if there is a cluster convergence
Where the <node-url> should be on the format of 'akka://actor-system-name@hostname:port' Where the <node-url> should be on the format of
'akka://actor-system-name@hostname:port'
Examples: bin/akka-cluster localhost:9999 is-available Examples: bin/akka-cluster localhost:9999 is-available
bin/akka-cluster localhost:9999 join akka://MySystem@darkstar:2552 bin/akka-cluster localhost:9999 join akka://MySystem@darkstar:2552

View file

@ -388,6 +388,8 @@ URI options
The following URI options are supported: The following URI options are supported:
.. tabularcolumns:: |l|l|l|L|
+--------------+----------+---------+------------------------------------------------+ +--------------+----------+---------+------------------------------------------------+
| Name | Type | Default | Description | | Name | Type | Default | Description |
+==============+==========+=========+================================================+ +==============+==========+=========+================================================+

View file

@ -96,7 +96,8 @@ added in concrete subclass like this:
To use ``DurableMailboxDocSpec`` add this dependency:: To use ``DurableMailboxDocSpec`` add this dependency::
"com.typesafe.akka" %% "akka-mailboxes-common" % "@version@" classifier "test" @crossString@ "com.typesafe.akka" %% "akka-mailboxes-common" %
"@version@" classifier "test" @crossString@
For more inspiration you can look at the old implementations based on Redis, MongoDB, Beanstalk, For more inspiration you can look at the old implementations based on Redis, MongoDB, Beanstalk,
and ZooKeeper, which can be found in Akka git repository tag and ZooKeeper, which can be found in Akka git repository tag

View file

@ -73,7 +73,8 @@ Make sure that you add the repository to the sbt resolvers::
Define the library dependencies with the timestamp as version. For example:: Define the library dependencies with the timestamp as version. For example::
libraryDependencies += "com.typesafe.akka" % "akka-remote_@binVersion@" % "2.1-20121016-001042" libraryDependencies += "com.typesafe.akka" % "akka-remote_@binVersion@" %
"2.1-20121016-001042"
maven definition of snapshot repository maven definition of snapshot repository
--------------------------------------- ---------------------------------------

View file

@ -66,8 +66,9 @@ Java:
:: ::
// Use this Actors' Dispatcher as ExecutionContext // Use this Actors' Dispatcher as ExecutionContext
getContext().system().scheduler().scheduleOnce(Duration.create(10, TimeUnit.SECONDS)", getContext().system().scheduler().scheduleOnce(Duration.create(
getSelf(), new Reconnect(), getContext().getDispatcher()); 10, TimeUnit.SECONDS), getSelf(), new Reconnect(),
getContext().getDispatcher());
// Use ActorSystem's default Dispatcher as ExecutionContext // Use ActorSystem's default Dispatcher as ExecutionContext
system.scheduler().scheduleOnce(Duration.create(50, TimeUnit.MILLISECONDS), system.scheduler().scheduleOnce(Duration.create(50, TimeUnit.MILLISECONDS),
@ -394,13 +395,17 @@ This has been done to enable OSGi bundles that don't have conflicting package na
Change the following import statements. Please note that the serializers are often referenced from configuration. Change the following import statements. Please note that the serializers are often referenced from configuration.
================================================ ======================================================= Search -> Replace with::
Search Replace with
================================================ ======================================================= akka.routing.RemoteRouterConfig ->
``akka.routing.RemoteRouterConfig`` ``akka.remote.routing.RemoteRouterConfig`` akka.remote.routing.RemoteRouterConfig
``akka.serialization.ProtobufSerializer`` ``akka.remote.serialization.ProtobufSerializer``
``akka.serialization.DaemonMsgCreateSerializer`` ``akka.remote.serialization.DaemonMsgCreateSerializer`` akka.serialization.ProtobufSerializer ->
================================================ ======================================================= akka.remote.serialization.ProtobufSerializer
akka.serialization.DaemonMsgCreateSerializer ->
akka.remote.serialization.DaemonMsgCreateSerializer
Package Name Changes in Durable Mailboxes Package Name Changes in Durable Mailboxes
========================================= =========================================
@ -410,14 +415,20 @@ This has been done to enable OSGi bundles that don't have conflicting package na
Change the following import statements. Please note that the ``FileBasedMailboxType`` is often referenced from configuration. Change the following import statements. Please note that the ``FileBasedMailboxType`` is often referenced from configuration.
================================================ ========================================================= Search -> Replace with::
Search Replace with
================================================ ========================================================= akka.actor.mailbox.FileBasedMailboxType ->
``akka.actor.mailbox.FileBasedMailboxType`` ``akka.actor.mailbox.filebased.FileBasedMailboxType`` akka.actor.mailbox.filebased.FileBasedMailboxType
``akka.actor.mailbox.FileBasedMailboxSettings`` ``akka.actor.mailbox.filebased.FileBasedMailboxSettings``
``akka.actor.mailbox.FileBasedMessageQueue`` ``akka.actor.mailbox.filebased.FileBasedMessageQueue`` akka.actor.mailbox.FileBasedMailboxSettings ->
``akka.actor.mailbox.filequeue.*`` ``akka.actor.mailbox.filebased.filequeue.*`` akka.actor.mailbox.filebased.FileBasedMailboxSettings
================================================ =========================================================
akka.actor.mailbox.FileBasedMessageQueue ->
akka.actor.mailbox.filebased.FileBasedMessageQueue
akka.actor.mailbox.filequeue.* ->
akka.actor.mailbox.filebased.filequeue.*
Actor Receive Timeout Actor Receive Timeout
===================== =====================

View file

@ -384,6 +384,8 @@ URI options
The following URI options are supported: The following URI options are supported:
.. tabularcolumns:: |l|l|l|L|
+--------------+----------+---------+-------------------------------------------+ +--------------+----------+---------+-------------------------------------------+
| Name | Type | Default | Description | | Name | Type | Default | Description |
+==============+==========+=========+===========================================+ +==============+==========+=========+===========================================+

View file

@ -29,7 +29,8 @@ object ZeromqDocSpec {
class HealthProbe extends Actor { class HealthProbe extends Actor {
val pubSocket = ZeroMQExtension(context.system).newSocket(SocketType.Pub, Bind("tcp://127.0.0.1:1235")) val pubSocket = ZeroMQExtension(context.system).newSocket(SocketType.Pub,
Bind("tcp://127.0.0.1:1235"))
val memory = ManagementFactory.getMemoryMXBean val memory = ManagementFactory.getMemoryMXBean
val os = ManagementFactory.getOperatingSystemMXBean val os = ManagementFactory.getOperatingSystemMXBean
val ser = SerializationExtension(context.system) val ser = SerializationExtension(context.system)

View file

@ -220,7 +220,8 @@ akka {
# Example: ["TLS_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_256_CBC_SHA"] # Example: ["TLS_RSA_WITH_AES_128_CBC_SHA", "TLS_RSA_WITH_AES_256_CBC_SHA"]
# You need to install the JCE Unlimited Strength Jurisdiction Policy # You need to install the JCE Unlimited Strength Jurisdiction Policy
# Files to use AES 256. # Files to use AES 256.
# More info here: http://docs.oracle.com/javase/7/docs/technotes/guides/security/SunProviders.html#SunJCEProvider # More info here:
# http://docs.oracle.com/javase/7/docs/technotes/guides/security/SunProviders.html#SunJCEProvider
enabled-algorithms = ["TLS_RSA_WITH_AES_128_CBC_SHA"] enabled-algorithms = ["TLS_RSA_WITH_AES_128_CBC_SHA"]
# Using /dev/./urandom is only necessary when using SHA1PRNG on Linux to # Using /dev/./urandom is only necessary when using SHA1PRNG on Linux to

View file

@ -15,7 +15,8 @@ akka {
# all required messages are received # all required messages are received
filter-leeway = 3s filter-leeway = 3s
# duration to wait in expectMsg and friends outside of within() block by default # duration to wait in expectMsg and friends outside of within() block
# by default
single-expect-default = 3s single-expect-default = 3s
# The timeout that is added as an implicit by DefaultTimeout trait # The timeout that is added as an implicit by DefaultTimeout trait