Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation to Watch & Unwatch #704

Merged
merged 1 commit into from
Mar 2, 2015
Merged

Add documentation to Watch & Unwatch #704

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions src/core/Akka/Actor/IActorContext.cs
View file
Open in desktop
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