From 8e51fb932a129c64ae753af7257d114697ded7ef Mon Sep 17 00:00:00 2001 From: Colin Sullivan Date: Mon, 7 Aug 2017 10:41:18 -0600 Subject: [PATCH] Bump to version 0.8.0 --- NATS.Client/Properties/AssemblyInfo.cs | 9 +- NATS.Client/project.json | 4 +- documentation/DoxyFile.NATS.Client | 2 +- documentation/NATS.Client/html/annotated.html | 63 +-- ..._1_client_1_1_conn_event_args-members.html | 2 +- ..._a_t_s_1_1_client_1_1_conn_event_args.html | 10 +- ...client_1_1_connection_factory-members.html | 2 +- ...t_s_1_1_client_1_1_connection_factory.html | 101 ++++- ...client_1_1_encoded_connection-members.html | 70 ++- ...t_s_1_1_client_1_1_encoded_connection.html | 348 +++++++++++++-- ...a_t_s_1_1_client_1_1_encoded_connection.js | 8 +- ..._t_s_1_1_client_1_1_encoded_connection.png | Bin 759 -> 1453 bytes ..._1_encoded_message_event_args-members.html | 2 +- ...client_1_1_encoded_message_event_args.html | 10 +- ...1_1_client_1_1_err_event_args-members.html | 2 +- ...n_a_t_s_1_1_client_1_1_err_event_args.html | 18 +- ...ss_n_a_t_s_1_1_client_1_1_msg-members.html | 2 +- .../class_n_a_t_s_1_1_client_1_1_msg.html | 37 +- ...nt_1_1_msg_handler_event_args-members.html | 2 +- ...1_1_client_1_1_msg_handler_event_args.html | 4 +- ..._s_bad_subscription_exception-members.html | 2 +- ..._1_n_a_t_s_bad_subscription_exception.html | 2 +- ...s_connection_closed_exception-members.html | 2 +- ...1_n_a_t_s_connection_closed_exception.html | 2 +- ..._n_a_t_s_connection_exception-members.html | 2 +- ...ient_1_1_n_a_t_s_connection_exception.html | 2 +- ..._client_1_1_n_a_t_s_exception-members.html | 2 +- ..._t_s_1_1_client_1_1_n_a_t_s_exception.html | 2 +- ..._a_t_s_max_messages_exception-members.html | 2 +- ...nt_1_1_n_a_t_s_max_messages_exception.html | 2 +- ...n_a_t_s_max_payload_exception-members.html | 2 +- ...ent_1_1_n_a_t_s_max_payload_exception.html | 2 +- ..._n_a_t_s_no_servers_exception-members.html | 2 +- ...ient_1_1_n_a_t_s_no_servers_exception.html | 2 +- ..._1_n_a_t_s_protocol_exception-members.html | 2 +- ...client_1_1_n_a_t_s_protocol_exception.html | 2 +- ...ecure_conn_required_exception-members.html | 2 +- ..._a_t_s_secure_conn_required_exception.html | 2 +- ..._secure_conn_wanted_exception-members.html | 2 +- ..._n_a_t_s_secure_conn_wanted_exception.html | 2 +- ...a_t_s_slow_consumer_exception-members.html | 2 +- ...t_1_1_n_a_t_s_slow_consumer_exception.html | 2 +- ..._s_stale_connection_exception-members.html | 2 +- ..._1_n_a_t_s_stale_connection_exception.html | 2 +- ...1_1_n_a_t_s_timeout_exception-members.html | 2 +- ..._client_1_1_n_a_t_s_timeout_exception.html | 2 +- ..._a_t_s_1_1_client_1_1_n_u_i_d-members.html | 2 +- .../class_n_a_t_s_1_1_client_1_1_n_u_i_d.html | 2 +- ..._a_t_s_1_1_client_1_1_options-members.html | 15 +- .../class_n_a_t_s_1_1_client_1_1_options.html | 135 +++++- .../class_n_a_t_s_1_1_client_1_1_options.js | 3 + documentation/NATS.Client/html/classes.html | 35 +- documentation/NATS.Client/html/functions.html | 416 +---------------- .../NATS.Client/html/functions_evnt.html | 5 +- .../NATS.Client/html/functions_func.html | 78 +++- .../NATS.Client/html/functions_prop.html | 60 ++- .../NATS.Client/html/functions_vars.html | 5 +- documentation/NATS.Client/html/hierarchy.html | 40 +- documentation/NATS.Client/html/hierarchy.js | 24 +- documentation/NATS.Client/html/index.html | 2 +- ...ient_1_1_i_async_subscription-members.html | 2 +- ...s_1_1_client_1_1_i_async_subscription.html | 16 +- ..._s_1_1_client_1_1_i_async_subscription.png | Bin 793 -> 1181 bytes ...s_1_1_client_1_1_i_connection-members.html | 2 +- ...e_n_a_t_s_1_1_client_1_1_i_connection.html | 260 +++++++---- ...ient_1_1_i_encoded_connection-members.html | 43 +- ...s_1_1_client_1_1_i_encoded_connection.html | 145 +++--- ...t_s_1_1_client_1_1_i_encoded_connection.js | 1 + ...s_1_1_client_1_1_i_statistics-members.html | 2 +- ...e_n_a_t_s_1_1_client_1_1_i_statistics.html | 15 +- ...1_1_client_1_1_i_subscription-members.html | 2 +- ...n_a_t_s_1_1_client_1_1_i_subscription.html | 102 +++-- ..._n_a_t_s_1_1_client_1_1_i_subscription.png | Bin 1088 -> 2904 bytes ...lient_1_1_i_sync_subscription-members.html | 2 +- ..._s_1_1_client_1_1_i_sync_subscription.html | 22 +- ...t_s_1_1_client_1_1_i_sync_subscription.png | Bin 782 -> 1147 bytes .../NATS.Client/html/namespace_n_a_t_s.html | 2 +- .../html/namespace_n_a_t_s_1_1_client.html | 51 ++- .../html/namespace_n_a_t_s_1_1_client.js | 7 +- .../NATS.Client/html/namespacemembers.html | 2 +- .../html/namespacemembers_enum.html | 2 +- .../html/namespacemembers_func.html | 2 +- .../NATS.Client/html/namespaces.html | 2 +- documentation/NATS.Client/html/navtreedata.js | 5 +- .../NATS.Client/html/navtreeindex0.js | 422 ++++++++++-------- .../NATS.Client/html/search/all_0.js | 3 +- .../NATS.Client/html/search/all_1.js | 14 +- .../NATS.Client/html/search/all_10.js | 3 +- .../NATS.Client/html/search/all_2.js | 8 +- .../NATS.Client/html/search/all_4.js | 2 +- .../NATS.Client/html/search/all_5.js | 4 +- .../NATS.Client/html/search/all_6.js | 10 +- .../NATS.Client/html/search/all_7.js | 2 +- .../NATS.Client/html/search/all_8.js | 8 +- .../NATS.Client/html/search/all_9.js | 4 +- .../NATS.Client/html/search/all_a.js | 10 +- .../NATS.Client/html/search/all_b.js | 10 +- .../NATS.Client/html/search/all_c.js | 4 +- .../NATS.Client/html/search/all_d.js | 9 +- .../NATS.Client/html/search/all_e.js | 23 +- .../NATS.Client/html/search/all_f.js | 3 +- .../NATS.Client/html/search/classes_0.js | 3 +- .../NATS.Client/html/search/classes_1.js | 6 +- .../NATS.Client/html/search/classes_2.js | 9 +- .../NATS.Client/html/search/classes_3.js | 8 +- .../NATS.Client/html/search/classes_4.js | 16 +- .../NATS.Client/html/search/classes_5.js | 15 +- .../NATS.Client/html/search/events_0.js | 2 +- .../NATS.Client/html/search/functions_0.js | 2 +- .../NATS.Client/html/search/functions_1.js | 4 +- .../NATS.Client/html/search/functions_2.js | 3 +- .../NATS.Client/html/search/functions_3.js | 2 +- .../NATS.Client/html/search/functions_4.js | 4 +- .../NATS.Client/html/search/functions_5.js | 4 +- .../NATS.Client/html/search/functions_7.js | 4 +- .../NATS.Client/html/search/functions_8.js | 2 +- .../NATS.Client/html/search/functions_9.js | 6 +- .../NATS.Client/html/search/functions_a.js | 8 +- .../NATS.Client/html/search/functions_b.js | 3 +- .../NATS.Client/html/search/functions_c.js | 2 +- .../NATS.Client/html/search/properties_1.js | 6 +- .../NATS.Client/html/search/properties_2.js | 6 +- .../NATS.Client/html/search/properties_4.js | 6 +- .../NATS.Client/html/search/properties_5.js | 2 +- .../NATS.Client/html/search/properties_6.js | 6 +- .../NATS.Client/html/search/properties_8.js | 10 +- .../NATS.Client/html/search/properties_9.js | 8 +- .../NATS.Client/html/search/properties_a.js | 4 +- .../NATS.Client/html/search/properties_b.js | 2 +- .../NATS.Client/html/search/properties_c.js | 11 +- .../NATS.Client/html/search/properties_e.js | 1 + .../NATS.Client/html/search/searchdata.js | 19 +- .../NATS.Client/html/search/variables_6.js | 2 +- nuget/NATS.Client.nuspec | 4 +- 134 files changed, 1760 insertions(+), 1226 deletions(-) diff --git a/NATS.Client/Properties/AssemblyInfo.cs b/NATS.Client/Properties/AssemblyInfo.cs index 837cb1eb6..e8aeb644d 100755 --- a/NATS.Client/Properties/AssemblyInfo.cs +++ b/NATS.Client/Properties/AssemblyInfo.cs @@ -1,7 +1,6 @@ -// Copyright 2015 Apcera Inc. All rights reserved. +// Copyright 2015-2017 Apcera Inc. All rights reserved. using System.Reflection; -using System.Runtime.CompilerServices; using System.Runtime.InteropServices; // General Information about an assembly is controlled through the following @@ -12,7 +11,7 @@ [assembly: AssemblyConfiguration("")] [assembly: AssemblyCompany("Apcera, Inc.")] [assembly: AssemblyProduct("NATS")] -[assembly: AssemblyCopyright("Copyright © Apcera 2016")] +[assembly: AssemblyCopyright("Copyright © Apcera 2017")] [assembly: AssemblyTrademark("")] [assembly: AssemblyCulture("")] @@ -34,5 +33,5 @@ // You can specify all the values or you can default the Build and Revision Numbers // by using the '*' as shown below: // [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("0.7.1.0")] -[assembly: AssemblyFileVersion("0.7.1.0")] +[assembly: AssemblyVersion("0.8.0.0")] +[assembly: AssemblyFileVersion("0.8.0.0")] diff --git a/NATS.Client/project.json b/NATS.Client/project.json index e82808ba3..3bca13dd0 100755 --- a/NATS.Client/project.json +++ b/NATS.Client/project.json @@ -1,8 +1,8 @@ { "description": "NATS Client API", - "copyright": "Copyright © Apcera 2016", + "copyright": "Copyright © Apcera 2017", "title": "NATS Client", - "version": "0.7.1-*", + "version": "0.8.0-*", "dependencies": { "NETStandard.Library": "1.6.0", "System.Net.Security": "4.0.0", diff --git a/documentation/DoxyFile.NATS.Client b/documentation/DoxyFile.NATS.Client index 1618eed99..eacaeb7dc 100755 --- a/documentation/DoxyFile.NATS.Client +++ b/documentation/DoxyFile.NATS.Client @@ -38,7 +38,7 @@ PROJECT_NAME = "NATS .NET Client" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.7.0 +PROJECT_NUMBER = 0.8.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/documentation/NATS.Client/html/annotated.html b/documentation/NATS.Client/html/annotated.html index 48f7363d0..bf687a33d 100755 --- a/documentation/NATS.Client/html/annotated.html +++ b/documentation/NATS.Client/html/annotated.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -115,34 +115,39 @@
[detail level 123]
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼NNATS
 ▼NClient
 CConnectionFactoryCreates a connection to the NATS server.
 CConnEventArgsEvent arguments for the ConnEventHandler type delegate.
 CEncodedConnectionThis class subclasses the Connection class to support serialization.
 CEncodedMessageEventArgsEvent arguments for the EncodedConnection Asynchronous Subscriber delegate.
 CErrEventArgsEvent arguments for the ErrorEventHandler type delegate.
 CIAsyncSubscriptionAn object of this class is an asynchronous subscription representing interest in a subject. The subject can have wildcards (partial:*, full:>). Messages will be delivered to the associated MessageHandler event delegates. While nothing prevents event handlers from being added or removed while processing messages. If the subscriber was created without providing a handler, no messages will be received until Start() has been called. This allows event handlers to be added before message processing begins.
 CIConnectionRepresents the connection to the NATS server.
 CIEncodedConnectionRepresents an encoded connection to the NATS server.
 CIStatisticsTracks various statistics received and sent on this connection.
 CISubscriptionRepresents interest in a NATS topic.
 CISyncSubscriptionA Syncronous Subscripion will express interest in a given subject. The subject can have wildcards (partial:*, full:>). Messages arriving are retrieved via NextMsg()
 CMsgA NATS message is an object encapsulating a subject, optional reply payload, and subscription information, sent or received by teh client application.
 CMsgHandlerEventArgsThis class is passed into the MsgHandler delegate, providing the message received.
 CNATSBadSubscriptionExceptionThe exception that is thrown when a subscriber operation is performed on an invalid subscriber.
 CNATSConnectionClosedExceptionThe exception that is thrown when a an operation is performed on a connection that is closed.
 CNATSConnectionExceptionThe exception that is thrown when there is a connection error.
 CNATSExceptionThe exception that is thrown when there is a NATS error condition. All NATS exception inherit from this class.
 CNATSMaxMessagesExceptionThe exception that is thrown when a subscriber has exceeded the maximum number of messages that has been configured.
 CNATSMaxPayloadExceptionThe exception that is thrown when a message payload exceeds what the maximum configured.
 CNATSNoServersExceptionThe exception that is thrown when a connection cannot be made to any server.
 CNATSProtocolExceptionThis exception that is thrown when there is an internal error with the NATS protocol.
 CNATSSecureConnRequiredExceptionThe exception that is thrown when a secure connection is required.
 CNATSSecureConnWantedExceptionThe exception that is thrown when a secure connection is requested, but not required.
 CNATSSlowConsumerExceptionThe exception that is thrown when a consumer (subscription) is slow.
 CNATSStaleConnectionExceptionThe exception that is thrown when an operation occurs on a connection that has been determined to be stale.
 CNATSTimeoutExceptionThe exception that is thrown when a NATS operation times out.
 CNUIDNUID needs to be very fast to generate and truly unique, all while being entropy pool friendly. We will use 12 bytes of crypto generated data (entropy draining), and 10 bytes of sequential data that is started at a pseudo random number and increments with a pseudo-random increment. Total is 22 bytes of base 36 ascii text.
 COptionsThis class is used to setup all NATs client options.
 CAsyncSubscriptionAsyncSubscription asynchronously delivers messages to listeners of the MessageHandler event. This class should not be used directly.
 CConnectionConnection represents a bare connection to a NATS server. Users should create an IConnection instance using ConnectionFactory rather than directly using this class.
 CConnectionFactoryProvides factory methods to create connections to NATS Servers.
 CConnEventArgsProvides the details when the state of a Connection changes.
 CEncodedConnectionRepresents an Connection which uses a client specified encoding scheme.
 CEncodedMessageEventArgsProvides decoded messages received by subscriptions or requests.
 CErrEventArgsProvides details for an error encountered asynchronously by an IConnection.
 CIAsyncSubscriptionIAsyncSubscription asynchronously delivers messages to listeners of the MessageHandler event.
 CIConnectionRepresents a connection to the NATS server.
 CIEncodedConnectionRepresents a connection to a NATS Server which uses a client specified encoding scheme.
 CIStatisticsTracks various statistics received and sent on an IConnection.
 CISubscriptionRepresents interest in a NATS topic.
 CISyncSubscriptionISyncSubscription provides messages for a subject through calls to NextMessage() and NextMessage(int).
 CMsgA NATS message is an object encapsulating a subject, optional reply payload, and subscription information, sent or received by the client application.
 CMsgHandlerEventArgsProvides the message received by an IAsyncSubscription.
 CNATSBadSubscriptionExceptionThe exception that is thrown when a subscriber operation is performed on an invalid subscriber.
 CNATSConnectionClosedExceptionThe exception that is thrown when a an operation is performed on a connection that is closed.
 CNATSConnectionExceptionThe exception that is thrown when there is a connection error.
 CNATSExceptionThe exception that is thrown when there is a NATS error condition. All NATS exception inherit from this class.
 CNATSMaxMessagesExceptionThe exception that is thrown when a subscriber has exceeded the maximum number of messages that has been configured.
 CNATSMaxPayloadExceptionThe exception that is thrown when a message payload exceeds what the maximum configured.
 CNATSNoServersExceptionThe exception that is thrown when a connection cannot be made to any server.
 CNATSProtocolExceptionThis exception that is thrown when there is an internal error with the NATS protocol.
 CNATSSecureConnRequiredExceptionThe exception that is thrown when a secure connection is required.
 CNATSSecureConnWantedExceptionThe exception that is thrown when a secure connection is requested, but not required.
 CNATSSlowConsumerExceptionThe exception that is thrown when a consumer (subscription) is slow.
 CNATSStaleConnectionExceptionThe exception that is thrown when an operation occurs on a connection that has been determined to be stale.
 CNATSTimeoutExceptionThe exception that is thrown when a NATS operation times out.
 CNUIDNUID needs to be very fast to generate and truly unique, all while being entropy pool friendly. We will use 12 bytes of crypto generated data (entropy draining), and 10 bytes of sequential data that is started at a pseudo random number and increments with a pseudo-random increment. Total is 22 bytes of base 36 ascii text.
 COptionsThis class is used to setup all NATs client options.
 CStatisticsTracks various statistics received and sent on an IConnection.
 CSubscriptionRepresents interest in a NATS topic. This class should not be used directly.
 CSyncSubscriptionSyncSubscription provides messages for a subject through calls to NextMessage() and NextMessage(int). This class should not be used directly.
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_conn_event_args-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_conn_event_args-members.html index a72270b87..433cc9854 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_conn_event_args-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_conn_event_args-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_conn_event_args.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_conn_event_args.html index f235cc22b..2b1dd4580 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_conn_event_args.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_conn_event_args.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -119,11 +119,11 @@ - +

