Skip to content

Commit

Permalink
Add documentation to Watch & Unwatch
Browse files Browse the repository at this point in the history
  • Loading branch information
HCanber committed Mar 2, 2015
1 parent 255140f commit 19d34e6
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/core/Akka/Actor/IActorContext.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,23 @@ namespace Akka.Actor
{
public interface ICanWatch
{
/// <summary>
/// Monitors the specified actor for termination. When the <paramref name="subject"/> terminates
/// the instance watching will receive a <see cref="Terminated"/> message.
/// <remarks>Note that if the <see cref="Terminated"/> message isn't handled by the actor,
/// by default the actor will crash by throwing a <see cref="DeathPactException"/>. To change
/// the default behavior, override <see cref="ActorBase.Unhandled"/>.
/// </remarks>
/// </summary>
/// <param name="subject">The actor to monitor for termination.</param>
/// <returns>Returns the provided subject</returns>
ActorRef Watch(ActorRef subject);

/// <summary>
/// Stops monitoring the <paramref name="subject"/> for termination.
/// </summary>
/// <param name="subject">The actor to stop monitor for termination.</param>
/// <returns>Returns the provided subject</returns>
ActorRef Unwatch(ActorRef subject);
}

Expand Down

2 comments on commit 19d34e6

@Petabridge-CI
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TeamCity Akka.NET :: Akka.NET PR Build Build 87 is now running

@Petabridge-CI
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TeamCity Akka.NET :: Akka.NET PR Build Build 87 outcome was FAILURE
Summary: System.Exception: xUnit failed for the following assemblies: D:\BuildAgent\work\49b164d63843fb4\src\core\Akka.Persistence.Tests\bin\Release\Akka.Persistence.Tests.dll at Microsoft.FSharp.Core.Operators.FailWith[T](String message) at Fake.XUnitHel... Build time: 00:10:43

Failed tests

Akka.Persistence.Tests.dll: Akka.Persistence.Tests.GuaranteedDeliveryCrashSpec.GuaranteedDelivery_should_not_send_when_actor_crashes: <no details avaliable>

Please sign in to comment.