Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ abstract class ActorSystem[-T] extends ActorRef[T] with Extensions with ClassicA
* [[pekko.actor.CoordinatedShutdown.ActorSystemTerminateReason]]. This method will block
* until either the actor system is terminated or
* `pekko.coordinated-shutdown.close-actor-system-timeout` timeout duration is
* passed, in which case a [[TimeoutException]] is thrown.
* passed, in which case a [[java.util.concurrent.TimeoutException]] is thrown.
*
* If `pekko.coordinated-shutdown.run-by-actor-system-terminate` is configured to `off`
* it will not run `CoordinatedShutdown`, but the `ActorSystem` and its actors
Expand All @@ -161,7 +161,7 @@ abstract class ActorSystem[-T] extends ActorRef[T] with Extensions with ClassicA
* This will stop the guardian actor, which in turn
* will recursively stop all its child actors, and finally the system guardian
* (below which the logging actors reside) and then execute all registered
* termination handlers (see [[pekko.actor.ActorSystem.registerOnTermination]]).
* termination handlers (see `registerOnTermination`).
* @since 1.3.0
*/
@throws(classOf[TimeoutException])
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import pekko.annotation.DoNotInherit
* The typical usage of this is to use it as the guardian actor of the [[ActorSystem]], possibly combined with
* `Behaviors.setup` to starts some initial tasks or actors. Child actors can then be started from the outside
* by telling or asking [[SpawnProtocol#Spawn]] to the actor reference of the system. When using `ask` this is
* similar to how [[pekko.actor.ActorSystem#actorOf]] can be used in classic actors with the difference that
* similar to how `actorOf` can be used in classic actors with the difference that
* a `Future` / `CompletionStage` of the `ActorRef` is returned.
*
* Stopping children is done through specific support in the protocol of the children, or stopping the entire
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ import org.slf4j.Logger
* - designate the behavior for the next message
*
* In Pekko, the first capability is accessed by using the `tell` method
* on an [[ActorRef]], the second is provided by [[ActorContext#spawn]]
* on an [[ActorRef]], the second is provided by `spawn`
* and the third is implicit in the signature of [[Behavior]] in that the next
* behavior is always returned from the message processing logic.
*
Expand Down Expand Up @@ -163,7 +163,7 @@ trait ActorContext[T] extends TypedActorContext[T] with ClassicActorContextProvi
* using [[Behavior.interpretMessage]] or [[Behavior.interpretSignal]]
*
* note: if given [[pekko.actor.typed.Behavior]] resulting [[Behaviors.same]] that will cause context switching to the given behavior
* and if result is [[Behaviors.unhandled]] that will trigger the [[pekko.actor.typed.scaladsl.ActorContext.onUnhandled]]
* and if result is [[Behaviors.unhandled]] that will mark the message as unhandled
* then switching to the given behavior.
*/
def delegate(delegator: Behavior[T], msg: T): Behavior[T]
Expand Down Expand Up @@ -323,7 +323,7 @@ trait ActorContext[T] extends TypedActorContext[T] with ClassicActorContextProvi
/**
* The same as [[ask]] but only for requests that result in a response of type [[pekko.pattern.StatusReply]].
* If the response is a [[pekko.pattern.StatusReply#success]] the returned future is completed successfully with the wrapped response.
* If the status response is a [[pekko.pattern.StatusReply#error]] the returned future will be failed with the
* If the status response is an error reply the returned future will be failed with the
* exception in the error (normally a [[pekko.pattern.StatusReply.ErrorMessage]]).
*/
def askWithStatus[Req, Res](
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ object Behaviors {

/**
* `setup` is a factory for a behavior. Creation of the behavior instance is deferred until
* the actor is started, as opposed to [[Behaviors#receive]] that creates the behavior instance
* the actor is started, as opposed to `receive` that creates the behavior instance
* immediately before the actor is running. The `factory` function pass the `ActorContext`
* as parameter and that can for example be used for spawning child actors.
*
Expand Down Expand Up @@ -125,7 +125,7 @@ object Behaviors {
new BehaviorImpl.ReceiveBehavior((ctx, msg) => onMessage.apply(ctx.asJava, msg))

/**
* Simplified version of [[receive]] with only a single argument - the message
* Simplified version of `receive` with only a single argument - the message
* to be handled. Useful for when the context is already accessible by other means,
* like being wrapped in an [[setup]] or similar.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ trait ActorContext[T] extends TypedActorContext[T] with ClassicActorContextProvi
* using [[Behavior.interpretMessage]] or [[Behavior.interpretSignal]]
*
* note: if given [[pekko.actor.typed.Behavior]] resulting [[Behaviors.same]] that will cause context switching to the given behavior
* and if result is [[Behaviors.unhandled]] that will trigger the [[pekko.actor.typed.scaladsl.ActorContext.onUnhandled]]
* and if result is [[Behaviors.unhandled]] that will mark the message as unhandled
* then switching to the given behavior.
*/
def delegate(delegator: Behavior[T], msg: T): Behavior[T]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ private[pekko] trait AbstractProps {
new Props(deploy = Props.defaultDeploy, clazz = clazz, args = args.toList)

/**
* Create new Props from the given [[pekko.japi.Creator]] with the type set to the given actorClass.
* Create new Props from the given [[pekko.japi.function.Creator]] with the type set to the given actorClass.
*/
def create[T <: Actor](actorClass: Class[T], creator: Creator[T]): Props = {
checkCreatorClosingOver(creator.getClass)
Expand Down
14 changes: 7 additions & 7 deletions actor/src/main/scala/org/apache/pekko/actor/ActorSystem.scala
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ abstract class ActorSystem extends ActorRefFactory with ClassicActorSystemProvid
def logConfiguration(): Unit

/**
* Construct a path below the application guardian to be used with [[ActorSystem#actorSelection]].
* Construct a path below the application guardian to be used with `actorSelection`.
*/
def /(name: String): ActorPath

Expand All @@ -557,7 +557,7 @@ abstract class ActorSystem extends ActorRefFactory with ClassicActorSystemProvid
def child(child: String): ActorPath = /(child)

/**
* Construct a path below the application guardian to be used with [[ActorSystem#actorSelection]].
* Construct a path below the application guardian to be used with `actorSelection`.
*/
def /(name: Iterable[String]): ActorPath

Expand Down Expand Up @@ -673,7 +673,7 @@ abstract class ActorSystem extends ActorRefFactory with ClassicActorSystemProvid
* This will stop the guardian actor, which in turn
* will recursively stop all its child actors, and finally the system guardian
* (below which the logging actors reside) and then execute all registered
* termination handlers (see [[ActorSystem#registerOnTermination]]).
* termination handlers (see `registerOnTermination`).
* Be careful to not schedule any operations on completion of the returned future
* using the dispatcher of this actor system as it will have been shut down before the
* future completes.
Expand All @@ -685,7 +685,7 @@ abstract class ActorSystem extends ActorRefFactory with ClassicActorSystemProvid
* [[CoordinatedShutdown.ActorSystemTerminateReason]]. This method will block
* until either the actor system is terminated or
* `pekko.coordinated-shutdown.close-actor-system-timeout` timeout duration is
* passed, in which case a [[TimeoutException]] is thrown.
* passed, in which case a [[java.util.concurrent.TimeoutException]] is thrown.
*
* If `pekko.coordinated-shutdown.run-by-actor-system-terminate` is configured to `off`
* it will not run `CoordinatedShutdown`, but the `ActorSystem` and its actors
Expand All @@ -694,7 +694,7 @@ abstract class ActorSystem extends ActorRefFactory with ClassicActorSystemProvid
* This will stop the guardian actor, which in turn
* will recursively stop all its child actors, and finally the system guardian
* (below which the logging actors reside) and then execute all registered
* termination handlers (see [[ActorSystem#registerOnTermination]]).
* termination handlers (see `registerOnTermination`).
* @since 1.3.0
*/
@throws(classOf[TimeoutException])
Expand All @@ -703,7 +703,7 @@ abstract class ActorSystem extends ActorRefFactory with ClassicActorSystemProvid
/**
* Returns a Future which will be completed after the ActorSystem has been terminated
* and termination hooks have been executed. If you registered any callback with
* [[ActorSystem#registerOnTermination]], the returned Future from this method will not complete
* `registerOnTermination`, the returned Future from this method will not complete
* until all the registered callbacks are finished. Be careful to not schedule any operations,
* such as `onComplete`, on the dispatchers (`ExecutionContext`) of this actor system as they
* will have been shut down before this future completes.
Expand All @@ -713,7 +713,7 @@ abstract class ActorSystem extends ActorRefFactory with ClassicActorSystemProvid
/**
* Returns a CompletionStage which will be completed after the ActorSystem has been terminated
* and termination hooks have been executed. If you registered any callback with
* [[ActorSystem#registerOnTermination]], the returned CompletionStage from this method will not complete
* `registerOnTermination`, the returned CompletionStage from this method will not complete
* until all the registered callbacks are finished. Be careful to not schedule any operations,
* such as `thenRunAsync`, on the dispatchers (`Executor`) of this actor system as they
* will have been shut down before this CompletionStage completes.
Expand Down
Loading