Properties

Connection Conn [get]
Connection Conn [get]
 

Detailed Description

-

Event arguments for the ConnEventHandler type delegate.

+

Provides the details when the state of a Connection changes.

Property Documentation

@@ -133,7 +133,7 @@ - +
Connection NATS.Client.ConnEventArgs.ConnConnection NATS.Client.ConnEventArgs.Conn
@@ -143,7 +143,7 @@
-

Gets the connection associated with the event.

+

Gets the Connection associated with the event.

diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_connection_factory-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_connection_factory-members.html index 8af7ab9d2..51bf6ab5a 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_connection_factory-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_connection_factory-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_connection_factory.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_connection_factory.html index 76f7f10fd..11e940a27 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_connection_factory.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_connection_factory.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -141,7 +141,7 @@  

Detailed Description

-

Creates a connection to the NATS server.

+

Provides factory methods to create connections to NATS Servers.

Constructor & Destructor Documentation

@@ -156,7 +156,7 @@
-

Creates a connection factory to the NATS server.

+

Initializes a new instance of the ConnectionFactory class, providing factory methods to create connections to NATS Servers.

@@ -175,14 +175,22 @@

Member Function Documentation

-

CreateConnection will attempt to connect to the NATS server. The url can contain username/password semantics. Comma seperated arrays are also supported, e.g. urlA, urlB.

