adds docs

This commit is contained in:
Shannon
2015-03-27 12:37:03 +11:00
parent c73749ea54
commit a9b71f8533
3 changed files with 34 additions and 4 deletions

View File

@@ -3,7 +3,11 @@ using umbraco.interfaces;
namespace Umbraco.Core.Sync
{
public class RefreshInstructionEnvelope
/// <summary>
/// Used for any 'Batched' <see cref="IServerMessenger"/> instances which specifies a set of <see cref="RefreshInstruction"/> targeting a collection of
/// <see cref="IServerAddress"/>
/// </summary>
public sealed class RefreshInstructionEnvelope
{
public RefreshInstructionEnvelope(IEnumerable<IServerAddress> servers, ICacheRefresher refresher, IEnumerable<RefreshInstruction> instructions)
{

View File

@@ -144,6 +144,16 @@ namespace Umbraco.Core.Sync
#region Deliver
/// <summary>
/// Executes the non strongly typed <see cref="ICacheRefresher"/> on the local/current server
/// </summary>
/// <param name="refresher"></param>
/// <param name="messageType"></param>
/// <param name="ids"></param>
/// <param name="json"></param>
/// <remarks>
/// Since this is only for non strongly typed <see cref="ICacheRefresher"/> it will throw for message types that by instance
/// </remarks>
protected void DeliverLocal(ICacheRefresher refresher, MessageType messageType, IEnumerable<object> ids = null, string json = null)
{
if (refresher == null) throw new ArgumentNullException("refresher");
@@ -195,7 +205,18 @@ namespace Umbraco.Core.Sync
throw new NotSupportedException("Invalid message type " + messageType);
}
}
/// <summary>
/// Executes the strongly typed <see cref="ICacheRefresher{T}"/> on the local/current server
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="refresher"></param>
/// <param name="messageType"></param>
/// <param name="getId"></param>
/// <param name="instances"></param>
/// <remarks>
/// Since this is only for strongly typed <see cref="ICacheRefresher{T}"/> it will throw for message types that are not by instance
/// </remarks>
protected void DeliverLocal<T>(ICacheRefresher refresher, MessageType messageType, Func<T, object> getId, IEnumerable<T> instances)
{
if (refresher == null) throw new ArgumentNullException("refresher");

View File

@@ -10,8 +10,13 @@ namespace Umbraco.Web.Cache
/// Represents the entry point into Umbraco's distributed cache infrastructure.
/// </summary>
/// <remarks>
/// <para>The distributed cache infrastructure ensures that distributed caches are
/// invalidated properly in load balancing environments.</para>
/// <para>
/// The distributed cache infrastructure ensures that distributed caches are
/// invalidated properly in load balancing environments.
/// </para>
/// <para>
/// Distribute caches include static (in-memory) cache, runtime cache, front-end content cache, Examine/Lucene indexes
/// </para>
/// </remarks>
public sealed class DistributedCache
{