diff --git a/Consul/ACL.cs b/Consul/ACL.cs
index e2687b6a2..ee49014b4 100644
--- a/Consul/ACL.cs
+++ b/Consul/ACL.cs
@@ -202,6 +202,7 @@ private class ACLCreationResult
/// [Deprecated] Create is used to generate a new token with the given parameters
///
/// The ACL entry to create
+ /// The cancellation token
/// A write result containing the newly created ACL token
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task> Create(ACLEntry acl, CancellationToken ct = default)
@@ -214,6 +215,7 @@ public Task> Create(ACLEntry acl, CancellationToken ct = def
///
/// The ACL entry to create
/// Customized write options
+ /// The cancellation token
/// A write result containing the newly created ACL token
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public async Task> Create(ACLEntry acl, WriteOptions q, CancellationToken ct = default)
@@ -226,6 +228,7 @@ public async Task> Create(ACLEntry acl, WriteOptions q, Canc
/// [Deprecated] Update is used to update the rules of an existing token
///
/// The ACL entry to update
+ /// The cancellation token
/// An empty write result
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task Update(ACLEntry acl, CancellationToken ct = default)
@@ -238,6 +241,7 @@ public Task Update(ACLEntry acl, CancellationToken ct = default)
///
/// The ACL entry to update
/// Customized write options
+ /// The cancellation token
/// An empty write result
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task Update(ACLEntry acl, WriteOptions q, CancellationToken ct = default)
@@ -249,6 +253,7 @@ public Task Update(ACLEntry acl, WriteOptions q, CancellationToken
/// [Deprecated] Destroy is used to destroy a given ACL token ID
///
/// The ACL ID to destroy
+ /// The cancellation token
/// An empty write result
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task> Destroy(string id, CancellationToken ct = default)
@@ -261,6 +266,7 @@ public Task> Destroy(string id, CancellationToken ct = default
///
/// The ACL ID to destroy
/// Customized write options
+ /// The cancellation token
/// An empty write result
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task> Destroy(string id, WriteOptions q, CancellationToken ct = default)
@@ -272,6 +278,7 @@ public Task> Destroy(string id, WriteOptions q, CancellationTo
/// [Deprecated] Clone is used to return a new token cloned from an existing one
///
/// The ACL ID to clone
+ /// The cancellation token
/// A write result containing the newly created ACL token
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task> Clone(string id, CancellationToken ct = default)
@@ -284,6 +291,7 @@ public Task> Clone(string id, CancellationToken ct = default
///
/// The ACL ID to clone
/// Customized write options
+ /// The cancellation token
/// A write result containing the newly created ACL token
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public async Task> Clone(string id, WriteOptions q, CancellationToken ct = default)
@@ -296,6 +304,7 @@ public async Task> Clone(string id, WriteOptions q, Cancella
/// [Deprecated] Info is used to query for information about an ACL token
///
/// The ACL ID to request information about
+ /// The cancellation token
/// A query result containing the ACL entry matching the provided ID, or a query result with a null response if no token matched the provided ID
[Obsolete("The Legacy ACL system has been deprecated, please use Token, Role and Policy instead.")]
public Task> Info(string id, CancellationToken ct = default)
diff --git a/Consul/Agent.cs b/Consul/Agent.cs
index c403d9471..6485a95c3 100644
--- a/Consul/Agent.cs
+++ b/Consul/Agent.cs
@@ -794,6 +794,7 @@ public Task>> Checks(CancellationToke
/// Checks returns the locally registered checks
///
/// Specifies the expression used to filter the queries results prior to returning the data
+ /// The cancellation token
/// A map of the registered check names and check data
public Task>> Checks(Filter filter, CancellationToken ct = default)
{
@@ -813,6 +814,7 @@ public async Task>> Services(Cancel
/// Services returns the locally registered services
///
/// Specifies the expression used to filter the queries results prior to returning the data
+ /// The cancellation token
/// A map of the registered services and service data
public async Task>> Services(Filter filter, CancellationToken ct = default)
{
@@ -837,6 +839,7 @@ public Task> Members(bool wan, CancellationToken ct =
/// ServiceRegister is used to register a new service with the local agent
///
/// A service registration object
+ /// The cancellation token
/// An empty write result
public Task ServiceRegister(AgentServiceRegistration service, CancellationToken ct = default)
{
@@ -848,6 +851,7 @@ public Task ServiceRegister(AgentServiceRegistration service, Cance
///
/// A service registration object
/// Missing health checks from the request will be deleted from the agent.
+ /// The cancellation token
/// An empty write result
public Task ServiceRegister(AgentServiceRegistration service, bool replaceExistingChecks, CancellationToken ct = default)
{
@@ -863,6 +867,7 @@ public Task ServiceRegister(AgentServiceRegistration service, bool
/// ServiceRegister is used to register a new service with the local agent
///
/// The service ID
+ /// The cancellation token
/// An empty write result
public Task ServiceDeregister(string serviceID, CancellationToken ct = default)
{
@@ -874,6 +879,7 @@ public Task ServiceDeregister(string serviceID, CancellationToken c
///
/// The check ID
/// An optional, arbitrary string to write to the check status
+ /// The cancellation token
public Task PassTTL(string checkID, string note, CancellationToken ct = default)
{
return LegacyUpdateTTL(checkID, note, TTLStatus.Pass, ct);
@@ -884,6 +890,7 @@ public Task PassTTL(string checkID, string note, CancellationToken ct = default)
///
/// The check ID
/// An optional, arbitrary string to write to the check status
+ /// The cancellation token
public Task WarnTTL(string checkID, string note, CancellationToken ct = default)
{
return LegacyUpdateTTL(checkID, note, TTLStatus.Warn, ct);
@@ -894,6 +901,7 @@ public Task WarnTTL(string checkID, string note, CancellationToken ct = default)
///
/// The check ID
/// An optional, arbitrary string to write to the check status
+ /// The cancellation token
public Task FailTTL(string checkID, string note, CancellationToken ct = default)
{
return LegacyUpdateTTL(checkID, note, TTLStatus.Critical, ct);
@@ -905,6 +913,7 @@ public Task FailTTL(string checkID, string note, CancellationToken ct = default)
/// The check ID
/// An optional, arbitrary string to write to the check status
/// The state to set the check to
+ /// The cancellation token
/// An empty write result
public Task UpdateTTL(string checkID, string output, TTLStatus status, CancellationToken ct = default)
{
@@ -922,6 +931,7 @@ public Task UpdateTTL(string checkID, string output, TTLStatus stat
/// The check ID
/// An optional, arbitrary string to note on the check status
/// The state to set the check to
+ /// The cancellation token
/// An empty write result
private Task LegacyUpdateTTL(string checkID, string note, TTLStatus status, CancellationToken ct = default)
{
@@ -937,6 +947,7 @@ private Task LegacyUpdateTTL(string checkID, string note, TTLStatus
/// CheckRegister is used to register a new check with the local agent
///
/// A check registration object
+ /// The cancellation token
/// An empty write result
public Task CheckRegister(AgentCheckRegistration check, CancellationToken ct = default)
{
@@ -947,6 +958,7 @@ public Task CheckRegister(AgentCheckRegistration check, Cancellatio
/// CheckDeregister is used to deregister a check with the local agent
///
/// The check ID to deregister
+ /// The cancellation token
/// An empty write result
public Task CheckDeregister(string checkID, CancellationToken ct = default)
{
@@ -958,6 +970,7 @@ public Task CheckDeregister(string checkID, CancellationToken ct =
///
/// The address to join to
/// Join the WAN pool
+ /// The cancellation token
/// An empty write result
public Task Join(string addr, bool wan, CancellationToken ct = default)
{
@@ -973,6 +986,7 @@ public Task Join(string addr, bool wan, CancellationToken ct = defa
/// ForceLeave is used to have the agent eject a failed node
///
/// The node name to remove
+ /// The cancellation token
/// An empty write result
public Task ForceLeave(string node, CancellationToken ct = default)
{
@@ -1001,6 +1015,7 @@ public Task Reload(CancellationToken ct = default)
/// Reload triggers a configuration reload for the agent we are connected to.
///
/// The node name to reload
+ /// The cancellation token
/// An empty write result
[Obsolete]
public Task Reload(string node, CancellationToken ct = default)
@@ -1013,6 +1028,7 @@ public Task Reload(string node, CancellationToken ct = default)
///
/// The service ID
/// An optional reason
+ /// The cancellation token
/// An empty write result
public Task EnableServiceMaintenance(string serviceID, string reason, CancellationToken ct = default)
{
@@ -1026,6 +1042,7 @@ public Task EnableServiceMaintenance(string serviceID, string reaso
/// DisableServiceMaintenance toggles service maintenance mode off for the given service ID
///
/// The service ID
+ /// The cancellation token
/// An empty write result
public Task DisableServiceMaintenance(string serviceID, CancellationToken ct = default)
{
@@ -1038,6 +1055,7 @@ public Task DisableServiceMaintenance(string serviceID, Cancellatio
/// EnableNodeMaintenance toggles node maintenance mode on for the agent we are connected to
///
/// An optional reason
+ /// The cancellation token
/// An empty write result
public Task EnableNodeMaintenance(string reason, CancellationToken ct = default)
{
@@ -1089,6 +1107,8 @@ public async Task MonitorJSON(LogLevel level = default, CancellationT
/// GetLocalServiceHealth returns the health info of a service registered on the local agent
///
/// Name of service
+ ///
+ /// The cancellation token
/// An array containing the details of each passing, warning, or critical service
public async Task> GetLocalServiceHealth(string serviceName, QueryOptions q, CancellationToken ct = default)
{
@@ -1099,6 +1119,7 @@ public async Task> GetLocalServiceHealth(strin
/// GetLocalServiceHealth returns the health info of a service registered on the local agent
///
/// Name of service
+ /// The cancellation token
/// An array containing the details of each passing, warning, or critical service
public async Task> GetLocalServiceHealth(string serviceName, CancellationToken ct = default)
{
@@ -1109,6 +1130,8 @@ public async Task> GetLocalServiceHealth(strin
/// GetWorstLocalServiceHealth returns the worst aggregated status of a service registered on the local agent
///
/// Name of service
+ ///
+ /// The cancellation token
/// passing, warning, or critical
public async Task> GetWorstLocalServiceHealth(string serviceName, QueryOptions q, CancellationToken ct = default)
{
@@ -1121,6 +1144,7 @@ public async Task> GetWorstLocalServiceHealth(string service
/// GetWorstLocalServiceHealth returns the worst aggregated status of a service registered on the local agent
///
/// Name of service
+ /// The cancellation token
/// passing, warning, or critical
public async Task> GetWorstLocalServiceHealth(string serviceName, CancellationToken ct = default)
{
@@ -1131,6 +1155,8 @@ public async Task> GetWorstLocalServiceHealth(string service
/// GetLocalServiceHealthByID returns the health info of a service registered on the local agent by ID
///
/// ID of the service
+ ///
+ /// The cancellation token
/// An array containing the details of each passing, warning, or critical service
public async Task> GetLocalServiceHealthByID(string serviceID, QueryOptions q, CancellationToken ct = default)
{
@@ -1141,6 +1167,7 @@ public async Task> GetLocalServiceHealthByID(str
/// GetLocalServiceHealthByID returns the health info of a service registered on the local agent by ID
///
/// ID of the service
+ /// The cancellation token
/// An array containing the details of each passing, warning, or critical service
public async Task> GetLocalServiceHealthByID(string serviceID, CancellationToken ct = default)
{
@@ -1150,7 +1177,7 @@ public async Task> GetLocalServiceHealthByID(str
///
/// GetAgentHostInfo returns the host info of the agent
///
- ///
+ /// The cancellation token
/// Agent Host Information
public async Task> GetAgentHostInfo(CancellationToken ct = default)
{
@@ -1160,7 +1187,7 @@ public async Task> GetAgentHostInfo(CancellationToken
///
/// GetAgentVersion returns the version of the agent
///
- ///
+ /// The cancellation token
/// Version of the agent
public async Task> GetAgentVersion(CancellationToken ct = default)
{
@@ -1301,7 +1328,7 @@ IEnumerator IEnumerable.GetEnumerator()
///
/// GetAgentMetrics returns the metrics of the local agent
///
- ///
+ /// The cancellation token
/// Metrics of the local agent
public async Task> GetAgentMetrics(CancellationToken ct = default)
{
diff --git a/Consul/Catalog.cs b/Consul/Catalog.cs
index 0ea2e3f19..ed515eb21 100644
--- a/Consul/Catalog.cs
+++ b/Consul/Catalog.cs
@@ -157,6 +157,7 @@ internal Catalog(ConsulClient c)
/// Register a new catalog item
///
/// A catalog registration
+ /// The cancellation token
/// An empty write result
public Task Register(CatalogRegistration reg, CancellationToken ct = default)
{
@@ -168,6 +169,7 @@ public Task Register(CatalogRegistration reg, CancellationToken ct
///
/// A catalog registration
/// Customized write options
+ /// The cancellation token
/// An empty write result
public Task Register(CatalogRegistration reg, WriteOptions q, CancellationToken ct = default)
{
@@ -178,6 +180,7 @@ public Task Register(CatalogRegistration reg, WriteOptions q, Cance
/// Deregister an existing catalog item
///
/// A catalog deregistration
+ /// The cancellation token
/// An empty write result
public Task Deregister(CatalogDeregistration reg, CancellationToken ct = default)
{
@@ -189,6 +192,7 @@ public Task Deregister(CatalogDeregistration reg, CancellationToken
///
/// A catalog deregistration
/// Customized write options
+ /// The cancellation token
/// An empty write result
public Task Deregister(CatalogDeregistration reg, WriteOptions q, CancellationToken ct = default)
{
diff --git a/Consul/Client_Request.cs b/Consul/Client_Request.cs
index 28256ce10..b2f41a2c1 100644
--- a/Consul/Client_Request.cs
+++ b/Consul/Client_Request.cs
@@ -28,7 +28,9 @@ namespace Consul
///
/// The consistency mode of a request.
///
- ///
+ ///
+ ///
+ ///
public enum ConsistencyMode
{
///
diff --git a/Consul/Configuration.cs b/Consul/Configuration.cs
index e34d72ec3..8cd51990a 100644
--- a/Consul/Configuration.cs
+++ b/Consul/Configuration.cs
@@ -18,7 +18,6 @@
using System;
using System.Collections.Generic;
-using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Consul.Interfaces;
@@ -1677,6 +1676,7 @@ internal Configuration(ConsulClient c)
///
/// Write Options
/// The configuration entry
+ /// The cancellation token
/// An empty write result
public Task ApplyConfig(WriteOptions q, TConfig configurationEntry, CancellationToken ct = default) where TConfig : IConfigurationEntry
{
@@ -1688,6 +1688,7 @@ public Task ApplyConfig(WriteOptions q, TConfig configurat
/// This creates or updates the given config entry.
///
/// The configuration entry
+ /// The cancellation token
/// An empty write result
public Task ApplyConfig(TConfig configurationEntry, CancellationToken ct = default) where TConfig : IConfigurationEntry
{
@@ -1750,7 +1751,6 @@ public Task>> ListConfig(string kind, Cancell
///
/// This Deletes the given config entry.
///
- ///
/// The kind of config entry
/// The name of config entry
/// Write Options
@@ -1765,7 +1765,6 @@ public Task DeleteConfig(string kind, string name, WriteOptions q,
///
/// This Deletes the given config entry.
///
- ///
/// The kind of config entry
/// The name of config entry
/// Cancellation Token
diff --git a/Consul/Coordinate.cs b/Consul/Coordinate.cs
index ea70009e4..1bb64c9d4 100644
--- a/Consul/Coordinate.cs
+++ b/Consul/Coordinate.cs
@@ -84,6 +84,7 @@ public Task> Nodes(CancellationToken ct = default
/// Nodes is used to return the coordinates of all the nodes in the LAN pool.
///
/// Customized query options
+ /// The cancellation token
/// A query result containing coordinates of all the nodes in the LAN pool
public Task> Nodes(QueryOptions q, CancellationToken ct = default)
{
@@ -96,7 +97,7 @@ public Task> Nodes(QueryOptions q, CancellationTo
/// The node to query"
/// The cancellation token"
/// Customized query options"
- /// Node is used to return the coordinates of a given node in the LAN pool.
+ /// Node is used to return the coordinates of a given node in the LAN pool.
public Task> Node(string node, QueryOptions q, CancellationToken ct = default)
{
return _client.Get(string.Format("/v1/coordinate/node/{0}", node), q).Execute(ct);
diff --git a/Consul/Event.cs b/Consul/Event.cs
index 74c9f59b3..56d76983f 100644
--- a/Consul/Event.cs
+++ b/Consul/Event.cs
@@ -65,6 +65,7 @@ public Task> Fire(UserEvent ue, CancellationToken ct = defau
///
/// A User Event definition
/// Customized write options
+ /// The cancellation token
///
public async Task> Fire(UserEvent ue, WriteOptions q, CancellationToken ct = default)
{
@@ -98,6 +99,7 @@ public Task> List(CancellationToken ct = default)
/// List is used to get the most recent events an agent has received. This list can be optionally filtered by the name. This endpoint supports quasi-blocking queries. The index is not monotonic, nor does it provide provide LastContact or KnownLeader.
///
/// The name of the event to filter for
+ /// The cancellation token
/// An array of events
public Task> List(string name, CancellationToken ct = default)
{
diff --git a/Consul/Health.cs b/Consul/Health.cs
index ceee4ab01..f299e3048 100644
--- a/Consul/Health.cs
+++ b/Consul/Health.cs
@@ -189,6 +189,7 @@ internal Health(ConsulClient c)
/// Checks is used to return the checks associated with a service
///
/// The service ID
+ /// The cancellation token
/// A query result containing the health checks matching the provided service ID, or a query result with a null response if no service matched the provided ID
public Task> Checks(string service, CancellationToken ct = default)
{
@@ -211,6 +212,7 @@ public Task> Checks(string service, QueryOptions q, C
/// Node is used to query for checks belonging to a given node
///
/// The node name
+ /// The cancellation token"
/// A query result containing the health checks matching the provided node ID, or a query result with a null response if no node matched the provided ID
public Task> Node(string node, CancellationToken ct = default)
{
@@ -233,6 +235,7 @@ public Task> Node(string node, QueryOptions q, Cancel
/// Service is used to query health information along with service info for a given service. It can optionally do server-side filtering on a tag or nodes with passing health checks only.
///
/// The service ID
+ /// The cancellation token"
/// A query result containing the service members matching the provided service ID, or a query result with a null response if no service members matched the filters provided
public Task> Service(string service, CancellationToken ct = default)
{
@@ -244,6 +247,7 @@ public Task> Service(string service, CancellationTok
///
/// The service ID
/// The service member tag
+ /// The cancellation token"
/// A query result containing the service members matching the provided service ID and tag, or a query result with a null response if no service members matched the filters provided
public Task> Service(string service, string tag, CancellationToken ct = default)
{
@@ -256,6 +260,7 @@ public Task> Service(string service, string tag, Can
/// The service ID
/// The service member tag
/// Only return if the health check is in the Passing state
+ /// The cancellation token"
/// A query result containing the service members matching the provided service ID, tag, and health status, or a query result with a null response if no service members matched the filters provided
public Task> Service(string service, string tag, bool passingOnly, CancellationToken ct = default)
{
@@ -302,6 +307,7 @@ public Task> Service(string service, string tag, boo
///
/// Connect is equivalent to Service, except that it will only return services which are Connect-enabled
+ ///
/// The service ID
/// The service member tag
/// Only return if the health check is in the Passing state
@@ -325,11 +331,11 @@ public Task> Connect(string service, string tag, boo
///
/// Service is used to query health information along with service info for a given service. It can optionally do server-side filtering on a tag or nodes with passing health checks only.
+ ///
/// The service ID
/// The service member tag
/// Only return if the health check is in the Passing state
/// Customized query options
- /// Specifies the expression used to filter the queries results prior to returning the data
/// Cancellation token for long poll request. If set, OperationCanceledException will be thrown if the request is cancelled before completing
/// This endpoint returns the nodes providing a Connect-capable service in a given datacenter, or a query result with a null response
public Task> Connect(string service, string tag, bool passingOnly, QueryOptions q, CancellationToken ct = default)
@@ -339,6 +345,7 @@ public Task> Connect(string service, string tag, boo
///
/// Ingress is equivalent to Service and Connect, except that it will only return ingress services
+ ///
/// The service ID
/// The service member tag
/// Only return if the health check is in the Passing state
@@ -362,6 +369,7 @@ public Task> Ingress(string service, string tag, boo
///
/// Ingress is equivalent to Service and Connect, except that it will only return ingress services
+ ///
/// The service ID
/// The service member tag
/// Only return if the health check is in the Passing state
@@ -375,6 +383,7 @@ public Task> Ingress(string service, string tag, boo
///
/// Ingress is equivalent to Service and Connect, except that it will only return ingress services
+ ///
/// The service ID
/// The service member tag
/// Only return if the health check is in the Passing state
@@ -389,6 +398,7 @@ public Task> Ingress(string service, string tag, boo
/// State is used to retrieve all the checks in a given state. The wildcard "any" state can also be used for all checks.
///
/// The health status to filter for
+ /// The cancellation token
/// A query result containing a list of health checks in the specified state, or a query result with a null response if no health checks matched the provided state
public Task> State(HealthStatus status, CancellationToken ct = default)
{
diff --git a/Consul/KV.cs b/Consul/KV.cs
index f372163fd..bcf4e6c4e 100644
--- a/Consul/KV.cs
+++ b/Consul/KV.cs
@@ -252,6 +252,7 @@ public KV(ConsulClient c)
/// Acquire is used for a lock acquisition operation. The Key, Flags, Value and Session are respected.
/// p.Validate();
/// The key/value pair to store in Consul
+ /// The cancellation token
/// A write result indicating if the acquisition attempt succeeded
public Task> Acquire(KVPair p, CancellationToken ct = default)
{
@@ -263,6 +264,7 @@ public Task> Acquire(KVPair p, CancellationToken ct = default)
///
/// The key/value pair to store in Consul
/// Customized write options
+ /// The cancellation token
/// A write result indicating if the acquisition attempt succeeded
public Task> Acquire(KVPair p, WriteOptions q, CancellationToken ct = default)
{
@@ -280,6 +282,7 @@ public Task> Acquire(KVPair p, WriteOptions q, CancellationTok
/// CAS is used for a Check-And-Set operation. The Key, ModifyIndex, Flags and Value are respected. Returns true on success or false on failures.
///
/// The key/value pair to store in Consul
+ /// The cancellation token
/// A write result indicating if the write attempt succeeded
public Task> CAS(KVPair p, CancellationToken ct = default)
{
@@ -291,6 +294,7 @@ public Task> CAS(KVPair p, CancellationToken ct = default)
///
/// The key/value pair to store in Consul
/// Customized write options
+ /// The cancellation token
/// A write result indicating if the write attempt succeeded
public Task> CAS(KVPair p, WriteOptions q, CancellationToken ct = default)
{
@@ -308,6 +312,7 @@ public Task> CAS(KVPair p, WriteOptions q, CancellationToken c
/// Delete is used to delete a single key.
///
/// The key name to delete
+ /// The cancellation token
/// A write result indicating if the delete attempt succeeded
public Task> Delete(string key, CancellationToken ct = default)
{
@@ -319,6 +324,7 @@ public Task> Delete(string key, CancellationToken ct = default
///
/// The key name to delete
/// Customized write options
+ /// The cancellation token
/// A write result indicating if the delete attempt succeeded
public Task> Delete(string key, WriteOptions q, CancellationToken ct = default)
{
@@ -330,6 +336,7 @@ public Task> Delete(string key, WriteOptions q, CancellationTo
/// DeleteCAS is used for a Delete Check-And-Set operation. The Key and ModifyIndex are respected. Returns true on success or false on failures.
///
/// The key/value pair to delete
+ /// The cancellation token
/// A write result indicating if the delete attempt succeeded
public Task> DeleteCAS(KVPair p, CancellationToken ct = default)
{
@@ -341,6 +348,7 @@ public Task> DeleteCAS(KVPair p, CancellationToken ct = defaul
///
/// The key/value pair to delete
/// Customized write options
+ /// The cancellation token
/// A write result indicating if the delete attempt succeeded
public Task> DeleteCAS(KVPair p, WriteOptions q, CancellationToken ct = default)
{
@@ -354,6 +362,7 @@ public Task> DeleteCAS(KVPair p, WriteOptions q, CancellationT
/// DeleteTree is used to delete all keys under a prefix
///
/// The key prefix to delete from
+ /// The cancellation token
/// A write result indicating if the recursive delete attempt succeeded
public Task> DeleteTree(string prefix, CancellationToken ct = default)
{
@@ -365,6 +374,7 @@ public Task> DeleteTree(string prefix, CancellationToken ct =
///
/// The key prefix to delete from
/// Customized write options
+ /// The cancellation token
/// A write result indicating if the recursiv edelete attempt succeeded
public Task> DeleteTree(string prefix, WriteOptions q, CancellationToken ct = default)
{
@@ -378,6 +388,7 @@ public Task> DeleteTree(string prefix, WriteOptions q, Cancell
/// Get is used to lookup a single key
///
/// The key name
+ /// The cancellation token
/// A query result containing the requested key/value pair, or a query result with a null response if the key does not exist
public Task> Get(string key, CancellationToken ct = default)
{
@@ -402,6 +413,7 @@ public async Task> Get(string key, QueryOptions q, Cancellat
/// Keys is used to list all the keys under a prefix.
///
/// The key prefix to filter on
+ /// The cancellation token
/// A query result containing a list of key names
public Task> Keys(string prefix, CancellationToken ct = default)
{
@@ -413,6 +425,7 @@ public Task> Keys(string prefix, CancellationToken ct = de
///
/// The key prefix to filter on
/// The terminating suffix of the filter - e.g. a separator of "/" and a prefix of "/web/" will match "/web/foo" and "/web/foo/" but not "/web/foo/baz"
+ /// The cancellation token
/// A query result containing a list of key names
public Task> Keys(string prefix, string separator, CancellationToken ct = default)
{
@@ -442,6 +455,7 @@ public Task> Keys(string prefix, string separator, QueryOp
/// List is used to lookup all keys under a prefix
///
/// The prefix to search under. Does not have to be a full path - e.g. a prefix of "ab" will find keys "abcd" and "ab11" but not "acdc"
+ /// The cancellation token
/// A query result containing the keys matching the prefix
public Task> List(string prefix, CancellationToken ct = default)
{
@@ -466,6 +480,7 @@ public Task> List(string prefix, QueryOptions q, Cancellat
/// Put is used to write a new value. Only the Key, Flags and Value properties are respected.
///
/// The key/value pair to store in Consul
+ /// The cancellation token
/// A write result indicating if the write attempt succeeded
public Task> Put(KVPair p, CancellationToken ct = default)
{
@@ -477,6 +492,7 @@ public Task> Put(KVPair p, CancellationToken ct = default)
///
/// The key/value pair to store in Consul
/// Customized write options
+ /// The cancellation token
/// A write result indicating if the write attempt succeeded
public Task> Put(KVPair p, WriteOptions q, CancellationToken ct = default)
{
@@ -493,6 +509,7 @@ public Task> Put(KVPair p, WriteOptions q, CancellationToken c
/// Release is used for a lock release operation. The Key, Flags, Value and Session are respected.
///
/// The key/value pair to store in Consul
+ /// The cancellation token
/// A write result indicating if the release attempt succeeded
public Task> Release(KVPair p, CancellationToken ct = default)
{
@@ -504,6 +521,7 @@ public Task> Release(KVPair p, CancellationToken ct = default)
///
/// The key/value pair to store in Consul
/// Customized write options
+ /// The cancellation token
/// A write result indicating if the release attempt succeeded
public Task> Release(KVPair p, WriteOptions q, CancellationToken ct = default)
{
diff --git a/Consul/Lock.cs b/Consul/Lock.cs
index 785bba60d..f43de2231 100644
--- a/Consul/Lock.cs
+++ b/Consul/Lock.cs
@@ -612,9 +612,9 @@ public TimeSpan LockRetryTime
public TimeSpan MonitorRetryTime { get; set; }
///
- /// When set to false, will block forever until the lock is acquired. LockWaitTime is ignored in this case.
+ /// When set to false, will block forever until the lock is acquired. LockWaitTime is ignored in this case.
///
- /// When set to true, the lock within a timestamp (It is analogous to SemaphoreSlim.Wait(Timespan timeout).
+ /// When set to true, the lock within a timestamp (It is analogous to SemaphoreSlim.Wait(Timespan timeout).
/// Under the hood, it attempts to acquire the lock multiple times if needed (due to the HTTP Long Poll returning early),
/// and will do so as many times as it can within the bounds set by LockWaitTime.
/// If LockWaitTime is set to 0, there will be only single attempt to acquire the lock.
@@ -666,7 +666,7 @@ public IDistributedLock CreateLock(LockOptions opts)
/// AcquireLock creates a lock that is already acquired when this call returns.
///
///
- ///
+ /// The cancellation token
///
public Task AcquireLock(string key, CancellationToken ct = default)
{
@@ -681,7 +681,7 @@ public Task AcquireLock(string key, CancellationToken ct = def
/// AcquireLock creates a lock that is already acquired when this call returns.
///
///
- ///
+ /// The cancellation token
///
public async Task AcquireLock(LockOptions opts, CancellationToken ct = default)
{
@@ -700,6 +700,7 @@ public async Task AcquireLock(LockOptions opts, CancellationTo
///
///
///
+ /// The cancellation token
///
public Task ExecuteLocked(string key, Action action, CancellationToken ct = default)
{
@@ -715,6 +716,7 @@ public Task ExecuteLocked(string key, Action action, CancellationToken ct = defa
///
///
///
+ /// The cancellation token
///
public async Task ExecuteLocked(LockOptions opts, Action action, CancellationToken ct = default)
{
@@ -747,7 +749,7 @@ public async Task ExecuteLocked(LockOptions opts, Action action, CancellationTok
/// ExecuteLock accepts a delegate to execute in the context of a lock, releasing the lock when completed.
///
///
- ///
+ /// The cancellation token
///
///
[Obsolete("This method will be removed in a future release. Replace calls with the method signature ExecuteLocked(string, Action, CancellationToken)")]
@@ -768,7 +770,7 @@ public Task ExecuteLocked(string key, CancellationToken ct, Action action)
/// ExecuteLock accepts a delegate to execute in the context of a lock, releasing the lock when completed.
///
///
- ///
+ /// The cancellation token
///
///
[Obsolete("This method will be removed in a future release. Replace calls with the method signature ExecuteLocked(LockOptions, Action, CancellationToken)")]
diff --git a/Consul/Raw.cs b/Consul/Raw.cs
index fcfe83dfd..6b768ff56 100644
--- a/Consul/Raw.cs
+++ b/Consul/Raw.cs
@@ -52,6 +52,7 @@ public Task> Query(string endpoint, QueryOptions q, Cancell
/// The URL endpoint to access
/// The object to serialize and send to the endpoint. Must be able to be JSON serialized, or be an object of type byte[], which is sent without serialzation.
/// Custom write options
+ /// The cancellation token
/// The data returned by the custom endpoint in response to the write request
public Task> Write(string endpoint, object obj, WriteOptions q, CancellationToken ct = default)
{
diff --git a/Consul/Session.cs b/Consul/Session.cs
index 5b5677fce..2ce9e51ec 100644
--- a/Consul/Session.cs
+++ b/Consul/Session.cs
@@ -261,7 +261,7 @@ public Task RenewPeriodic(TimeSpan initialTTL, string id, WriteOptions q, Cancel
///
/// Create makes a new session. Providing a session entry can customize the session. It can also be null to use defaults.
///
- /// The SessionEntry options to use
+ /// The cancellation token
/// A write result containing the new session ID
public Task> Create(CancellationToken ct = default)
@@ -283,6 +283,7 @@ public Task> Create(SessionEntry se, CancellationToken ct =
///
/// The SessionEntry options to use
/// Customized write options
+ /// The cancellation token
/// A write result containing the new session ID
public async Task> Create(SessionEntry se, WriteOptions q, CancellationToken ct = default)
{
@@ -301,6 +302,7 @@ public Task> CreateNoChecks(CancellationToken ct = default)
/// CreateNoChecks is like Create but is used specifically to create a session with no associated health checks.
///
/// The SessionEntry options to use
+ /// The cancellation token
/// A write result containing the new session ID
public Task> CreateNoChecks(SessionEntry se, CancellationToken ct = default)
{
@@ -312,6 +314,7 @@ public Task> CreateNoChecks(SessionEntry se, CancellationTok
///
/// The SessionEntry options to use
/// Customized write options
+ /// The cancellation token
/// A write result containing the new session ID
public Task> CreateNoChecks(SessionEntry se, WriteOptions q, CancellationToken ct = default)
{
@@ -335,6 +338,7 @@ public Task> CreateNoChecks(SessionEntry se, WriteOptions q,
/// Destroy invalidates a given session
///
/// The session ID to destroy
+ /// The cancellation token
/// A write result containing the result of the session destruction
public Task> Destroy(string id, CancellationToken ct = default)
{
@@ -346,6 +350,7 @@ public Task> Destroy(string id, CancellationToken ct = default
///
/// The session ID to destroy
/// Customized write options
+ /// The cancellation token
/// A write result containing the result of the session destruction
public Task> Destroy(string id, WriteOptions q, CancellationToken ct = default)
{
@@ -356,6 +361,7 @@ public Task> Destroy(string id, WriteOptions q, CancellationTo
/// Info looks up a single session
///
/// The session ID to look up
+ /// The cancellation token
/// A query result containing the session information, or an empty query result if the session entry does not exist
public Task> Info(string id, CancellationToken ct = default)
{
@@ -367,6 +373,7 @@ public Task> Info(string id, CancellationToken ct = de
///
/// The session ID to look up
/// Customized query options
+ /// The cancellation token
/// A query result containing the session information, or an empty query result if the session entry does not exist
public async Task> Info(string id, QueryOptions q, CancellationToken ct = default)
{
@@ -387,6 +394,7 @@ public Task> List(CancellationToken ct = default)
/// List gets all active sessions
///
/// Customized query options
+ /// The cancellation token
/// A query result containing the list of sessions, or an empty query result if no sessions exist
public Task> List(QueryOptions q, CancellationToken ct = default)
{
@@ -397,6 +405,7 @@ public Task> List(QueryOptions q, CancellationToken
/// Node gets all sessions for a node
///
/// The node ID
+ /// The cancellation token
/// A query result containing the list of sessions, or an empty query result if no sessions exist
public Task> Node(string node, CancellationToken ct = default)
{
@@ -408,6 +417,7 @@ public Task> Node(string node, CancellationToken ct
///
/// The node ID
/// Customized query options
+ /// The cancellation token
/// A query result containing the list of sessions, or an empty query result if no sessions exist
public Task> Node(string node, QueryOptions q, CancellationToken ct = default)
{
@@ -418,6 +428,7 @@ public Task> Node(string node, QueryOptions q, Cance
/// Renew renews the TTL on a given session
///
/// The session ID to renew
+ /// The cancellation token
/// An updated session entry
public Task> Renew(string id, CancellationToken ct = default)
{
@@ -429,6 +440,7 @@ public Task> Renew(string id, CancellationToken ct = d
///
/// The session ID to renew
/// Customized write options
+ /// The cancellation token
/// An updated session entry
public async Task> Renew(string id, WriteOptions q, CancellationToken ct = default)
{
diff --git a/Directory.Build.props b/Directory.Build.props
index 6c7da6c63..b57c3964a 100644
--- a/Directory.Build.props
+++ b/Directory.Build.props
@@ -15,5 +15,7 @@
../assets/consuldotnet.snk
true
Copyright 2020-$([System.DateTime]::Now.ToString('yyyy')) G-Research Limited
+ true
+ CS1591