+

Attempt to connect to the NATS server referenced by url .

+

url can contain username/password semantics. Comma seperated arrays are also supported, e.g. "urlA, urlB".

Parameters
- + +
urlThe url
urlA string containing the URL (or URLs) to the NATS Server. See the Remarks section for more information.
+
+
+
Returns
An IConnection object connected to the NATS server.
+
Exceptions
+ + +
NATSNoServersExceptionNo connection to a NATS Server could be established.
NATSConnectionExceptionA timeout occurred connecting to a NATS Server.-or-An exception was encountered while connecting to a NATS Server. See System.Exception.InnerException for more details.
-
Returns
A new connection to the NATS server
@@ -199,8 +207,16 @@

Member Function Documentation

-

Create a connection to the NATs server using default options.

-
Returns
A new connection to the NATS server
+

Create a connection to the NATs server using the default options.

+
Returns
An IConnection object connected to the NATS server.
+
Exceptions
+ + + +
NATSNoServersExceptionNo connection to a NATS Server could be established.
NATSConnectionExceptionA timeout occurred connecting to a NATS Server.-or-An exception was encountered while connecting to a NATS Server. See System.Exception.InnerException for more details.
+
+
+
See also
GetDefaultOptions
@@ -218,14 +234,21 @@

Member Function Documentation

-

CreateConnection to the NATs server using the provided options.

+

Create a connection to a NATS Server defined by the given options.

Parameters
- + +
optsNATs client options
optsThe NATS client options to use for this connection.
+
+
+
Returns
An IConnection object connected to the NATS server.
+
Exceptions
+ + +
NATSNoServersExceptionNo connection to a NATS Server could be established.
NATSConnectionExceptionA timeout occurred connecting to a NATS Server.-or-An exception was encountered while connecting to a NATS Server. See System.Exception.InnerException for more details.
-
Returns
A new connection to the NATS server
@@ -242,8 +265,16 @@

Member Function Documentation

-

Create an encoded connection to the NATs server using default options.

-
Returns
A new connection to the NATS server
+

Attempt to connect to the NATS server, with an encoded connection, using the default options.

+
Returns
An IEncodedConnection object connected to the NATS server.
+
See also
GetDefaultOptions
+
Exceptions
+ + + +
NATSNoServersExceptionNo connection to a NATS Server could be established.
NATSConnectionExceptionA timeout occurred connecting to a NATS Server.-or-An exception was encountered while connecting to a NATS Server. See System.Exception.InnerException for more details.
+
+
@@ -261,14 +292,22 @@

Member Function Documentation

-

CreateEncodeedConnection will attempt to connect to the NATS server. The url can contain username/password semantics.

+

Attempt to connect to the NATS server, with an encoded connection, referenced by url .

+

url can contain username/password semantics. Comma seperated arrays are also supported, e.g. urlA, urlB.

Parameters
- + +
urlThe url
urlA string containing the URL (or URLs) to the NATS Server. See the Remarks section for more information.
+
+
+
Returns
An IEncodedConnection object connected to the NATS server.
+
Exceptions
+ + +
NATSNoServersExceptionNo connection to a NATS Server could be established.
NATSConnectionExceptionA timeout occurred connecting to a NATS Server.-or-An exception was encountered while connecting to a NATS Server. See System.Exception.InnerException for more details.
-
Returns
A new connection to the NATS server
@@ -286,14 +325,21 @@

Member Function Documentation

-

CreateEncodedConnection to the NATs server using the provided options.

+

Attempt to connect to the NATS server, with an encoded connection, using the given options.

Parameters
- + +
optsNATs client options
optsThe NATS client options to use for this connection.
+
+
+
Returns
An IEncodedConnection object connected to the NATS server.
+
Exceptions
+ + +
NATSNoServersExceptionNo connection to a NATS Server could be established.
NATSConnectionExceptionA timeout occurred connecting to a NATS Server.-or-An exception was encountered while connecting to a NATS Server. See System.Exception.InnerException for more details.
-
Returns
A new connection to the NATS server
@@ -311,14 +357,22 @@

Member Function Documentation

-

CreateSecureConnection will attempt to connect to the NATS server using TLS. The url can contain username/password semantics.

+

Attempt to connect to the NATS server using TLS referenced by url .

+

url can contain username/password semantics. Comma seperated arrays are also supported, e.g. urlA, urlB.

Parameters
- + +
urlconnect url
urlA string containing the URL (or URLs) to the NATS Server. See the Remarks section for more information.
+
+
+
Returns
An IConnection object connected to the NATS server.
+
Exceptions
+ + +
NATSNoServersExceptionNo connection to a NATS Server could be established.
NATSConnectionExceptionA timeout occurred connecting to a NATS Server.-or-An exception was encountered while connecting to a NATS Server. See System.Exception.InnerException for more details.
-
Returns
A new connection to the NATS server
@@ -343,7 +397,8 @@

Member Function Documentation

-

Retrieves the default set ot client options.

+

Retrieves the default set of client options.

+
Returns
The default Options object for the NATS client.
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_encoded_connection-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_encoded_connection-members.html index f28ac204b..fc264b467 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_encoded_connection-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_encoded_connection-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -114,27 +114,65 @@

