From ad6498f3e142e219539b131c174f9f0d0000d5cd Mon Sep 17 00:00:00 2001
From: Viktor Klang <viktor.klang@gmail.com>
Date: Thu, 3 Feb 2011 14:37:08 +0100
Subject: [PATCH] Adding Java API for ReceiveTimeout

---
 akka-actor/src/main/java/akka/actor/Actors.java    | 14 ++++++++++++++
 .../akka/actor/actor/ReceiveTimeoutSpec.scala      |  4 ++++
 2 files changed, 18 insertions(+)

diff --git a/akka-actor/src/main/java/akka/actor/Actors.java b/akka-actor/src/main/java/akka/actor/Actors.java
index d19ee01785..86b1484d05 100644
--- a/akka-actor/src/main/java/akka/actor/Actors.java
+++ b/akka-actor/src/main/java/akka/actor/Actors.java
@@ -69,4 +69,18 @@ public class Actors {
     public static ActorRef actorOf(final Class<? extends Actor> type) {
         return Actor$.MODULE$.actorOf(type);
     }
+
+
+    /**
+     * The message that is sent when an Actor gets a receive timeout.
+     * <pre>
+     *  if( message == receiveTimeout() ) {
+     *    //Timed out
+     *  }
+     * </pre>
+     * @return the single instance of ReceiveTimeout
+     */
+    public final static ReceiveTimeout$ receiveTimeout() {
+        return ReceiveTimeout$.MODULE$;
+    }
 }
\ No newline at end of file
diff --git a/akka-actor/src/test/scala/akka/actor/actor/ReceiveTimeoutSpec.scala b/akka-actor/src/test/scala/akka/actor/actor/ReceiveTimeoutSpec.scala
index e469ab43d1..7fea2a78d3 100644
--- a/akka-actor/src/test/scala/akka/actor/actor/ReceiveTimeoutSpec.scala
+++ b/akka-actor/src/test/scala/akka/actor/actor/ReceiveTimeoutSpec.scala
@@ -101,4 +101,8 @@ class ReceiveTimeoutSpec extends JUnitSuite {
     assert(timeoutLatch.tryAwait(1, TimeUnit.SECONDS) == false)
     timeoutActor.stop
   }
+
+  @Test def ActorsReceiveTimeoutShouldBeReceiveTimeout {
+    assert(akka.actor.Actors.receiveTimeout() eq ReceiveTimeout)
+  }
 }