raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Merge pull request #22594 from johanandren/wip-22541-update-docs-johanandren

Browse source 
Java style accessors for AbstractFSM
This commit is contained in:
Patrik Nordwall 2017-03-17 13:18:20 +01:00 • committed by GitHub
commit 45f4727625
24 changed files with 85 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

26
akka-actor/src/main/scala/akka/actor/AbstractFSM.scala
View file

@ -36,6 +36,32 @@ abstract class AbstractFSM[S, D] extends FSM[S, D] {
import java.util.{ List ⇒ JList }
import FSM._
/**
* Returns this AbstractActor's ActorContext
* The ActorContext is not thread safe so do not expose it outside of the
* AbstractActor.
*/
def getContext(): AbstractActor.ActorContext = context.asInstanceOf[AbstractActor.ActorContext]
/**
* Returns the ActorRef for this actor.
*
* Same as `self()`.
*/
def getSelf(): ActorRef = self
/**
* The reference sender Actor of the currently processed message. This is
* always a legal destination to send to, even if there is no logical recipient
* for the reply, in which case it will be sent to the dead letter mailbox.
*
* Same as `sender()`.
*
* WARNING: Only valid within the Actor itself, so do not close over it and
* publish it to other threads!
*/
def getSender(): ActorRef = sender()
/**
* Insert a new StateFunction at the end of the processing chain for the
* given state.

6
akka-docs/rst/java/code/jdocs/actor/ActorDocTest.java
View file

@ -398,7 +398,7 @@ public class ActorDocTest extends AbstractJavaTest {
getSender().tell("service unavailable, shutting down", getSelf())
)
.match(Terminated.class, t -> t.actor().equals(worker), t ->
getContext().stop(self())
getContext().stop(getSelf())
)
.build();
}
@ -716,7 +716,7 @@ public class ActorDocTest extends AbstractJavaTest {
getContext().become(active(ref));
})
.match(ActorIdentity.class, id -> !id.getActorRef().isPresent(), id -> {
getContext().stop(self());
getContext().stop(getSelf());
})
.build();
}
@ -724,7 +724,7 @@ public class ActorDocTest extends AbstractJavaTest {
final AbstractActor.Receive active(final ActorRef another) {
return receiveBuilder()
.match(Terminated.class, t -> t.actor().equals(another), t ->
getContext().stop(self())
getContext().stop(getSelf())
)
.build();
}

13
akka-docs/rst/java/code/jdocs/actor/japi/FaultHandlingDocSample.java → akka-docs/rst/java/code/jdocs/actor/FaultHandlingDocSample.java
View file

@ -1,7 +1,7 @@
/**
* Copyright (C) 2009-2017 Lightbend Inc. <http://www.lightbend.com>
*/
package jdocs.actor.japi;
package jdocs.actor;
//#all
//#imports
@ -14,6 +14,7 @@ import akka.actor.*;
import akka.dispatch.Mapper;
import akka.event.LoggingReceive;
import akka.japi.pf.DeciderBuilder;
import akka.pattern.Patterns;
import akka.util.Timeout;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
@ -27,10 +28,10 @@ import static akka.actor.SupervisorStrategy.escalate;
import static akka.pattern.Patterns.ask;
import static akka.pattern.Patterns.pipe;
import static jdocs.actor.japi.FaultHandlingDocSample.WorkerApi.*;
import static jdocs.actor.japi.FaultHandlingDocSample.CounterServiceApi.*;
import static jdocs.actor.japi.FaultHandlingDocSample.CounterApi.*;
import static jdocs.actor.japi.FaultHandlingDocSample.StorageApi.*;
import static jdocs.actor.FaultHandlingDocSample.WorkerApi.*;
import static jdocs.actor.FaultHandlingDocSample.CounterServiceApi.*;
import static jdocs.actor.FaultHandlingDocSample.CounterApi.*;
import static jdocs.actor.FaultHandlingDocSample.StorageApi.*;
//#imports
@ -148,7 +149,7 @@ public class FaultHandlingDocSample {
counterService.tell(new Increment(1), getSelf());
counterService.tell(new Increment(1), getSelf());
// Send current progress to the initial sender
pipe(ask(counterService, GetCurrentCount, askTimeout)
pipe(Patterns.ask(counterService, GetCurrentCount, askTimeout)
.mapTo(classTag(CurrentCount.class))
.map(new Mapper<CurrentCount, Progress>() {
public Progress apply(CurrentCount c) {

2
akka-docs/rst/java/code/jdocs/actor/fsm/Buncher.java
View file

@ -39,7 +39,7 @@ public class Buncher extends AbstractFSM<State, Data> {
// reuse this matcher
final UnitMatch<Data> m = UnitMatch.create(
matchData(Todo.class,
todo -> todo.getTarget().tell(new Batch(todo.getQueue()), self())));
todo -> todo.getTarget().tell(new Batch(todo.getQueue()), getSelf())));
m.match(stateData());
}).
state(Idle, Active, () -> {/* Do something here */}));

12
akka-docs/rst/java/code/jdocs/actor/fsm/FSMDocTest.java
View file

@ -131,10 +131,10 @@ public class FSMDocTest extends AbstractJavaTest {
log().warning("Failure in state " + state + " with data " + data + "\n" +
"Events leading up to this point:\n\t" + lastEvents);
//#logging-fsm
target.tell(reason.cause(), self());
target.tell(state, self());
target.tell(data, self());
target.tell(lastEvents, self());
target.tell(reason.cause(), getSelf());
target.tell(state, getSelf());
target.tell(data, getSelf());
target.tell(lastEvents, getSelf());
//#logging-fsm
})
);
@ -143,11 +143,11 @@ public class FSMDocTest extends AbstractJavaTest {
startWith(SomeState, Data.Foo);
when(SomeState, matchEvent(ActorRef.class, Data.class, (ref, data) -> {
target = ref;
target.tell("going active", self());
target.tell("going active", getSelf());
return goTo(Active);
}));
when(Active, matchEventEquals("stop", (event, data) -> {
target.tell("stopping", self());
target.tell("stopping", getSelf());
return stop(new Failure("This is not the error you're looking for"));
}));
initialize();

2
akka-docs/rst/java/code/jdocs/cluster/FactorialBackend.java
View file

@ -18,7 +18,7 @@ public class FactorialBackend extends AbstractActor {
CompletableFuture.supplyAsync(() -> factorial(n))
.thenApply((factorial) -> new FactorialResult(n, factorial));
pipe(result, getContext().dispatcher()).to(sender());
pipe(result, getContext().dispatcher()).to(getSender());
})
.build();

2
akka-docs/rst/java/code/jdocs/cluster/FactorialFrontend.java
View file

@ -51,7 +51,7 @@ public class FactorialFrontend extends AbstractActor {
if (repeat)
sendJobs();
else
getContext().stop(self());
getContext().stop(getSelf());
}
})
.match(ReceiveTimeout.class, x -> {

2
akka-docs/rst/java/code/jdocs/cluster/StatsSampleClient.java
View file

@ -53,7 +53,7 @@ public class StatsSampleClient extends AbstractActor {
//re-subscribe when restart
@Override
public void postStop() {
cluster.unsubscribe(self());
cluster.unsubscribe(getSelf());
tickTask.cancel();
}

4
akka-docs/rst/java/code/jdocs/cluster/TransformationBackend.java
View file

@ -18,13 +18,13 @@ public class TransformationBackend extends AbstractActor {
//subscribe to cluster changes, MemberUp
@Override
public void preStart() {
cluster.subscribe(self(), MemberUp.class);
cluster.subscribe(getSelf(), MemberUp.class);
}
//re-subscribe when restart
@Override
public void postStop() {
cluster.unsubscribe(self());
cluster.unsubscribe(getSelf());
}
@Override

4
akka-docs/rst/java/code/jdocs/cluster/TransformationFrontend.java
View file

@ -31,8 +31,8 @@ public class TransformationFrontend extends AbstractActor {
.forward(job, getContext());
})
.matchEquals(BACKEND_REGISTRATION, x -> {
getContext().watch(sender());
backends.add(sender());
getContext().watch(getSender());
backends.add(getSender());
})
.match(Terminated.class, terminated -> {
backends.remove(terminated.getActor());

4
akka-docs/rst/java/code/jdocs/ddata/DistributedDataDocTest.java
View file

@ -118,7 +118,7 @@ public class DistributedDataDocTest extends AbstractJavaTest {
return receiveBuilder()
.match(String.class, a -> a.equals("increment"), a -> {
// incoming command to increase the counter
Optional<Object> reqContext = Optional.of(sender());
Optional<Object> reqContext = Optional.of(getSender());
Replicator.Update<PNCounter> upd = new Replicator.Update<PNCounter>(counter1Key,
PNCounter.create(), writeTwo, reqContext, curr -> curr.increment(node, 1));
replicator.tell(upd, getSelf());
@ -217,7 +217,7 @@ public class DistributedDataDocTest extends AbstractJavaTest {
return receiveBuilder()
.match(String.class, a -> a.equals("get-count"), a -> {
// incoming request to retrieve current value of the counter
Optional<Object> reqContext = Optional.of(sender());
Optional<Object> reqContext = Optional.of(getSender());
replicator.tell(new Replicator.Get<PNCounter>(counter1Key,
readTwo), getSelf());
})

2
akka-docs/rst/java/code/jdocs/io/JavaReadBackPressure.java
View file

@ -46,7 +46,7 @@ public class JavaReadBackPressure {
tcp = Tcp.get(getContext().getSystem()).manager();
final List<Inet.SocketOption> options = new ArrayList<Inet.SocketOption>();
tcp.tell(
TcpMessage.bind(self(), new InetSocketAddress("localhost", 0), 100, options, true),
TcpMessage.bind(getSelf(), new InetSocketAddress("localhost", 0), 100, options, true),
getSelf()
);
//#pull-mode-bind

2
akka-docs/rst/java/code/jdocs/io/JavaUdpMulticast.java
View file

@ -73,7 +73,7 @@ public class JavaUdpMulticast {
final ActorRef mgr = Udp.get(getContext().getSystem()).getManager();
// listen for datagrams on this address
InetSocketAddress endpoint = new InetSocketAddress(port);
mgr.tell(UdpMessage.bind(self(), endpoint, options), getSelf());
mgr.tell(UdpMessage.bind(getSelf(), endpoint, options), getSelf());
//#bind
}

10
akka-docs/rst/java/code/jdocs/io/UdpDocTest.java
View file

@ -35,7 +35,7 @@ public class UdpDocTest {
public Receive createReceive() {
return receiveBuilder()
.match(Udp.SimpleSenderReady.class, message -> {
getContext().become(ready(sender()));
getContext().become(ready(getSender()));
//#sender
getSender().tell(UdpMessage.send(ByteString.fromString("hello"), remote), getSelf());
//#sender
@ -68,7 +68,7 @@ public class UdpDocTest {
// request creation of a bound listen socket
final ActorRef mgr = Udp.get(getContext().getSystem()).getManager();
mgr.tell(
UdpMessage.bind(self(), new InetSocketAddress("localhost", 0)),
UdpMessage.bind(getSelf(), new InetSocketAddress("localhost", 0)),
getSelf());
}
@ -116,14 +116,14 @@ public class UdpDocTest {
// create a restricted a.k.a. “connected” socket
final ActorRef mgr = UdpConnected.get(getContext().getSystem()).getManager();
mgr.tell(UdpConnectedMessage.connect(self(), remote), getSelf());
mgr.tell(UdpConnectedMessage.connect(getSelf(), remote), getSelf());
}
@Override
public Receive createReceive() {
return receiveBuilder()
.match(UdpConnected.Connected.class, message -> {
getContext().become(ready(sender()));
getContext().become(ready(getSender()));
//#connected
getSender()
.tell(UdpConnectedMessage.send(ByteString.fromString("hello")),
@ -154,7 +154,7 @@ public class UdpDocTest {
connection.tell(message, getSelf());
})
.match(UdpConnected.Disconnected.class, x -> {
getContext().stop(self());
getContext().stop(getSelf());
})
.build();
}

10
akka-docs/rst/java/code/jdocs/io/japi/EchoHandler.java
View file

@ -87,7 +87,7 @@ public class EchoHandler extends AbstractActor {
.match(ConnectionClosed.class, msg -> {
if (msg.isPeerClosed()) {
if (storage.isEmpty()) {
getContext().stop(self());
getContext().stop(getSelf());
} else {
getContext().become(closing());
}
@ -119,7 +119,7 @@ public class EchoHandler extends AbstractActor {
if (msg.isPeerClosed())
state.peerClosed = true;
else
getContext().stop(self());
getContext().stop(getSelf());
})
.match(Integer.class, ack -> {
@ -130,7 +130,7 @@ public class EchoHandler extends AbstractActor {
if (storage.isEmpty()) {
if (state.peerClosed)
getContext().stop(self());
getContext().stop(getSelf());
else
getContext().become(writing);
@ -165,7 +165,7 @@ public class EchoHandler extends AbstractActor {
.match(Integer.class, msg -> {
acknowledge(msg);
if (storage.isEmpty())
getContext().stop(self());
getContext().stop(getSelf());
})
.build();
}
@ -197,7 +197,7 @@ public class EchoHandler extends AbstractActor {
if (stored > MAX_STORED) {
log.warning("drop connection to [{}] (buffer overrun)", remote);
getContext().stop(self());
getContext().stop(getSelf());
} else if (stored > HIGH_WATERMARK) {
log.debug("suspending reading at {}", currentOffset());

6
akka-docs/rst/java/code/jdocs/io/japi/EchoManager.java
View file

@ -40,14 +40,14 @@ public class EchoManager extends AbstractActor {
final ActorRef tcpManager = Tcp.get(getContext().getSystem()).manager();
//#manager
tcpManager.tell(
TcpMessage.bind(self(), new InetSocketAddress("localhost", 0), 100),
TcpMessage.bind(getSelf(), new InetSocketAddress("localhost", 0), 100),
getSelf());
}
@Override
public void postRestart(Throwable arg0) throws Exception {
// do not restart
getContext().stop(self());
getContext().stop(getSelf());
}
@Override
@ -59,7 +59,7 @@ public class EchoManager extends AbstractActor {
.match(Tcp.CommandFailed.class, failed -> {
if (failed.cmd() instanceof Bind) {
log.warning("cannot bind to [{}]", ((Bind) failed.cmd()).localAddress());
getContext().stop(self());
getContext().stop(getSelf());
} else {
log.warning("unknown command failed [{}]", failed.cmd());
}

14
akka-docs/rst/java/code/jdocs/io/japi/IODocTest.java
View file

@ -48,7 +48,7 @@ public class IODocTest extends AbstractJavaTest {
@Override
public void preStart() throws Exception {
final ActorRef tcp = Tcp.get(getContext().getSystem()).manager();
tcp.tell(TcpMessage.bind(self(),
tcp.tell(TcpMessage.bind(getSelf(),
new InetSocketAddress("localhost", 0), 100), getSelf());
}
@ -60,7 +60,7 @@ public class IODocTest extends AbstractJavaTest {
})
.match(CommandFailed.class, msg -> {
getContext().stop(self());
getContext().stop(getSelf());
})
.match(Connected.class, conn -> {
@ -87,7 +87,7 @@ public class IODocTest extends AbstractJavaTest {
getSender().tell(TcpMessage.write(data), getSelf());
})
.match(ConnectionClosed.class, msg -> {
getContext().stop(self());
getContext().stop(getSelf());
})
.build();
}
@ -118,13 +118,13 @@ public class IODocTest extends AbstractJavaTest {
return receiveBuilder()
.match(CommandFailed.class, msg -> {
listener.tell("failed", getSelf());
getContext().stop(self());
getContext().stop(getSelf());
})
.match(Connected.class, msg -> {
listener.tell(msg, getSelf());
getSender().tell(TcpMessage.register(self()), getSelf());
getContext().become(connected(sender()));
getSender().tell(TcpMessage.register(getSelf()), getSelf());
getContext().become(connected(getSender()));
})
.build();
}
@ -144,7 +144,7 @@ public class IODocTest extends AbstractJavaTest {
connection.tell(TcpMessage.close(), getSelf());
})
.match(ConnectionClosed.class, msg -> {
getContext().stop(self());
getContext().stop(getSelf());
})
.build();
}

8
akka-docs/rst/java/code/jdocs/io/japi/SimpleEchoHandler.java
View file

@ -51,7 +51,7 @@ public class SimpleEchoHandler extends AbstractActor {
})
.match(ConnectionClosed.class, msg -> {
getContext().stop(self());
getContext().stop(getSelf());
})
.build();
}
@ -71,7 +71,7 @@ public class SimpleEchoHandler extends AbstractActor {
closing = true;
} else {
// could also be ErrorClosed, in which case we just give up
getContext().stop(self());
getContext().stop(getSelf());
}
})
.build();
@ -98,7 +98,7 @@ public class SimpleEchoHandler extends AbstractActor {
if (stored > maxStored) {
log.warning("drop connection to [{}] (buffer overrun)", remote);
getContext().stop(self());
getContext().stop(getSelf());
} else if (stored > highWatermark) {
log.debug("suspending reading");
@ -120,7 +120,7 @@ public class SimpleEchoHandler extends AbstractActor {
if (storage.isEmpty()) {
if (closing) {
getContext().stop(self());
getContext().stop(getSelf());
} else {
getContext().unbecome();
}

2
akka-docs/rst/java/code/jdocs/io/japi/Watcher.java
View file

@ -29,7 +29,7 @@ public class Watcher extends AbstractActor {
})
.match(Terminated.class, msg -> {
latch.countDown();
if (latch.getCount() == 0) getContext().stop(self());
if (latch.getCount() == 0) getContext().stop(getSelf());
})
.build();
}

2
akka-docs/rst/java/code/jdocs/stream/ActorPublisherDocTest.java
View file

@ -91,7 +91,7 @@ public class ActorPublisherDocTest extends AbstractJavaTest {
}
})
.match(ActorPublisherMessage.Request.class, request -> deliverBuf())
.match(ActorPublisherMessage.Cancel.class, cancel -> getContext().stop(self()))
.match(ActorPublisherMessage.Cancel.class, cancel -> getContext().stop(getSelf()))
.build();
}

4
akka-docs/rst/java/code/jdocs/stream/ActorSubscriberDocTest.java
View file

@ -179,7 +179,7 @@ public class ActorSubscriberDocTest extends AbstractJavaTest {
})
.match(ActorSubscriberMessage.onCompleteInstance().getClass(), complete -> {
if (queue.isEmpty()) {
getContext().stop(self());
getContext().stop(getSelf());
}
})
.match(WorkerPoolProtocol.Reply.class, reply -> {
@ -187,7 +187,7 @@ public class ActorSubscriberDocTest extends AbstractJavaTest {
queue.get(id).tell(WorkerPoolProtocol.done(id), getSelf());
queue.remove(id);
if (canceled() && queue.isEmpty()) {
getContext().stop(self());
getContext().stop(getSelf());
}
})
.build();

2
akka-docs/rst/java/code/jdocs/stream/javadsl/cookbook/RecipeGlobalRateLimit.java
View file

@ -113,7 +113,7 @@ public class RecipeGlobalRateLimit extends RecipeTest {
releaseWaiting();
})
.match(WantToPass.class, wtp -> {
waitQueue.add(sender());
waitQueue.add(getSender());
})
.build();
}

2
akka-docs/rst/java/code/jdocs/testkit/ParentChildTest.java
View file

@ -177,7 +177,7 @@ public class ParentChildTest extends AbstractJavaTest {
public Receive createReceive() {
return receiveBuilder()
.matchAny(message -> {
if (sender().equals(child)) {
if (getSender().equals(child)) {
proxy.ref().forward(message, getContext());
} else {
child.forward(message, getContext());

2
akka-docs/rst/java/fault-tolerance-sample.rst
View file

@ -49,5 +49,5 @@ Step Description
Full Source Code of the Fault Tolerance Sample
------------------------------------------------------
.. includecode:: code/jdocs/actor/japi/FaultHandlingDocSample.java#all
.. includecode:: code/jdocs/actor/FaultHandlingDocSample.java#all