This is the complete list of members for NATS.Client.EncodedConnection, including all inherited members.

- + + + - - - + + + + + + + + + + + - + + + - + + + - - - - - + + + + + + + + + + + + + + + + + + + - + + + - - - + + + + + + + + + + +
NATS::Client::IEncodedConnection.Close()NATS.Client.IEncodedConnection
NATS::Client::Connection.Close()NATS.Client.Connection
NATS::Client::IEncodedConnection.Close()NATS.Client.IEncodedConnection
NATS::Client::Connection.ConnectedIdNATS.Client.Connection
NATS::Client::IEncodedConnection.ConnectedIdNATS.Client.IEncodedConnection
NATS::Client::IEncodedConnection.ConnectedUrlNATS.Client.IEncodedConnection
NATS::Client::IEncodedConnection.Flush(int timeout)NATS.Client.IEncodedConnection
NATS::Client::IEncodedConnection.Flush()NATS.Client.IEncodedConnection
NATS::Client::Connection.ConnectedUrlNATS.Client.Connection
NATS::Client::IEncodedConnection.ConnectedUrlNATS.Client.IEncodedConnection
NATS::Client::Connection.DiscoveredServersNATS.Client.Connection
NATS::Client::IEncodedConnection.DiscoveredServersNATS.Client.IEncodedConnection
Dispose(bool disposing)NATS.Client.EncodedConnectionprotectedvirtual
NATS::Client::Connection.Dispose()NATS.Client.Connection
NATS::Client::Connection.Flush(int timeout)NATS.Client.Connection
NATS::Client::Connection.Flush()NATS.Client.Connection
NATS::Client::IEncodedConnection.Flush(int timeout)NATS.Client.IEncodedConnection
NATS::Client::IEncodedConnection.Flush()NATS.Client.IEncodedConnection
NATS::Client::Connection.IsClosed()NATS.Client.Connection
NATS::Client::IEncodedConnection.IsClosed()NATS.Client.IEncodedConnection
NATS::Client::IEncodedConnection.IsReconnecting()NATS.Client.IEncodedConnection
NATS::Client::Connection.IsReconnecting()NATS.Client.Connection
NATS::Client::IEncodedConnection.IsReconnecting()NATS.Client.IEncodedConnection
NATS::Client::Connection.LastErrorNATS.Client.Connection
NATS::Client::IEncodedConnection.LastErrorNATS.Client.IEncodedConnection
NATS::Client::IEncodedConnection.MaxPayloadNATS.Client.IEncodedConnection
NATS::Client::Connection.MaxPayloadNATS.Client.Connection
NATS::Client::IEncodedConnection.MaxPayloadNATS.Client.IEncodedConnection
NATS::Client::Connection.NewInbox()NATS.Client.Connection
NATS::Client::IEncodedConnection.NewInbox()NATS.Client.IEncodedConnection
NATS::Client::IEncodedConnection.OptsNATS.Client.IEncodedConnection
Publish(string subject, string reply, object o)NATS.Client.EncodedConnection
NATS::Client::IEncodedConnection.Publish(string subject, object obj)NATS.Client.IEncodedConnection
Request(string subject, object obj, int timeout)NATS.Client.EncodedConnection
Request(string subject, object obj)NATS.Client.EncodedConnection
OnDeserializeNATS.Client.EncodedConnection
OnSerializeNATS.Client.EncodedConnection
NATS::Client::Connection.OptsNATS.Client.Connection
NATS::Client::IEncodedConnection.OptsNATS.Client.IEncodedConnection
Publish(string subject, Object obj)NATS.Client.EncodedConnection
Publish(string subject, string reply, object obj)NATS.Client.EncodedConnection
NATS::Client::Connection.Publish(string subject, byte[] data)NATS.Client.Connection
NATS::Client::Connection.Publish(Msg msg)NATS.Client.Connection
NATS::Client::Connection.Publish(string subject, string reply, byte[] data)NATS.Client.Connection
NATS::Client::IEncodedConnection.Publish(string subject, object obj)NATS.Client.IEncodedConnection
Request(string subject, object obj, int timeout)NATS.Client.EncodedConnection
Request(string subject, object obj)NATS.Client.EncodedConnection
NATS::Client::Connection.Request(string subject, byte[] data, int timeout)NATS.Client.Connection
NATS::Client::Connection.Request(string subject, byte[] data)NATS.Client.Connection
RequestAsync(string subject, byte[] data, int timeout)NATS.Client.Connection
RequestAsync(string subject, byte[] data)NATS.Client.Connection
RequestAsync(string subject, byte[] data, int timeout, CancellationToken token)NATS.Client.Connection
RequestAsync(string subject, byte[] data, CancellationToken token)NATS.Client.Connection
NATS::Client::Connection.ResetStats()NATS.Client.Connection
NATS::Client::IEncodedConnection.ResetStats()NATS.Client.IEncodedConnection
NATS::Client::IEncodedConnection.ServersNATS.Client.IEncodedConnection
NATS::Client::Connection.ServersNATS.Client.Connection
NATS::Client::IEncodedConnection.ServersNATS.Client.IEncodedConnection
NATS::Client::Connection.StateNATS.Client.Connection
NATS::Client::IEncodedConnection.StateNATS.Client.IEncodedConnection
NATS::Client::IEncodedConnection.StatsNATS.Client.IEncodedConnection
SubscribeAsync(string subject, EventHandler< EncodedMessageEventArgs > handler)NATS.Client.EncodedConnection
SubscribeAsync(string subject, string queue, EventHandler< EncodedMessageEventArgs > handler)NATS.Client.EncodedConnection
NATS::Client::Connection.StatsNATS.Client.Connection
NATS::Client::IEncodedConnection.StatsNATS.Client.IEncodedConnection
SubscribeAsync(string subject, EventHandler< EncodedMessageEventArgs > handler)NATS.Client.EncodedConnection
SubscribeAsync(string subject, string queue, EventHandler< EncodedMessageEventArgs > handler)NATS.Client.EncodedConnection
NATS::Client::Connection.SubscribeAsync(string subject)NATS.Client.Connection
NATS::Client::Connection.SubscribeAsync(string subject, EventHandler< MsgHandlerEventArgs > handler)NATS.Client.Connection
NATS::Client::Connection.SubscribeAsync(string subject, string queue)NATS.Client.Connection
NATS::Client::Connection.SubscribeAsync(string subject, string queue, EventHandler< MsgHandlerEventArgs > handler)NATS.Client.Connection
SubscribeSync(string subject)NATS.Client.Connection
SubscribeSync(string subject, string queue)NATS.Client.Connection
ToString()NATS.Client.Connection
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_encoded_connection.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_encoded_connection.html index 96acca083..19da5c041 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_encoded_connection.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_encoded_connection.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -109,6 +109,8 @@
Public Member Functions | +Protected Member Functions | +Properties | List of all members
NATS.Client.EncodedConnection Class Reference
@@ -120,14 +122,18 @@
-NATS.Client.IEncodedConnection +NATS.Client.Connection +NATS.Client.IEncodedConnection +NATS.Client.IConnection
- - + + + + @@ -136,6 +142,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -154,8 +209,55 @@

Public Member Functions

void Publish (string subject, string reply, object o)
 
void Publish (string subject, Object obj)
 
void Publish (string subject, string reply, object obj)
 
IAsyncSubscription SubscribeAsync (string subject, EventHandler< EncodedMessageEventArgs > handler)
 
IAsyncSubscription SubscribeAsync (string subject, string queue, EventHandler< EncodedMessageEventArgs > handler)
 
object Request (string subject, object obj)
 
- Public Member Functions inherited from NATS.Client.Connection
void Publish (string subject, byte[] data)
 
void Publish (Msg msg)
 
void Publish (string subject, string reply, byte[] data)
 
Msg Request (string subject, byte[] data, int timeout)
 
Msg Request (string subject, byte[] data)
 
Task< Msg > RequestAsync (string subject, byte[] data, int timeout)
 
Task< Msg > RequestAsync (string subject, byte[] data)
 
Task< Msg > RequestAsync (string subject, byte[] data, int timeout, CancellationToken token)
 
Task< Msg > RequestAsync (string subject, byte[] data, CancellationToken token)
 
string NewInbox ()
 
ISyncSubscription SubscribeSync (string subject)
 
IAsyncSubscription SubscribeAsync (string subject)
 
