Skip to content

Commit

Permalink
[api-docs] Added TBD placeholders for Akka.Cluster.Tools.csproj
Browse files Browse the repository at this point in the history 
This PR is part of an ongoing commit for #2407. It adds placeholders for
missing/incomplete xmldoc comments.

[11/23]
  • Loading branch information
@sean-gilliam
sean-gilliam committed Jan 24, 2017
1 parent 9c48f78 commit d6b299a
Show file tree
Hide file tree
Showing 21 changed files with 1,608 additions and 9 deletions.
114 changes: 114 additions & 0 deletions src/contrib/cluster/Akka.Cluster.Tools/Client/ClusterClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,25 @@ public sealed class ClusterClient : ActorBase
[Serializable]
public sealed class Send
{
/// <summary>
/// TBD
/// </summary>
public string Path { get; }
/// <summary>
/// TBD
/// </summary>
public object Message { get; }
/// <summary>
/// TBD
/// </summary>
public bool LocalAffinity { get; }

/// <summary>
/// TBD
/// </summary>
/// <param name="path">TBD</param>
/// <param name="message">TBD</param>
/// <param name="localAffinity">TBD</param>
public Send(string path, object message, bool localAffinity = false)
{
Path = path;
Expand All @@ -59,9 +74,20 @@ public Send(string path, object message, bool localAffinity = false)
[Serializable]
public sealed class SendToAll
{
/// <summary>
/// TBD
/// </summary>
public string Path { get; }
/// <summary>
/// TBD
/// </summary>
public object Message { get; }

/// <summary>
/// TBD
/// </summary>
/// <param name="path">TBD</param>
/// <param name="message">TBD</param>
public SendToAll(string path, object message)
{
Path = path;
Expand All @@ -76,33 +102,62 @@ public SendToAll(string path, object message)
[Serializable]
public sealed class Publish
{
/// <summary>
/// TBD
/// </summary>
public string Topic { get; }
/// <summary>
/// TBD
/// </summary>
public object Message { get; }

/// <summary>
/// TBD
/// </summary>
/// <param name="topic">TBD</param>
/// <param name="message">TBD</param>
public Publish(string topic, object message)
{
Topic = topic;
Message = message;
}
}

/// <summary>
/// TBD
/// </summary>
[Serializable]
internal sealed class RefreshContactsTick
{
/// <summary>
/// TBD
/// </summary>
public static readonly RefreshContactsTick Instance = new RefreshContactsTick();
private RefreshContactsTick() { }
}

/// <summary>
/// TBD
/// </summary>
[Serializable]
internal sealed class HeartbeatTick
{
/// <summary>
/// TBD
/// </summary>
public static readonly HeartbeatTick Instance = new HeartbeatTick();
private HeartbeatTick() { }
}

/// <summary>
/// TBD
/// </summary>
[Serializable]
internal sealed class ReconnectTimeout
{
/// <summary>
/// TBD
/// </summary>
public static readonly ReconnectTimeout Instance = new ReconnectTimeout();
private ReconnectTimeout() { }
}
Expand All @@ -112,6 +167,9 @@ private ReconnectTimeout() { }
/// <summary>
/// Factory method for <see cref="ClusterClient"/> <see cref="Actor.Props"/>.
/// </summary>
/// <param name="settings">TBD</param>
/// <exception cref="ArgumentNullException">TBD</exception>
/// <returns>TBD</returns>
public static Props Props(ClusterClientSettings settings)
{
if (settings == null)
Expand All @@ -132,6 +190,12 @@ public static Props Props(ClusterClientSettings settings)
private ICancelable _refreshContactsCancelable;
private readonly Queue<Tuple<object, IActorRef>> _buffer;

/// <summary>
/// TBD
/// </summary>
/// <param name="settings">TBD</param>
/// <exception cref="ArgumentException">TBD</exception>
/// <returns>TBD</returns>
public ClusterClient(ClusterClientSettings settings)
{
if (settings.InitialContacts.Count == 0)
Expand Down Expand Up @@ -181,6 +245,9 @@ private void ScheduleRefreshContactsTick(TimeSpan interval)
Self);
}

/// <summary>
/// TBD
/// </summary>
protected override void PostStop()
{
base.PostStop();
Expand All @@ -193,6 +260,11 @@ protected override void PostStop()
}
}

/// <summary>
/// TBD
/// </summary>
/// <param name="message">TBD</param>
/// <returns>TBD</returns>
protected override bool Receive(object message)
{
return Establishing(message);
Expand Down Expand Up @@ -448,6 +520,9 @@ private void PublishContactPoints()
/// </summary>
public interface IContactPointChange
{
/// <summary>
/// TBD
/// </summary>
ActorPath ContactPoint { get; }
}

Expand All @@ -457,11 +532,18 @@ public interface IContactPointChange
/// </summary>
public sealed class ContactPointAdded : IContactPointChange
{
/// <summary>
/// TBD
/// </summary>
/// <param name="contactPoint">TBD</param>
public ContactPointAdded(ActorPath contactPoint)
{
ContactPoint = contactPoint;
}

/// <summary>
/// TBD
/// </summary>
public ActorPath ContactPoint { get; }
}

Expand All @@ -471,14 +553,24 @@ public ContactPointAdded(ActorPath contactPoint)
/// </summary>
public sealed class ContactPointRemoved : IContactPointChange
{
/// <summary>
/// TBD
/// </summary>
/// <param name="contactPoint">TBD</param>
public ContactPointRemoved(ActorPath contactPoint)
{
ContactPoint = contactPoint;
}

/// <summary>
/// TBD
/// </summary>
public ActorPath ContactPoint { get; }
}

/// <summary>
/// TBD
/// </summary>
public interface ISubscribeContactPoints
{
}
Expand All @@ -493,10 +585,16 @@ public interface ISubscribeContactPoints
/// </summary>
public sealed class SubscribeContactPoints : ISubscribeContactPoints
{
/// <summary>
/// TBD
/// </summary>
public static readonly SubscribeContactPoints Instance = new SubscribeContactPoints();
private SubscribeContactPoints() { }
}

/// <summary>
/// TBD
/// </summary>
public interface IUnsubscribeContactPoints
{
}
Expand All @@ -506,10 +604,16 @@ public interface IUnsubscribeContactPoints
/// </summary>
public sealed class UnsubscribeContactPoints : IUnsubscribeContactPoints
{
/// <summary>
/// TBD
/// </summary>
public static readonly UnsubscribeContactPoints Instance = new UnsubscribeContactPoints();
private UnsubscribeContactPoints() { }
}

/// <summary>
/// TBD
/// </summary>
public interface IGetContactPoints
{
}
Expand All @@ -520,6 +624,9 @@ public interface IGetContactPoints
/// </summary>
public sealed class GetContactPoints : IGetContactPoints
{
/// <summary>
/// TBD
/// </summary>
public static readonly GetContactPoints Instance = new GetContactPoints();
private GetContactPoints() { }
}
Expand All @@ -529,11 +636,18 @@ private GetContactPoints() { }
/// </summary>
public sealed class ContactPoints
{
/// <summary>
/// TBD
/// </summary>
/// <param name="contactPoints">TBD</param>
public ContactPoints(ImmutableHashSet<ActorPath> contactPoints)
{
ContactPointsList = contactPoints;
}

/// <summary>
/// TBD
/// </summary>
public ImmutableHashSet<ActorPath> ContactPointsList { get; }
}
}
27 changes: 27 additions & 0 deletions src/contrib/cluster/Akka.Cluster.Tools/Client/ClusterClientReceptionist.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,20 @@ namespace Akka.Cluster.Tools.Client
/// </summary>
public sealed class ClusterClientReceptionist : IExtension
{
/// <summary>
/// TBD
/// </summary>
/// <returns>TBD</returns>
public static Config DefaultConfig()
{
return ConfigurationFactory.FromResource<ClusterClient>("Akka.Cluster.Tools.Client.reference.conf");
}

/// <summary>
/// TBD
/// </summary>
/// <param name="system">TBD</param>
/// <returns>TBD</returns>
public static ClusterClientReceptionist Get(ActorSystem system)
{
return system.WithExtension<ClusterClientReceptionist, ClusterClientReceptionistExtensionProvider>();
Expand All @@ -34,6 +43,10 @@ public static ClusterClientReceptionist Get(ActorSystem system)
private readonly Config _config;
private readonly IActorRef _receptionist;

/// <summary>
/// TBD
/// </summary>
/// <param name="system">TBD</param>
public ClusterClientReceptionist(ExtendedActorSystem system)
{
_system = system;
Expand Down Expand Up @@ -70,6 +83,7 @@ internal IActorRef PubSubMediator
/// <see cref="Send"/> or <see cref="SendToAll"/> using the path elements
/// of the <see cref="IActorRef"/>, e.g. "/user/myservice".
/// </summary>
/// <param name="actorRef">TBD</param>
public void RegisterService(IActorRef actorRef)
{
PubSubMediator.Tell(new PublishSubscribe.Put(actorRef));
Expand All @@ -79,6 +93,7 @@ public void RegisterService(IActorRef actorRef)
/// A registered actor will be automatically unregistered when terminated,
/// but it can also be explicitly unregistered before termination.
/// </summary>
/// <param name="actorRef">TBD</param>
public void UnregisterService(IActorRef actorRef)
{
PubSubMediator.Tell(new PublishSubscribe.Remove(actorRef.Path.ToStringWithoutAddress()));
Expand All @@ -90,6 +105,8 @@ public void UnregisterService(IActorRef actorRef)
/// published messages.
/// The client can publish messages to this topic with <see cref="Publish"/>.
/// </summary>
/// <param name="topic">TBD</param>
/// <param name="actorRef">TBD</param>
public void RegisterSubscriber(string topic, IActorRef actorRef)
{
PubSubMediator.Tell(new PublishSubscribe.Subscribe(topic, actorRef));
Expand All @@ -99,6 +116,8 @@ public void RegisterSubscriber(string topic, IActorRef actorRef)
/// A registered subscriber will be automatically unregistered when terminated,
/// but it can also be explicitly unregistered before termination.
/// </summary>
/// <param name="topic">TBD</param>
/// <param name="actorRef">TBD</param>
public void UnregisterSubscriber(string topic, IActorRef actorRef)
{
PubSubMediator.Tell(new PublishSubscribe.Unsubscribe(topic, actorRef));
Expand Down Expand Up @@ -133,8 +152,16 @@ private IActorRef CreateReceptionist()
public IActorRef Underlying => _receptionist;
}

/// <summary>
/// TBD
/// </summary>
public class ClusterClientReceptionistExtensionProvider : ExtensionIdProvider<ClusterClientReceptionist>
{
/// <summary>
/// TBD
/// </summary>
/// <param name="system">TBD</param>
/// <returns>TBD</returns>
public override ClusterClientReceptionist CreateExtension(ExtendedActorSystem system)
{
return new ClusterClientReceptionist(system);
Expand Down
Loading

0 comments on commit d6b299a

Please sign in to comment.