This is an automated email from the ASF dual-hosted git repository.
tabish pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/qpid-proton-dotnet.git
The following commit(s) were added to refs/heads/main by this push:
new 6edf21e PROTON-2548 Fix some documentation errors and cleanup
6edf21e is described below
commit 6edf21ef220f924958707f1d987f78ecd28c472a
Author: Timothy Bish <tabish...@gmail.com>
AuthorDate: Thu May 19 17:37:14 2022 -0400
PROTON-2548 Fix some documentation errors and cleanup
---
Proton.dox | 2 +-
README.md | 4 ++--
pom.xml | 7 +++----
src/Proton.Client/Client/IConnection.cs | 4 ++--
src/Proton.Client/Client/ILink.cs | 8 ++++----
src/Proton.Client/Client/IMessage.cs | 4 ++--
src/Proton.Client/Client/IReceiver.cs | 10 +++++-----
src/Proton.Client/Client/ISession.cs | 6 +++---
src/Proton.Client/Client/IStreamReceiver.cs | 10 +++++-----
src/Proton.Client/Client/IStreamTracker.cs | 4 ++--
src/Proton.Client/Client/ITracker.cs | 4 ++--
src/Proton.Client/Client/ReconnectOptions.cs | 2 +-
src/Proton.Client/Client/SaslOptions.cs | 2 +-
src/Proton.Client/Client/TransportOptions.cs | 1 -
14 files changed, 33 insertions(+), 35 deletions(-)
diff --git a/Proton.dox b/Proton.dox
index 8b1f67a..49dff20 100644
--- a/Proton.dox
+++ b/Proton.dox
@@ -16,7 +16,7 @@
##
DOXYFILE_ENCODING = UTF-8
-PROJECT_NAME = "Proton .NET"
+PROJECT_NAME = "Proton DotNet"
OUTPUT_DIRECTORY = $(DOXYGEN_OUTPUT_PATH)
TAB_SIZE = 8
INPUT = src/Proton,src/Proton.Client
diff --git a/README.md b/README.md
index 6b932d6..0d9ee0d 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-# Apache Qpid Proton.NET
+# Apache Qpid Proton DotNet
===========================
-Qpid Proton.NET is a high-performance, lightweight AMQP protocol library. It
can be
+Qpid Proton DotNet is a high-performance, lightweight AMQP protocol library.
It can be
used in the widest range of messaging applications, including brokers, client
libraries, routers, bridges, proxies, and more.
diff --git a/pom.xml b/pom.xml
index c53cb21..41f7536 100644
--- a/pom.xml
+++ b/pom.xml
@@ -29,11 +29,10 @@
<groupId>org.apache.qpid</groupId>
<artifactId>qpid-proton-dotnet</artifactId>
<version>1.0.0-SNAPSHOT</version>
- <name>QpidDispatch</name>
- <inceptionYear>2022</inceptionYear>
+ <name>Qpid Proton Dotnet</name>
<url>https://qpid.apache.org</url>
-
- <description>Qpid Proton .NET</description>
+ <description>Qpid Proton Engine and Client for .NET</description>
+ <inceptionYear>2022</inceptionYear>
<properties>
<maven.compiler.source>11</maven.compiler.source>
diff --git a/src/Proton.Client/Client/IConnection.cs
b/src/Proton.Client/Client/IConnection.cs
index ba34548..7fab12d 100644
--- a/src/Proton.Client/Client/IConnection.cs
+++ b/src/Proton.Client/Client/IConnection.cs
@@ -44,7 +44,7 @@ namespace Apache.Qpid.Proton.Client
/// exceeds the configure close timeout the method returns after
cleaning up the
/// connection resources.
/// </summary>
- /// <param name="error">Optional error condition to convery to the
remote</param>
+ /// <param name="error">Optional error condition to convey to the
remote</param>
void Close(IErrorCondition error = null);
/// <summary>
@@ -53,7 +53,7 @@ namespace Apache.Qpid.Proton.Client
/// operation. If the response from the remote exceeds the configure
close timeout
/// the connection will be cleaned up and the Task signalled indicating
completion.
/// </summary>
- /// <param name="error">Optional error condition to convery to the
remote</param>
+ /// <param name="error">Optional error condition to convey to the
remote</param>
Task<IConnection> CloseAsync(IErrorCondition error = null);
/// <summary>
diff --git a/src/Proton.Client/Client/ILink.cs
b/src/Proton.Client/Client/ILink.cs
index 29e8e80..6c16c0a 100644
--- a/src/Proton.Client/Client/ILink.cs
+++ b/src/Proton.Client/Client/ILink.cs
@@ -49,7 +49,7 @@ namespace Apache.Qpid.Proton.Client
/// exceeds the configure close timeout the method returns after
cleaning up the
/// link resources.
/// </summary>
- /// <param name="error">Optional error condition to convery to the
remote</param>
+ /// <param name="error">Optional error condition to convey to the
remote</param>
void Close(IErrorCondition error = null);
/// <summary>
@@ -58,7 +58,7 @@ namespace Apache.Qpid.Proton.Client
/// exceeds the configure close timeout the method returns after
cleaning up the
/// link resources.
/// </summary>
- /// <param name="error">Optional error condition to convery to the
remote</param>
+ /// <param name="error">Optional error condition to convey to the
remote</param>
void Detach(IErrorCondition error = null);
/// <summary>
@@ -148,7 +148,7 @@ namespace Apache.Qpid.Proton.Client
/// operation. If the response from the remote exceeds the configure
close timeout
/// the sender will be cleaned up and the Task signalled indicating
completion.
/// </summary>
- /// <param name="error">Optional error condition to convery to the
remote</param>
+ /// <param name="error">Optional error condition to convey to the
remote</param>
Task<Role> CloseAsync(IErrorCondition error = null);
/// <summary>
@@ -157,7 +157,7 @@ namespace Apache.Qpid.Proton.Client
/// operation. If the response from the remote exceeds the configure
close timeout
/// the sender will be cleaned up and the Task signalled indicating
completion.
/// </summary>
- /// <param name="error">Optional error condition to convery to the
remote</param>
+ /// <param name="error">Optional error condition to convey to the
remote</param>
Task<Role> DetachAsync(IErrorCondition error = null);
}
diff --git a/src/Proton.Client/Client/IMessage.cs
b/src/Proton.Client/Client/IMessage.cs
index cc3c3d4..84a7476 100644
--- a/src/Proton.Client/Client/IMessage.cs
+++ b/src/Proton.Client/Client/IMessage.cs
@@ -89,7 +89,7 @@ namespace Apache.Qpid.Proton.Client
#region Conversion helper to Advanced Message handling
/// <summary>
- /// Safely converts this message to an advacned message instance which
allows lower level
+ /// Safely converts this message to an advanced message instance which
allows lower level
/// access to AMQP message constructs.
///
/// The default implementation first checks if the current instance is
already of the correct
@@ -334,7 +334,7 @@ namespace Apache.Qpid.Proton.Client
/// <summary>
/// Checks if the message carries any message properties.
/// </summary>
- /// <returns>true if the message instance carries any propties</returns>
+ /// <returns>true if the message instance carries any
properties</returns>
bool HasProperties { get; }
/// <summary>
diff --git a/src/Proton.Client/Client/IReceiver.cs
b/src/Proton.Client/Client/IReceiver.cs
index 79637b5..52fb86a 100644
--- a/src/Proton.Client/Client/IReceiver.cs
+++ b/src/Proton.Client/Client/IReceiver.cs
@@ -59,7 +59,7 @@ namespace Apache.Qpid.Proton.Client
/// Receive calls will only grant credit on their own if a credit window
is configured in the options
/// which by default will have been configured. If the client
application has not configured a credit
/// window then this method won't grant or extend the credit window but
will wait for a delivery
- /// regardless. The application needs to arrage for credit to be granted
in that case.
+ /// regardless. The application needs to arrange for credit to be
granted in that case.
/// </remarks>
/// <returns>The next available delivery</returns>
IDelivery Receive();
@@ -72,7 +72,7 @@ namespace Apache.Qpid.Proton.Client
/// Receive calls will only grant credit on their own if a credit window
is configured in the options
/// which by default will have been configured. If the client
application has not configured a credit
/// window then this method won't grant or extend the credit window but
will wait for a delivery
- /// regardless. The application needs to arrage for credit to be granted
in that case.
+ /// regardless. The application needs to arrange for credit to be
granted in that case.
/// </remarks>
/// <returns>The next available delivery or null if the time span
elapses</returns>
IDelivery Receive(TimeSpan timeout);
@@ -93,13 +93,13 @@ namespace Apache.Qpid.Proton.Client
/// Receive calls will only grant credit on their own if a credit window
is configured in the options
/// which by default will have been configured. If the client
application has not configured a credit
/// window then this method won't grant or extend the credit window but
will wait for a delivery
- /// regardless. The application needs to arrage for credit to be granted
in that case.
+ /// regardless. The application needs to arrange for credit to be
granted in that case.
/// </remarks>
/// <returns>The next available delivery</returns>
Task<IDelivery> ReceiveAsync();
/// <summary>
- /// Asynchronous receive method that returns a Task that will be
completed afterthe specified time
+ /// Asynchronous receive method that returns a Task that will be
completed after the specified time
/// period if the remote to provides a delivery for consumption before
completing with null if none was
/// received.
/// </summary>
@@ -107,7 +107,7 @@ namespace Apache.Qpid.Proton.Client
/// Receive calls will only grant credit on their own if a credit window
is configured in the options
/// which by default will have been configured. If the client
application has not configured a credit
/// window then this method won't grant or extend the credit window but
will wait for a delivery
- /// regardless. The application needs to arrage for credit to be granted
in that case.
+ /// regardless. The application needs to arrange for credit to be
granted in that case.
/// </remarks>
/// <returns>The next available delivery or null if the time span
elapses</returns>
Task<IDelivery> ReceiveAsync(TimeSpan timeout);
diff --git a/src/Proton.Client/Client/ISession.cs
b/src/Proton.Client/Client/ISession.cs
index 392f9de..a3caf42 100644
--- a/src/Proton.Client/Client/ISession.cs
+++ b/src/Proton.Client/Client/ISession.cs
@@ -49,7 +49,7 @@ namespace Apache.Qpid.Proton.Client
/// exceeds the configure close timeout the method returns after
cleaning up the
/// session resources.
/// </summary>
- /// <param name="error">Optional error condition to convery to the
remote</param>
+ /// <param name="error">Optional error condition to convey to the
remote</param>
void Close(IErrorCondition error = null);
/// <summary>
@@ -58,7 +58,7 @@ namespace Apache.Qpid.Proton.Client
/// operation. If the response from the remote exceeds the configure
close timeout
/// the session will be cleaned up and the Task signalled indicating
completion.
/// </summary>
- /// <param name="error">Optional error condition to convery to the
remote</param>
+ /// <param name="error">Optional error condition to convey to the
remote</param>
Task<ISession> CloseAsync(IErrorCondition error = null);
/// <summary>
@@ -289,7 +289,7 @@ namespace Apache.Qpid.Proton.Client
/// <summary>
/// Asynchronously commit the currently active transaction in this
Session, the transaction
- /// cannot be considered retired until the Task has been compeleted.
+ /// cannot be considered retired until the Task has been completed.
/// <para>
/// Commit the currently active transaction in this Session but does not
start a new
/// transaction automatically. If there is no current transaction this
method fails the returned
diff --git a/src/Proton.Client/Client/IStreamReceiver.cs
b/src/Proton.Client/Client/IStreamReceiver.cs
index abe4d3f..8643fcb 100644
--- a/src/Proton.Client/Client/IStreamReceiver.cs
+++ b/src/Proton.Client/Client/IStreamReceiver.cs
@@ -34,7 +34,7 @@ namespace Apache.Qpid.Proton.Client
/// Receive calls will only grant credit on their own if a credit window
is configured in the options
/// which by default will have been configured. If the client
application has not configured a credit
/// window then this method won't grant or extend the credit window but
will wait for a delivery
- /// regardless. The application needs to arrage for credit to be granted
in that case.
+ /// regardless. The application needs to arrange for credit to be
granted in that case.
/// </remarks>
/// <returns>The next available delivery</returns>
IStreamDelivery Receive();
@@ -48,7 +48,7 @@ namespace Apache.Qpid.Proton.Client
/// Receive calls will only grant credit on their own if a credit window
is configured in the options
/// which by default will have been configured. If the client
application has not configured a credit
/// window then this method won't grant or extend the credit window but
will wait for a delivery
- /// regardless. The application needs to arrage for credit to be granted
in that case.
+ /// regardless. The application needs to arrange for credit to be
granted in that case.
/// </remarks>
IStreamDelivery Receive(TimeSpan timeout);
@@ -69,13 +69,13 @@ namespace Apache.Qpid.Proton.Client
/// Receive calls will only grant credit on their own if a credit window
is configured in the options
/// which by default will have been configured. If the client
application has not configured a credit
/// window then this method won't grant or extend the credit window but
will wait for a delivery
- /// regardless. The application needs to arrage for credit to be granted
in that case.
+ /// regardless. The application needs to arrange for credit to be
granted in that case.
/// </remarks>
/// <returns>The next available delivery</returns>
Task<IStreamDelivery> ReceiveAsync();
/// <summary>
- /// Asynchronous receive method that returns a Task that will be
completed afterthe specified time
+ /// Asynchronous receive method that returns a Task that will be
completed after the specified time
/// period if the remote to provides a delivery for consumption before
completing with null if none was
/// received. The returned task completes with a streamed delivery
instance that allows for consumption
/// or the incoming delivery as it arrives.
@@ -84,7 +84,7 @@ namespace Apache.Qpid.Proton.Client
/// Receive calls will only grant credit on their own if a credit window
is configured in the options
/// which by default will have been configured. If the client
application has not configured a credit
/// window then this method won't grant or extend the credit window but
will wait for a delivery
- /// regardless. The application needs to arrage for credit to be granted
in that case.
+ /// regardless. The application needs to arrange for credit to be
granted in that case.
/// </remarks>
/// <returns>The next available delivery or null if the time span
elapses</returns>
Task<IStreamDelivery> ReceiveAsync(TimeSpan timeout);
diff --git a/src/Proton.Client/Client/IStreamTracker.cs
b/src/Proton.Client/Client/IStreamTracker.cs
index fad3be8..7e89641 100644
--- a/src/Proton.Client/Client/IStreamTracker.cs
+++ b/src/Proton.Client/Client/IStreamTracker.cs
@@ -61,7 +61,7 @@ namespace Apache.Qpid.Proton.Client
/// <summary>
/// Settles the sent delivery if not performing auto-settlement on the
sender
/// and returns a Task that will be completed once any IO operations
required
- /// by the settlement have compelted.
+ /// by the settlement have completed.
/// </summary>
/// <returns>This tracker instance</returns>
Task<IStreamTracker> SettleAsync();
@@ -77,7 +77,7 @@ namespace Apache.Qpid.Proton.Client
/// <summary>
/// Apply the delivery state and optionally settle the sent delivery
with the remote.
/// The method returns a Task that will be completed once any required
IO operations
- /// in order to apply the dispostion have been completed.
+ /// in order to apply the disposition have been completed.
/// </summary>
/// <param name="state">The delivery state to apply to the sent
delivery</param>
/// <param name="settle">Optionally settle the delivery that was
sent</param>
diff --git a/src/Proton.Client/Client/ITracker.cs
b/src/Proton.Client/Client/ITracker.cs
index e576475..9e41f4f 100644
--- a/src/Proton.Client/Client/ITracker.cs
+++ b/src/Proton.Client/Client/ITracker.cs
@@ -59,7 +59,7 @@ namespace Apache.Qpid.Proton.Client
/// <summary>
/// Settles the sent delivery if not performing auto-settlement on the
sender
/// and returns a Task that will be completed once any IO operations
required
- /// by the settlement have compelted.
+ /// by the settlement have completed.
/// </summary>
/// <returns>This tracker instance</returns>
Task<ITracker> SettleAsync();
@@ -75,7 +75,7 @@ namespace Apache.Qpid.Proton.Client
/// <summary>
/// Apply the delivery state and optionally settle the sent delivery
with the remote.
/// The method returns a Task that will be completed once any required
IO operations
- /// in order to apply the dispostion have been completed.
+ /// in order to apply the disposition have been completed.
/// </summary>
/// <param name="state">The delivery state to apply to the sent
delivery</param>
/// <param name="settle">Optionally settle the delivery that was
sent</param>
diff --git a/src/Proton.Client/Client/ReconnectOptions.cs
b/src/Proton.Client/Client/ReconnectOptions.cs
index 120b974..0c273c7 100644
--- a/src/Proton.Client/Client/ReconnectOptions.cs
+++ b/src/Proton.Client/Client/ReconnectOptions.cs
@@ -34,7 +34,7 @@ namespace Apache.Qpid.Proton.Client
public static readonly bool DEFAULT_USE_RECONNECT_BACKOFF = true;
public static readonly double DEFAULT_RECONNECT_BACKOFF_MULTIPLIER =
2.0d;
- private readonly List<ReconnectLocation> reconnectLocations = new
List<ReconnectLocation>();
+ private readonly List<ReconnectLocation> reconnectLocations = new();
/// <summary>
/// Creates a default reconnect options instance.
diff --git a/src/Proton.Client/Client/SaslOptions.cs
b/src/Proton.Client/Client/SaslOptions.cs
index 3fbf73e..9920bc8 100644
--- a/src/Proton.Client/Client/SaslOptions.cs
+++ b/src/Proton.Client/Client/SaslOptions.cs
@@ -30,7 +30,7 @@ namespace Apache.Qpid.Proton.Client
/// </summary>
public static readonly bool DEFAULT_SASL_ENABLED = true;
- private readonly HashSet<string> allowedMechanisms = new
HashSet<string>();
+ private readonly HashSet<string> allowedMechanisms = new();
/// <summary>
/// Creates a default SASL options instance.
diff --git a/src/Proton.Client/Client/TransportOptions.cs
b/src/Proton.Client/Client/TransportOptions.cs
index eac578b..c070a09 100644
--- a/src/Proton.Client/Client/TransportOptions.cs
+++ b/src/Proton.Client/Client/TransportOptions.cs
@@ -30,7 +30,6 @@ namespace Apache.Qpid.Proton.Client
public static readonly uint DEFAULT_SO_TIMEOUT = 0;
public static readonly int DEFAULT_TCP_PORT = 5672;
public static readonly int DEFAULT_LOCAL_PORT = 0;
- public static readonly bool DEFAULT_USE_WEBSOCKETS = false;
public static readonly int DEFAULT_WEBSOCKET_MAX_FRAME_SIZE = 65535;
public static readonly bool DEFAULT_TRACE_BYTES = false;
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org
For additional commands, e-mail: commits-h...@qpid.apache.org