IAsyncSubscription SubscribeAsync (string subject, EventHandler< MsgHandlerEventArgs > handler)
 
ISyncSubscription SubscribeSync (string subject, string queue)
 
IAsyncSubscription SubscribeAsync (string subject, string queue)
 
IAsyncSubscription SubscribeAsync (string subject, string queue, EventHandler< MsgHandlerEventArgs > handler)
 
void Flush (int timeout)
 
void Flush ()
 
void Close ()
 
bool IsClosed ()
 
bool IsReconnecting ()
 
void ResetStats ()
 
override string ToString ()
 
void Dispose ()
 
- Public Member Functions inherited from NATS.Client.IEncodedConnection
void Publish (string subject, object obj)
 
void ResetStats ()
 
- + + + +

-Additional Inherited Members

+Protected Member Functions

override void Dispose (bool disposing)
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -165,6 +267,8 @@ + + @@ -179,9 +283,88 @@

+Properties

Serializer OnSerialize [get, set]
 
Deserializer OnDeserialize [get, set]
 
- Properties inherited from NATS.Client.Connection
Options Opts [get]
 
string ConnectedUrl [get]
 
string ConnectedId [get]
 
string[] Servers [get]
 
string[] DiscoveredServers [get]
 
Exception LastError [get]
 
ConnState State [get]
 
IStatistics Stats [get]
 
long MaxPayload [get]
 
- Properties inherited from NATS.Client.IConnection
Options Opts [get]
 
string ConnectedUrl [get]
 
string ConnectedId [get]
 
string[] Servers [get]
 
string[] DiscoveredServers [get]
 
Exception LastError [get]
 
ConnState State [get]
 
IStatistics Stats [get]
 
long MaxPayload [get]
 
- Properties inherited from NATS.Client.IEncodedConnection
Options Opts [get]
 
 
string[] Servers [get]
 
string[] DiscoveredServers [get]
 
Exception LastError [get]
 
ConnState State [get]
 

Detailed Description

-

This class subclasses the Connection class to support serialization.

+

Represents an Connection which uses a client specified encoding scheme.

Member Function Documentation

- + +
+
+ + + + + +
+ + + + + + + + +
override void NATS.Client.EncodedConnection.Dispose (bool disposing)
+ 		+protectedvirtual
+
+ +

Closes the EncodedConnection and optionally releases the managed resources.

+
Parameters
+ + +
disposingtrue to release both managed and unmanaged resources; false to release only unmanaged resources.
+
+
+ +

Reimplemented from NATS.Client.Connection.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void NATS.Client.EncodedConnection.Publish (string subject,
Object obj 
)
+
+ +

Publishes the serialized value of obj to the given subject .

+
Parameters
+ + + +
subjectThe subject to publish obj to over the current connection.
objThe Object to serialize and publish to the connected NATS server.
+
+
+
Exceptions
+ + + + + + +
NATSBadSubscriptionExceptionsubject is null or entirely whitespace.
NATSMaxPayloadExceptionThe serialzed form of obj exceeds the maximum payload size supported by the NATS server.
NATSConnectionClosedExceptionThe Connection is closed.
NATSExceptionOnSerialize is null.-or-There was an unexpected exception performing an internal NATS call while publishing. See System.Exception.InnerException for more details.
IOExceptionThere was a failure while writing to the network.
+
+
+ +
+
+
@@ -211,12 +394,22 @@
-

Publish will perform a Publish() expecting a response on the reply subject. Use Request() for automatically waiting for a response inline.

+

Publishes the serialized value of obj to the given subject .

Parameters
- - - + + + +
subjectSubject to publish on
replySubject the receiver will on.
objThe object to send
subjectThe subject to publish obj to over the current connection.
replyAn optional reply subject.
objThe Object to serialize and publish to the connected NATS server.
+
+
+
Exceptions
+ + + + + +
NATSBadSubscriptionExceptionsubject is null or entirely whitespace.
NATSMaxPayloadExceptionThe serialzed form of obj exceeds the maximum payload size supported by the NATS server.
NATSConnectionClosedExceptionThe Connection is closed.
NATSExceptionOnSerialize is null.-or-There was an unexpected exception performing an internal NATS call while publishing. See System.Exception.InnerException for more details.
IOExceptionThere was a failure while writing to the network.
@@ -255,17 +448,29 @@
-

Request will create an Inbox and perform a Request() call with the Inbox reply and return the first reply received. This is optimized for the case of multiple responses.

-

A negative timeout blocks forever, zero is not allowed.

+

Sends a request payload and returns the deserialized response, or throws NATSTimeoutException if the timeout expires.

+

Request(string, object, int) will create an unique inbox for this request, sharing a single subscription for all replies to this IEncodedConnection instance. However, if Options.UseOldRequestStyle is set, each request will have its own underlying subscription. The old behavior is not recommended as it may cause unnecessary overhead on connected NATS servers.

Parameters
- - - + + + +
subjectSubject to send the request on.
objThe object to send
timeouttime to block
subjectThe subject to publish obj to over the current connection.
objThe Object to serialize and publish to the connected NATS server.
timeoutThe number of milliseconds to wait.
+
+
+
Returns
A Object with the deserialized response from the NATS server.
+
Exceptions
+ + + + + + + +
ArgumentOutOfRangeExceptiontimeout is less than or equal to zero (0).
NATSBadSubscriptionExceptionsubject is null or entirely whitespace.
NATSMaxPayloadExceptionThe serialzed form of obj exceeds the maximum payload size supported by the NATS server.
NATSConnectionClosedExceptionThe Connection is closed.
NATSTimeoutExceptionA timeout occurred while sending the request or receiving the response.
NATSExceptionThere was an unexpected exception performing an internal NATS call while executing the request. See System.Exception.InnerException for more details.
IOExceptionThere was a failure while writing to the network.
-
Returns
An object from the replier.

Implements NATS.Client.IEncodedConnection.

@@ -295,15 +500,27 @@
-

Request will create an Inbox and perform a Request() call with the Inbox reply and return the first reply received. This is optimized for the case of multiple responses.

+

Sends a request payload and returns the deserialized response.

+

Request(string, object) will create an unique inbox for this request, sharing a single subscription for all replies to this IEncodedConnection instance. However, if Options.UseOldRequestStyle is set, each request will have its own underlying subscription. The old behavior is not recommended as it may cause unnecessary overhead on connected NATS servers.

Parameters
- - + + +
subjectSubject to send the request on.
objThe object to send
subjectThe subject to publish obj to over the current connection.
objThe Object to serialize and publish to the connected NATS server.
+
+
+
Returns
A Object with the deserialized response from the NATS server.
+
Exceptions
+ + + + + + +
NATSBadSubscriptionExceptionsubject is null or entirely whitespace.
NATSMaxPayloadExceptionThe serialzed form of obj exceeds the maximum payload size supported by the NATS server.
NATSConnectionClosedExceptionThe Connection is closed.
NATSTimeoutExceptionA timeout occurred while sending the request or receiving the response.
NATSExceptionThere was an unexpected exception performing an internal NATS call while executing the request. See System.Exception.InnerException for more details.
IOExceptionThere was a failure while writing to the network.
-
Returns
An object from the replier.

Implements NATS.Client.IEncodedConnection.

@@ -333,15 +550,26 @@
-

SubscribeAsync will create an AsyncSubscriber with interest in a given subject, assign the handler, and immediately start receiving messages.

+

Expresses interest in the given subject to the NATS Server, and begins delivering messages to the given event handler.

+

The IAsyncSubscription returned will start delivering messages to the event handler as soon as they are received. The caller does not have to invoke IAsyncSubscription.Start.

Parameters
- - + + +
subjectSubject of interest.
handlerAn encoded message handler delegate.
subjectThe subject on which to listen for messages. The subject can have wildcards (partial: *, full: >).
handlerThe EventHandler<TEventArgs> invoked when messages are received on the returned IAsyncSubscription.
+
+
+
Returns
An IAsyncSubscription to use to read any messages received from the NATS Server on the given subject .
+
Exceptions
+ + + + + +
ArgumentNullExceptionhandler is null.
NATSExceptionOnDeserialize is null.
NATSBadSubscriptionExceptionsubject is null or entirely whitespace.
NATSConnectionClosedExceptionThe Connection is closed.
IOExceptionThere was a failure while writing to the network.
-
Returns
A new Subscription

Implements NATS.Client.IEncodedConnection.

