Skip to content

Commit fb9aabd

Browse files
EtherZazarusz
authored andcommitted
Typos
Signed-off-by: Richard Pringle <richardpringle@gmail.com>
1 parent 43e1e1b commit fb9aabd

82 files changed

Lines changed: 210 additions & 200 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Pull requests are welcome
22

3-
Pull requests are welcome. Ideally first state the problem or feature you need and engage in a discusssion on gitter or github issues.
3+
Pull requests are welcome. Ideally first state the problem or feature you need and engage in a discussion on gitter or github issues.
44
A high level design discussion will be needed for new features.
55

66
### Sign your work

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ services.AddSlimMessageBus(mbb =>
169169
.WithProviderKafka(cfg => { cfg.BrokerList = "localhost:9092"; }); // requires SlimMessageBus.Host.Kafka package
170170
// Use Azure Service Bus transport provider
171171
//.WithProviderServiceBus(cfg => { ... }) // requires SlimMessageBus.Host.AzureServiceBus package
172-
// Use Azure Azure Event Hub transport provider
172+
// Use Azure Event Hub transport provider
173173
//.WithProviderEventHub(cfg => { ... }) // requires SlimMessageBus.Host.AzureEventHub package
174174
// Use Redis transport provider
175175
//.WithProviderRedis(cfg => { ... }) // requires SlimMessageBus.Host.Redis package

docs/intro.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ services.AddSlimMessageBus(mbb =>
7272

7373
// Use Azure Service Bus transport provider (requires SlimMessageBus.Host.AzureServiceBus package)
7474
//.WithProviderServiceBus(...)
75-
// Use Azure Azure Event Hub transport provider (requires SlimMessageBus.Host.AzureEventHub package)
75+
// Use Azure Event Hub transport provider (requires SlimMessageBus.Host.AzureEventHub package)
7676
//.WithProviderEventHub(...)
7777
// Use Redis transport provider (requires SlimMessageBus.Host.Redis package)
7878
//.WithProviderRedis(...)
@@ -124,7 +124,7 @@ Having done the SMB setup, one can then inject [`IMessageBus`](../src/SlimMessag
124124

125125
> The `IMessageBus` implementations are lightweight and thread-safe.
126126
127-
For completness, please also see the [Hybrid provider configuration](provider_hybrid.md#configuration) which might be needed if the application needs to use more than one transport.
127+
For completeness, please also see the [Hybrid provider configuration](provider_hybrid.md#configuration) which might be needed if the application needs to use more than one transport.
128128

129129
## Pub/Sub communication
130130

@@ -236,7 +236,7 @@ public class SomeConsumer
236236
#### Start or Stop message consumption
237237

238238
By default message consumers are started as soon as the bus is created. This means that messages arriving on the given transport will be processed by the declared consumers.
239-
If you want to prevent this default use the follwing setting:
239+
If you want to prevent this default use the following setting:
240240

241241
```cs
242242
mbb.AutoStartConsumersEnabled(false); // default is true
@@ -599,7 +599,7 @@ There is also an option to provide a type filter predicate. This might be helpfu
599599
```cs
600600
services.AddSlimMessageBus(mbb =>
601601
{
602-
// Register the found types that contain DomainEventHandlers in the namespacce
602+
// Register the found types that contain DomainEventHandlers in the namespace
603603
mbb.AddConsumersFromAssembly(Assembly.GetExecutingAssembly(), filter: (type) => type.Namespace.Contains("DomainEventHandlers"));
604604
};
605605
```
@@ -614,7 +614,7 @@ services.AddHttpContextAccessor(); // This is required for the SlimMessageBus.Ho
614614
services.AddSlimMessageBus(mbb =>
615615
{
616616
// ...
617-
mbb.AddAspNet(); // reqires SlimMessageBus.Host.AspNetCore
617+
mbb.AddAspNet(); // requires SlimMessageBus.Host.AspNetCore
618618
};
619619
```
620620

@@ -663,7 +663,7 @@ The `mbb.AddServicesFromAssembly()` extension method performs search for any imp
663663
- consumers `IConsumer<T>`, `IRequestHandler<T, R>` or `IRequestHandler<T>`,
664664
- [interceptors](#interceptors)
665665

666-
Found types are registered (by default as `Transient`) servcices with the MSDI container.
666+
Found types are registered (by default as `Transient`) services with the MSDI container.
667667

668668
```cs
669669
services.AddSlimMessageBus(mbb =>
@@ -686,7 +686,7 @@ The `MessageType` header will be set for every published (or produced) message t
686686

687687
This approach allows SMB to send polymorphic message types (messages that share a common ancestry) and even send unrelated message types via the same topic/queue transport.
688688

689-
This mechanism should work fine with serializers that support polimorphic serialization (e.g. Newtonsoft.Json) and have that feature enabled. In such case a message type discriminator (e.g. `$type` property for Newtonsoft.Json) will be added by the serializer to the message payload, so that the deserializer on the consumer end knows to what type to deserialize the message to.
689+
This mechanism should work fine with serializers that support polymorphic serialization (e.g. Newtonsoft.Json) and have that feature enabled. In such case a message type discriminator (e.g. `$type` property for Newtonsoft.Json) will be added by the serializer to the message payload, so that the deserializer on the consumer end knows to what type to deserialize the message to.
690690
However, the `MessageType` header takes precedence in SMB in matching the correct consumer.
691691

692692
> For better interoperability, the `MessageType` header is optional. This is to support the scenario that other publishing system does not use SMB nor is able to set the header. However, in the absence of `MessageType` header the SMB consumer side, should expect only one type per topic/queue. If there were more than one message types on the same topic (or queue) SMB would not be able to infer what type actually arrived.
@@ -815,7 +815,7 @@ mbb.Consume<CustomerEvent>(x =>
815815
});
816816
```
817817

818-
All the arriving polymorphic message types will be matched agaist the declared consumers types that could accept the arrived message type and they will be activated.
818+
All the arriving polymorphic message types will be matched against the declared consumers types that could accept the arrived message type and they will be activated.
819819

820820
In this example:
821821

@@ -1009,7 +1009,7 @@ public interface IConsumerErrorHandler<in T>
10091009
/// <param name="message">The message that failed to process.</param>
10101010
/// <param name="retry">Performs another message processing try. The return value is relevant if the consumer was a request handler (it will be its response value). Ensure to pass the return value to the result of the error handler.</param>
10111011
/// <param name="consumerContext">The consumer context for the message processing pipeline.</param>
1012-
/// <param name="exception">Exception that ocurred during message processing.</param>
1012+
/// <param name="exception">Exception that occurred during message processing.</param>
10131013
/// <returns>The error handling result.</returns>
10141014
Task<ConsumerErrorHandlerResult> OnHandleError(T message, Func<Task<object>> retry, IConsumerContext consumerContext, Exception exception);
10151015
}

docs/intro.t.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ services.AddSlimMessageBus(mbb =>
7272

7373
// Use Azure Service Bus transport provider (requires SlimMessageBus.Host.AzureServiceBus package)
7474
//.WithProviderServiceBus(...)
75-
// Use Azure Azure Event Hub transport provider (requires SlimMessageBus.Host.AzureEventHub package)
75+
// Use Azure Event Hub transport provider (requires SlimMessageBus.Host.AzureEventHub package)
7676
//.WithProviderEventHub(...)
7777
// Use Redis transport provider (requires SlimMessageBus.Host.Redis package)
7878
//.WithProviderRedis(...)
@@ -124,7 +124,7 @@ Having done the SMB setup, one can then inject [`IMessageBus`](../src/SlimMessag
124124

125125
> The `IMessageBus` implementations are lightweight and thread-safe.
126126
127-
For completness, please also see the [Hybrid provider configuration](provider_hybrid.md#configuration) which might be needed if the application needs to use more than one transport.
127+
For completeness, please also see the [Hybrid provider configuration](provider_hybrid.md#configuration) which might be needed if the application needs to use more than one transport.
128128

129129
## Pub/Sub communication
130130

@@ -236,7 +236,7 @@ public class SomeConsumer
236236
#### Start or Stop message consumption
237237

238238
By default message consumers are started as soon as the bus is created. This means that messages arriving on the given transport will be processed by the declared consumers.
239-
If you want to prevent this default use the follwing setting:
239+
If you want to prevent this default use the following setting:
240240

241241
```cs
242242
mbb.AutoStartConsumersEnabled(false); // default is true
@@ -599,7 +599,7 @@ There is also an option to provide a type filter predicate. This might be helpfu
599599
```cs
600600
services.AddSlimMessageBus(mbb =>
601601
{
602-
// Register the found types that contain DomainEventHandlers in the namespacce
602+
// Register the found types that contain DomainEventHandlers in the namespace
603603
mbb.AddConsumersFromAssembly(Assembly.GetExecutingAssembly(), filter: (type) => type.Namespace.Contains("DomainEventHandlers"));
604604
};
605605
```
@@ -614,7 +614,7 @@ services.AddHttpContextAccessor(); // This is required for the SlimMessageBus.Ho
614614
services.AddSlimMessageBus(mbb =>
615615
{
616616
// ...
617-
mbb.AddAspNet(); // reqires SlimMessageBus.Host.AspNetCore
617+
mbb.AddAspNet(); // requires SlimMessageBus.Host.AspNetCore
618618
};
619619
```
620620

@@ -663,7 +663,7 @@ The `mbb.AddServicesFromAssembly()` extension method performs search for any imp
663663
- consumers `IConsumer<T>`, `IRequestHandler<T, R>` or `IRequestHandler<T>`,
664664
- [interceptors](#interceptors)
665665

666-
Found types are registered (by default as `Transient`) servcices with the MSDI container.
666+
Found types are registered (by default as `Transient`) services with the MSDI container.
667667

668668
```cs
669669
services.AddSlimMessageBus(mbb =>
@@ -686,7 +686,7 @@ The `MessageType` header will be set for every published (or produced) message t
686686

687687
This approach allows SMB to send polymorphic message types (messages that share a common ancestry) and even send unrelated message types via the same topic/queue transport.
688688

689-
This mechanism should work fine with serializers that support polimorphic serialization (e.g. Newtonsoft.Json) and have that feature enabled. In such case a message type discriminator (e.g. `$type` property for Newtonsoft.Json) will be added by the serializer to the message payload, so that the deserializer on the consumer end knows to what type to deserialize the message to.
689+
This mechanism should work fine with serializers that support polymorphic serialization (e.g. Newtonsoft.Json) and have that feature enabled. In such case a message type discriminator (e.g. `$type` property for Newtonsoft.Json) will be added by the serializer to the message payload, so that the deserializer on the consumer end knows to what type to deserialize the message to.
690690
However, the `MessageType` header takes precedence in SMB in matching the correct consumer.
691691

692692
> For better interoperability, the `MessageType` header is optional. This is to support the scenario that other publishing system does not use SMB nor is able to set the header. However, in the absence of `MessageType` header the SMB consumer side, should expect only one type per topic/queue. If there were more than one message types on the same topic (or queue) SMB would not be able to infer what type actually arrived.
@@ -815,7 +815,7 @@ mbb.Consume<CustomerEvent>(x =>
815815
});
816816
```
817817

818-
All the arriving polymorphic message types will be matched agaist the declared consumers types that could accept the arrived message type and they will be activated.
818+
All the arriving polymorphic message types will be matched against the declared consumers types that could accept the arrived message type and they will be activated.
819819

820820
In this example:
821821

docs/plugin_outbox.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Startup setup:
4545
```cs
4646
builder.Services.AddSlimMessageBus(mbb =>
4747
{
48+
mbb.PerMessageScopeEnabled(false);
4849
mbb
4950
.AddChildBus("Memory", mbb =>
5051
{
@@ -85,6 +86,7 @@ builder.Services.AddSlimMessageBus(mbb =>
8586
.AddOutboxUsingDbContext<CustomerContext>(opts =>
8687
{
8788
opts.PollBatchSize = 100;
89+
opts.PollIdleSleep = TimeSpan.FromSeconds(10);
8890
opts.MessageCleanup.Interval = TimeSpan.FromSeconds(10);
8991
opts.MessageCleanup.Age = TimeSpan.FromMinutes(1);
9092
//opts.SqlSettings.TransactionIsolationLevel = System.Data.IsolationLevel.RepeatableRead;

docs/provider_azure_eventhubs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ services.AddSlimMessageBus(mbb =>
6767
cfg.StorageConnectionString = storageConnectionString;
6868
cfg.StorageBlobContainerName = storageContainerName;
6969

70-
// More advanced settings can be changed on the the underlying AEH client
70+
// More advanced settings can be changed on the underlying AEH client
7171
cfg.EventHubProducerClientOptionsFactory = (path) => new Azure.Messaging.EventHubs.Producer.EventHubProducerClientOptions
7272
{
7373
Identifier = $"MyService_{Guid.NewGuid()}"

docs/provider_azure_servicebus.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Please read the [Introduction](intro.md) before reading this provider documentat
1616
- [Handle Request Messages](#handle-request-messages)
1717
- [ASB Sessions](#asb-sessions)
1818
- [Topology Provisioning](#topology-provisioning)
19-
- [Triger Topology Provisioning](#triger-topology-provisioning)
19+
- [Trigger Topology Provisioning](#trigger-topology-provisioning)
2020

2121
## Configuration
2222

@@ -43,7 +43,7 @@ This determination is set as part of the bus builder configuration.
4343

4444
## Producing Messages
4545

46-
To produce a given `TMessage` to a Azure Serivce Bus queue (or topic) use:
46+
To produce a given `TMessage` to a Azure Service Bus queue (or topic) use:
4747

4848
```cs
4949
// send TMessage to Azure SB queues
@@ -312,7 +312,7 @@ The consumer side has to enable sessions:
312312
mbb.Consume<CustomerMessage>(x => x
313313
.Queue(queue)
314314
.WithConsumer<CustomerConsumer>()
315-
// Defines how many concurrent message processings will be done within a single ongoing session
315+
// Defines how many concurrent message processors will be instantiated within a single ongoing session
316316
// To achieve FIFO, this should be 1 (the default)
317317
.Instances(1)
318318
// Enables sessions, this process can handle up to 10 sessions concurrently, each session will expire after 5 seconds of inactivity
@@ -466,7 +466,7 @@ mbb.WithProviderServiceBus(cfg =>
466466
});
467467
```
468468

469-
### Triger Topology Provisioning
469+
### Trigger Topology Provisioning
470470

471471
> Since 1.19.3
472472

docs/provider_hybrid.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,17 @@ The `IMessageBus` injected into any layer of your application will be the hybrid
7272
It is important to understand, that handlers (`IRequestHandler<>`) or consumers (`IConsumer<>`) registered will be managed by the respective child bus that they are configured on.
7373

7474
There can be more than one child bus that can consume the given message type. In this case hybrid bus will route the message to all of the child bus.
75-
By default any matching child bus will be executed in sequence. There is also an option to execute this in pararell (see the `PublishExecutionMode` setting on `HybridMessageBusSettings`).
75+
By default any matching child bus will be executed in sequence. There is also an option to execute this in parallel (see the `PublishExecutionMode` setting on `HybridMessageBusSettings`).
7676

7777
> A given request message type can only be handled by one child bus, however, non-request messages can by consumed by multiple child buses.
7878
79-
The request messages need exactly one handler to calculate the response, therefore if we had more than one handler for a given request it would be ambigous which response to return.
79+
The request messages need exactly one handler to calculate the response, therefore if we had more than one handler for a given request it would be ambiguous which response to return.
8080

8181
### Shared configuration
8282

83-
Any setting applied at the hybrid bus builder level will be inherited by ech child transport bus. In the example mentioned, the memory and Azure SB busses will inherit the serializer and dependency resolver.
83+
Any setting applied at the hybrid bus builder level will be inherited by each child transport bus. In the example mentioned, the memory and Azure SB buses will inherit the serializer and dependency resolver.
8484

85-
Individual child busses can provide their own serialization (or any other setting) and effectively override the serialization (or any other setting).
85+
Individual child buses can provide their own serialization (or any other setting) and effectively override the serialization (or any other setting).
8686

8787
> The Hybrid bus builder configurations of the producer (`Produce()`) and consumer (`Consume()`) will be added into every child bus producer/consumer registration list.
8888

docs/provider_kafka.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ There are two possible options:
122122

123123
### Default partitioner with message key
124124

125-
Currently the [confluent-kafka-dotnet](https://github.com/confluentinc/confluent-kafka-dotnet) does not support custom partitioners (see [here](https://github.com/confluentinc/confluent-kafka-dotnet/issues/343)).
125+
Currently, [confluent-kafka-dotnet](https://github.com/confluentinc/confluent-kafka-dotnet) does not support custom partitioners (see [here](https://github.com/confluentinc/confluent-kafka-dotnet/issues/343)).
126126
The default partitioner is supported, which works in this way:
127127

128128
- when message key is not provided then partition is assigned using round-robin,

docs/provider_redis.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The `RedisMessageBusSettings` has additional settings that allow to override fac
4040

4141
### Connection string parameters
4242

43-
The list of all configuration parameters for the connectiong string can be found here:
43+
The list of all configuration parameters for the connection string can be found here:
4444
https://stackexchange.github.io/StackExchange.Redis/Configuration
4545

4646
## Producer
@@ -119,7 +119,7 @@ await bus.Publish(new SomeMessage())
119119
Then all 3 service instances will have the message copy delivered to the `SomeConsumer` (even the service instance that published the message in question).
120120
This is because each service instance is an independent subscriber (independent Redis client).
121121

122-
> In redis pub/sub the published messages are not durable. At the time of publish only connected consumers will recieve the message. If any of your service instances comes online after the publish (had a downtime, was restarted) the previously publishied messages will not be delivered.
122+
> In redis pub/sub the published messages are not durable. At the time of publish only connected consumers will receive the message. If any of your service instances comes online after the publish (had a downtime, was restarted) the previously published messages will not be delivered.
123123

124124
### Queues
125125

@@ -139,16 +139,16 @@ The queue (FIFO) is emulated using a [Redis list type](https://redis.io/docs/dat
139139
- the key represents the queue name,
140140
- the value is a Redis list type and stores messages (in FIFO order).
141141

142-
Internally the queue is implemetned in the following way:
142+
Internally the queue is implemented in the following way:
143143

144144
- producer will use the [`RPUSH`](https://redis.io/commands/rpush) to add the message at the tail of the list with a redis key (queue name),
145145
- consumer will use the [`LPOP`](https://redis.io/commands/lpop) to remove the massage from the head of the list with a redis key (queue name).
146146

147147
> The implementation provides at-most-once delivery guarantee.
148148
149149
There is a chance that the consumer process dies after it performs `LPOP` and before it fully processes the message.
150-
Another implementation was also considered using [`RPOPLPUSH`](https://redis.io/commands/rpoplpush) that would allow for at-least-once quarantee.
151-
However, that would require to manage individual per process instance local queues making tha runtime and configuration not practical.
150+
Another implementation was also considered using [`RPOPLPUSH`](https://redis.io/commands/rpoplpush) that would allow for at-least-once guarantee.
151+
However, that would require to manage individual per process instance local queues making the runtime and configuration not practical.
152152

153153
### Message Headers
154154

0 commit comments

Comments
 (0)