@@ -377,19 +605,77 @@
-

This method creates an asynchronous queue subscriber on the given subject. All subscribers with the same queue name will form the queue group and only one member of the group will be selected to receive any given message asynchronously. Start() must be called to begin receiving messages.

+

Creates an asynchronous queue subscriber on the given subject , and begins delivering messages to the given event handler.

+

The IAsyncSubscription returned will start delivering messages to the event handler as soon as they are received. The caller does not have to invoke IAsyncSubscription.Start.

Parameters
- - - + + + +
subjectSubject of interest
queueName of the queue group
handlerA message handler to initialize the MessageHandler event with.
subjectThe subject on which to listen for messages. The subject can have wildcards (partial: *, full: >).
queueThe name of the queue group in which to participate.
handlerThe EventHandler<TEventArgs> invoked when messages are received on the returned IAsyncSubscription.
+
+
+
Returns
An IAsyncSubscription to use to read any messages received from the NATS Server on the given subject .
+
Exceptions
+ + + + + +
ArgumentNullExceptionhandler is null.
NATSExceptionOnDeserialize is null.
NATSBadSubscriptionExceptionsubject is null or entirely whitespace.
NATSConnectionClosedExceptionThe Connection is closed.
IOExceptionThere was a failure while writing to the network.
-
Returns
A new Subscription

Implements NATS.Client.IEncodedConnection.

+
+
+

Property Documentation

+ +
+
+ + + + + +
+ + + + +
Deserializer NATS.Client.EncodedConnection.OnDeserialize
+ 		+getset
+
+ +

Gets or sets the method which is called to deserialize objects from a message payload.

+

If null is given then the default deserialization method for the platform is used, if one exists.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Serializer NATS.Client.EncodedConnection.OnSerialize
+ 		+getset
+
+ +

Gets or sets the method which is called to serialize objects sent as a message payload.

+

If null is given then the default serialization method for the platform is used, if one exists.

+
The documentation for this class was generated from the following file:
-

Gets the reply

+

Gets the reply topic for the received Msg.

@@ -215,7 +215,7 @@
-

Gets the subject this object was received on.

+

Gets the subject for the received Msg.

diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_err_event_args-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_err_event_args-members.html index 62a7ef128..7cfe9e0b8 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_err_event_args-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_err_event_args-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_err_event_args.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_err_event_args.html index 8936af683..8a8e64b06 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_err_event_args.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_err_event_args.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -119,15 +119,15 @@ - + - +

Properties

Connection Conn [get]
Connection Conn [get]
 
Subscription Subscription [get]
Subscription Subscription [get]
 
string Error [get]
 

Detailed Description

-

Event arguments for the ErrorEventHandler type delegate.

+

Provides details for an error encountered asynchronously by an IConnection.

Property Documentation

@@ -137,7 +137,7 @@ - +
Connection NATS.Client.ErrEventArgs.ConnConnection NATS.Client.ErrEventArgs.Conn
@@ -147,7 +147,7 @@
-

Gets the connection associated with the event.

+

Gets the Connection associated with the event.

@@ -169,7 +169,7 @@
-

Gets the error associated with the event.

+

Gets the error message associated with the event.

@@ -181,7 +181,7 @@ - +
Subscription NATS.Client.ErrEventArgs.SubscriptionSubscription NATS.Client.ErrEventArgs.Subscription
@@ -191,7 +191,7 @@
-

Gets the Subscription associated wit the event.

+

Gets the NATS.Client.Subscription associated with the event.

diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg-members.html index 246a86644..ca63a2cac 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg.html index 594f3aece..85746ad5d 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -143,7 +143,7 @@  

Detailed Description

-

A NATS message is an object encapsulating a subject, optional reply payload, and subscription information, sent or received by teh client application.

+

A NATS message is an object encapsulating a subject, optional reply payload, and subscription information, sent or received by the client application.

Constructor & Destructor Documentation

@@ -158,7 +158,7 @@
-

Creates an empty message.

+

Initializes a new instance of the Msg class without any subject, reply, or data.

@@ -192,12 +192,12 @@
-

Creates a message with a subject, reply, and data.

+

Initializes a new instance of the Msg class with a subject, reply, and data.

Parameters
- - - + + +
subjectSubject of the message, required.
replyReply subject, can be null.
dataMessage payload
subjectSubject of the message.
replyA reply subject, or null.
dataA byte array containing the message payload.
@@ -228,11 +228,11 @@
-

Creates a message with a subject and data.

+

Initializes a new instance of the Msg class with a subject and data.

Parameters
- - + +
subjectSubject of the message, required.
dataMessage payload
subjectSubject of the message.
dataA byte array containing the message payload.
@@ -253,10 +253,10 @@
-

Creates a message with a subject and no payload.

+

Initializes a new instance of the Msg class with a subject and no data.

Parameters
- +
subjectSubject of the message, required.
subjectSubject of the message.
@@ -278,8 +278,9 @@

Member Function Documentation

-

Assigns the data of the message. This is a direct assignment, to avoid expensive copy operations. A change to the passed byte array will be changed in the message.

-

The application is responsible for the data integrity in the message.

+

Assigns the data of the message.

+

This is a direct assignment, to avoid expensive copy operations. A change to the passed byte array will be changed in the message.

+

The calling application is responsible for the data integrity in the message.

Parameters
@@ -326,7 +327,7 @@

Property Documentation

dataa bytes buffer of data.
-

Gets the subscription assigned to the messages.

+

Gets the ISubscription which received the message.

@@ -348,9 +349,9 @@

Property Documentation

-

Sets data in the message. This copies application data into the message.

-

See AssignData to directly pass the bytes buffer.

-

AssignData

+

Gets or sets the payload of the message.

+

This copies application data into the message. See AssignData to directly pass the bytes buffer.

+
See also
AssignData
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg_handler_event_args-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg_handler_event_args-members.html index d935f4549..e5df7963f 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg_handler_event_args-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg_handler_event_args-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg_handler_event_args.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg_handler_event_args.html index c91054002..8985ecff6 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg_handler_event_args.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_msg_handler_event_args.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -123,7 +123,7 @@  

Detailed Description

-

This class is passed into the MsgHandler delegate, providing the message received.

+

Provides the message received by an IAsyncSubscription.

Property Documentation

diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_bad_subscription_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_bad_subscription_exception-members.html index c29117182..f35849993 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_bad_subscription_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_bad_subscription_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_bad_subscription_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_bad_subscription_exception.html index 5548c4161..f8caaef56 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_bad_subscription_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_bad_subscription_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_closed_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_closed_exception-members.html index 2cada7de0..45efd026e 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_closed_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_closed_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_closed_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_closed_exception.html index 3be665b76..4d45e5a11 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_closed_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_closed_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_exception-members.html index 9f958dbef..4a82e1adb 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_exception.html index 6ee37d336..3cc5c3e15 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_connection_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_exception-members.html index 96eee3a51..d28e72ac5 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_exception.html index 7551211a6..2f7b22e1e 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_messages_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_messages_exception-members.html index 556f946a0..b0fcf1c3f 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_messages_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_messages_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_messages_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_messages_exception.html index 5036efbff..e144a35ec 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_messages_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_messages_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_payload_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_payload_exception-members.html index 522744790..1f1ea96f0 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_payload_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_payload_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_payload_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_payload_exception.html index cae3b7205..ca89c8f48 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_payload_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_max_payload_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_no_servers_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_no_servers_exception-members.html index eacc436d1..21a7a3d7d 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_no_servers_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_no_servers_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_no_servers_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_no_servers_exception.html index 47e6b55e1..110544454 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_no_servers_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_no_servers_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_protocol_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_protocol_exception-members.html index 9df68c420..796710ff1 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_protocol_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_protocol_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_protocol_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_protocol_exception.html index f30a2bf44..ae0e0c4bc 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_protocol_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_protocol_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_required_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_required_exception-members.html index 1012240ba..ca1613024 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_required_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_required_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_required_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_required_exception.html index 3493234df..67d941287 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_required_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_required_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_wanted_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_wanted_exception-members.html index 5bc814488..18dfd41d6 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_wanted_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_wanted_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_wanted_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_wanted_exception.html index b1e8046ee..54c8bd1d3 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_wanted_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_secure_conn_wanted_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_slow_consumer_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_slow_consumer_exception-members.html index 953c8e63a..5c4ae64d0 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_slow_consumer_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_slow_consumer_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_slow_consumer_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_slow_consumer_exception.html index b783f4a44..e47297525 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_slow_consumer_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_slow_consumer_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_stale_connection_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_stale_connection_exception-members.html index bb0eea424..6d57960d8 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_stale_connection_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_stale_connection_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_stale_connection_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_stale_connection_exception.html index 2b1eb1574..a7baa8a09 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_stale_connection_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_stale_connection_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_timeout_exception-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_timeout_exception-members.html index 41eccf948..243a23239 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_timeout_exception-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_timeout_exception-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_timeout_exception.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_timeout_exception.html index 8965bbb01..acfdd6763 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_timeout_exception.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_a_t_s_timeout_exception.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_u_i_d-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_u_i_d-members.html index 9f4f3fb2e..1b9080dc8 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_u_i_d-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_u_i_d-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_u_i_d.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_u_i_d.html index 54a0189da..8c57b0287 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_u_i_d.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_n_u_i_d.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options-members.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options-members.html index 89ca693f2..fbb272632 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options-members.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options-members.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -130,16 +130,19 @@ ReconnectedEventHandlerNATS.Client.Options ReconnectWaitNATS.Client.Options SecureNATS.Client.Options - ServersNATS.Client.Options - SubChannelLengthNATS.Client.Options - SubscriberDeliveryTaskCountNATS.Client.Options + ServerDiscoveredEventHandlerNATS.Client.Options + ServersNATS.Client.Options + SubChannelLengthNATS.Client.Options + SubscriberDeliveryTaskCountNATS.Client.Options + SubscriptionBatchSizeNATS.Client.Options TimeoutNATS.Client.Options TLSRemoteCertificationValidationCallbackNATS.Client.Options TokenNATS.Client.Options ToString()NATS.Client.Options UrlNATS.Client.Options - UserNATS.Client.Options - VerboseNATS.Client.Options + UseOldRequestStyleNATS.Client.Options + UserNATS.Client.Options + VerboseNATS.Client.Options
diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options.html b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options.html index 1eeeb21bf..f97295bcc 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options.html +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -130,6 +130,8 @@ Public Attributes EventHandler< ConnEventArgs > ClosedEventHandler = null   +EventHandler< ConnEventArgs > ServerDiscoveredEventHandler = null +  EventHandler< ConnEventArgs > DisconnectedEventHandler = null   EventHandler< ConnEventArgs > ReconnectedEventHandler = null @@ -153,6 +155,8 @@   bool Pedantic [get, set]   +bool UseOldRequestStyle [get, set] +  bool Secure [get, set]   bool AllowReconnect [get, set] @@ -177,6 +181,8 @@   int SubscriberDeliveryTaskCount [get, set]   +int SubscriptionBatchSize [get, set] + 

Detailed Description

This class is used to setup all NATs client options.

@@ -195,13 +201,28 @@
-

Adds a certifcate for use with a secure connection.

+

Adds an X.509 certifcate from a file for use with a secure connection.

Parameters
fileNamePath to the certificate file to add.
+
Exceptions
+ + + +
ArgumentNullExceptionfileName is null.
System.Security.Cryptography.CryptographicExceptionAn error with the certificate ocurred. For example:
    +
  • +The certificate file does not exist.
    • +
  • +The certificate is invalid.
    • +
  • +The certificate's password is incorrect.
    • +
+
+
+
@@ -219,10 +240,25 @@
-

Adds a certificate for use with a secure connection.

+

Adds an X.509 certifcate for use with a secure connection.

Parameters
- + +
certificateCertificate to add.
certificateAn X.509 certificate represented as an X509Certificate2 object.
+
+
+
Exceptions
+ + +
ArgumentNullExceptioncertificate is null.
System.Security.Cryptography.CryptographicExceptionAn error with the certificate ocurred. For example:
    +
  • +The certificate file does not exist.
    • +
  • +The certificate is invalid.
    • +
  • +The certificate's password is incorrect.
    • +
+
@@ -302,6 +338,20 @@

Member Data Documentation

Represents the method that will handle an event raised when a connection has reconnected to a server.

+
+ + +
+
+ + + + +
EventHandler<ConnEventArgs> NATS.Client.Options.ServerDiscoveredEventHandler = null
+
+ +

Represents the method that will handle an event raised whenever a new server has joined the cluster.

+
@@ -315,7 +365,7 @@

Member Data Documentation

Overrides the default NATS RemoteCertificationValidationCallback.

-

The default callback simply checks if there were any protocol errors. Overriding this callback useful during testing, or accepting self signed certificates.

+

The default callback simply checks if there were any protocol errors. Overriding this callback is useful during testing, or accepting self signed certificates.

@@ -338,7 +388,7 @@

Property Documentation

-

Gets or Sets the allow reconnect flag. When set to false, the NATs client will not attempt to reconnect if a connection has been lost.

+

Gets or sets a value indicating whether or not an IConnection will attempt to reconnect to the NATS server if a connection has been lost.

@@ -426,7 +476,7 @@

Property Documentation

-

Gets or Sets the randomization of choosing a server to connect to.

+

Gets or sets a value indicating whether or not the server chosen for connection should not be selected randomly.

@@ -448,7 +498,7 @@

Property Documentation

-

Sets the user password used when connecting to the NATs server when not included directly in the URLs.

+

Sets the user password used when connecting to the NATs server, when not included directly in the URLs.

@@ -470,7 +520,7 @@

Property Documentation

-

N/A.

+

This option is not used by the NATS Client.

@@ -492,7 +542,8 @@

Property Documentation

-

Gets or sets the interval pings will be sent to the server. Take care to coordinate this value with the server's interval.

+

Gets or sets the interval, in milliseconds, pings will be sent to the server.

+

Take care to coordinate this value with the server's interval.

@@ -514,7 +565,7 @@

Property Documentation

-

Gets or Sets the amount of time, in milliseconds, the client will wait during a reconnection.

+

Gets or sets the amount of time, in milliseconds, the client will wait before attempting a reconnection.

@@ -536,7 +587,7 @@

Property Documentation

-

Get or sets the secure property. Not currently implemented.

+

Get or sets a value indicating whether or not a secure connection (TLS) should be made to NATS servers.

@@ -558,7 +609,8 @@

Property Documentation

-

Gets or Sets the array of servers that the NATs client will connect to.

+

Gets or sets the array of servers that the NATs client will connect to.

+

The individual URLs may contain username/password information.

@@ -602,9 +654,32 @@

Property Documentation

-

Sets or gets number of long running tasks to deliver messages to asynchronous subscribers. The default is 0 indicating each asynchronous subscriber has its own channel and task created to deliver messages.

+

Gets or sets the number of long running tasks to deliver messages to asynchronous subscribers. The default is zero (0) indicating each asynchronous subscriber has its own channel and task created to deliver messages.

The default where each subscriber has a delivery task is very performant, but does not scale well when large numbers of subscribers are required in an application. Setting this value will limit the number of subscriber channels to the specified number of long running tasks. These tasks will process messages for ALL asynchronous subscribers rather than one task for each subscriber. Delivery order by subscriber is still guaranteed. The shared message processing channels are still each bounded by the SubChannelLength option. Note, slow subscriber errors will flag the last subscriber processed in the tasks, which may not actually be the slowest subscriber.

+
+ + +
+
+ + + + + +
+ + + + +
int NATS.Client.Options.SubscriptionBatchSize
+ 		+getset
+
+ +

Gets or sets the batch size for calling subscription handlers.

+

When delivering messages to the subscriber, the batch size determines how many messages could be retrieved from the internal subscription queue at one time. This can allow higher performance from a single subscriber by avoiding the locking overhead of one-at-a-time retrieval from the queue.

+
@@ -625,7 +700,7 @@

Property Documentation

-

Gets or sets the timeout when flushing a connection.

+

Gets or sets the timeout, in milliseconds, when connecting to a NATS server.

@@ -669,7 +744,31 @@

Property Documentation

-

Gets or sets the url used to connect to the NATs server. This may contain user information.

+

Gets or sets the url used to connect to the NATs server.

+

This may contain username/password information.

+ +
+ + +
+
+ + + + + +
+ + + + +
bool NATS.Client.Options.UseOldRequestStyle
+ 		+getset
+
+ +

Gets or sets a value indicating whether or not the old request pattern should be used.

+

The old request pattern involved a separate subscription per request inbox. The new style (default) involves creating a single inbox subscription per connection, upon the first request, and mapping outbound requests over that one subscription.

@@ -691,7 +790,7 @@

Property Documentation

-

Gets or sets the user name used when connecting to the NATs server when not included directly in the URLs.

+

Gets or sets the user name used when connecting to the NATs server, when not included directly in the URLs.

@@ -713,7 +812,7 @@

Property Documentation

-

Gets or sets the verbosity of logging.

+

Gets or sets a value indicating whether or not logging information should be verbose.

diff --git a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options.js b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options.js index 3e65e88d2..41d5de6e5 100755 --- a/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options.js +++ b/documentation/NATS.Client/html/class_n_a_t_s_1_1_client_1_1_options.js @@ -7,6 +7,7 @@ var class_n_a_t_s_1_1_client_1_1_options = [ "ClosedEventHandler", "class_n_a_t_s_1_1_client_1_1_options.html#a910d4dcebe9046e2ab1772f2007dce0e", null ], [ "DisconnectedEventHandler", "class_n_a_t_s_1_1_client_1_1_options.html#a6116c0a92a645bbc356bde9533220ea4", null ], [ "ReconnectedEventHandler", "class_n_a_t_s_1_1_client_1_1_options.html#ad39b3eec90490ebaa53276fc01668d9a", null ], + [ "ServerDiscoveredEventHandler", "class_n_a_t_s_1_1_client_1_1_options.html#a01dd0d8f7f5cabdc5d2d68c08dff3561", null ], [ "TLSRemoteCertificationValidationCallback", "class_n_a_t_s_1_1_client_1_1_options.html#a3ee9fbb7b3cfbc49a9b3a314f883904d", null ], [ "AllowReconnect", "class_n_a_t_s_1_1_client_1_1_options.html#aca0e26d763c9b7920eeb2506bfffc59b", null ], [ "MaxPingsOut", "class_n_a_t_s_1_1_client_1_1_options.html#af72a56c42d59f70432c80f8526edda6e", null ], @@ -21,9 +22,11 @@ var class_n_a_t_s_1_1_client_1_1_options = [ "Servers", "class_n_a_t_s_1_1_client_1_1_options.html#a2e0b5fe52ae54b89e42a9e49b47f94e1", null ], [ "SubChannelLength", "class_n_a_t_s_1_1_client_1_1_options.html#a82c9580a9c7dd0367c53f2c1d309a039", null ], [ "SubscriberDeliveryTaskCount", "class_n_a_t_s_1_1_client_1_1_options.html#a030dfa5eac04072735d7529147d5c562", null ], + [ "SubscriptionBatchSize", "class_n_a_t_s_1_1_client_1_1_options.html#a4525f2afa6970381335c5dd3fc28a581", null ], [ "Timeout", "class_n_a_t_s_1_1_client_1_1_options.html#a20342f2f3c596083d5989d12ee656155", null ], [ "Token", "class_n_a_t_s_1_1_client_1_1_options.html#ab82e941a962699f7aeca2a3508a7f2d7", null ], [ "Url", "class_n_a_t_s_1_1_client_1_1_options.html#a4952cb3e82ca4692896f289d9825682a", null ], + [ "UseOldRequestStyle", "class_n_a_t_s_1_1_client_1_1_options.html#a0dd67697b2487a4fbb5abf0f4fd06509", null ], [ "User", "class_n_a_t_s_1_1_client_1_1_options.html#a92c60e7ef8aa92144a39dbd9706f4ea9", null ], [ "Verbose", "class_n_a_t_s_1_1_client_1_1_options.html#acba4ff882b4a8895ff0a47d9cbcff2d5", null ] ]; \ No newline at end of file diff --git a/documentation/NATS.Client/html/classes.html b/documentation/NATS.Client/html/classes.html index 2c9da2bc2..e87dcfb84 100755 --- a/documentation/NATS.Client/html/classes.html +++ b/documentation/NATS.Client/html/classes.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -111,25 +111,30 @@
Class Index
-
C | E | I | M | N | O
+
A | C | E | I | M | N | O | S
+ + + - - - - - - - + + + + + + +
  A  
+		EncodedMessageEventArgs (NATS.Client)   
  M  
+		NATSMaxMessagesException (NATS.Client)   
  O  
+
ErrEventArgs (NATS.Client)   NATSMaxPayloadException (NATS.Client)   
AsyncSubscription (NATS.Client)   
  I  
+		Msg (NATS.Client)   NATSNoServersException (NATS.Client)   Options (NATS.Client)   
  C  
-		ErrEventArgs (NATS.Client)   ISyncSubscription (NATS.Client)   NATSConnectionClosedException (NATS.Client)   NATSSecureConnWantedException (NATS.Client)   
  I  
-
  M  
-		NATSConnectionException (NATS.Client)   NATSSlowConsumerException (NATS.Client)   
ConnectionFactory (NATS.Client)   NATSException (NATS.Client)   NATSStaleConnectionException (NATS.Client)   
ConnEventArgs (NATS.Client)   IAsyncSubscription (NATS.Client)   Msg (NATS.Client)   NATSMaxMessagesException (NATS.Client)   NATSTimeoutException (NATS.Client)   
  E  
-		IConnection (NATS.Client)   MsgHandlerEventArgs (NATS.Client)   NATSMaxPayloadException (NATS.Client)   NUID (NATS.Client)   
IEncodedConnection (NATS.Client)   
  N  
-		NATSNoServersException (NATS.Client)   
  O  
+		MsgHandlerEventArgs (NATS.Client)   NATSProtocolException (NATS.Client)   
  S  
EncodedConnection (NATS.Client)   IStatistics (NATS.Client)   NATSProtocolException (NATS.Client)   
EncodedMessageEventArgs (NATS.Client)   ISubscription (NATS.Client)   NATSBadSubscriptionException (NATS.Client)   NATSSecureConnRequiredException (NATS.Client)   Options (NATS.Client)   
IAsyncSubscription (NATS.Client)   
  N  
+		NATSSecureConnRequiredException (NATS.Client)   
Connection (NATS.Client)   IConnection (NATS.Client)   NATSSecureConnWantedException (NATS.Client)   Statistics (NATS.Client)   
ConnectionFactory (NATS.Client)   IEncodedConnection (NATS.Client)   NATSBadSubscriptionException (NATS.Client)   NATSSlowConsumerException (NATS.Client)   Subscription (NATS.Client)   
ConnEventArgs (NATS.Client)   IStatistics (NATS.Client)   NATSConnectionClosedException (NATS.Client)   NATSStaleConnectionException (NATS.Client)   SyncSubscription (NATS.Client)   
  E  
+		ISubscription (NATS.Client)   NATSConnectionException (NATS.Client)   NATSTimeoutException (NATS.Client)   
ISyncSubscription (NATS.Client)   NATSException (NATS.Client)   NUID (NATS.Client)   
EncodedConnection (NATS.Client)   
-
C | E | I | M | N | O
+
A | C | E | I | M | N | O | S
diff --git a/documentation/NATS.Client/html/functions.html b/documentation/NATS.Client/html/functions.html index ccee4ca46..f71dd648f 100755 --- a/documentation/NATS.Client/html/functions.html +++ b/documentation/NATS.Client/html/functions.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -88,24 +88,24 @@ @@ -157,381 +157,9 @@

- a -

- - -

- c -

- - -

- d -

- - -

- e -

- - -

- f -

- - -

- g -

- - -

- i -

- - -

- l -

- - -

- m -

- - -

- n -

- - -

- o -

- - -

- p -

- - -

- q -

- - -

- r -

- - -

- s -

- - -

- t -

- - -

- u -

- - -

- v -

diff --git a/documentation/NATS.Client/html/functions_evnt.html b/documentation/NATS.Client/html/functions_evnt.html index 8fa7e8caa..51e9362db 100755 --- a/documentation/NATS.Client/html/functions_evnt.html +++ b/documentation/NATS.Client/html/functions_evnt.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -118,7 +118,8 @@
 
diff --git a/documentation/NATS.Client/html/functions_func.html b/documentation/NATS.Client/html/functions_func.html index 53979e811..5f6a17c45 100755 --- a/documentation/NATS.Client/html/functions_func.html +++ b/documentation/NATS.Client/html/functions_func.html @@ -33,7 +33,7 @@
NATS .NET Client -  0.7.0 +  0.8.0
The nats.io .NET C# Client, Supported by Apcera
@@ -90,6 +90,7 @@