Skip to content

Add redis streams support to documentation#862

Merged
xiangxiren merged 1 commit intomasterfrom
MahmoudSamirupdate-redis-streams-docs
May 10, 2021
Merged

Add redis streams support to documentation#862
xiangxiren merged 1 commit intomasterfrom
MahmoudSamirupdate-redis-streams-docs

Conversation

@MahmoudSamir101
Copy link
Member

Redis Streams

Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache, and message broker.

Redis Stream is a new data type introduced with Redis 5.0, which models a log data structure in a more abstract way with an append only data structure.

Redis Streams can be used in CAP as a message transporter.

Configuration

To use Redis Streams transporter, you need to install the following package from NuGet:

PM> Install-Package DotNetCore.CAP.RedisStreams

Then you can add configuration items to the ConfigureServices method of Startup.cs.

public void ConfigureServices(IServiceCollection services)
{
    services.AddCap(capOptions =>
    {
        capOptions.UseRedis(redisOptions=>{
            //redisOptions
        });
    });
}

Redis Streams Options

Redis configuration parameters provided directly by the CAP:

NAME DESCRIPTION TYPE DEFAULT
Configuration redis connection configuration (StackExchange.Redis) ConfigurationOptions ConfigurationOptions
StreamEntriesCount number of entries returned from a stream while reading uint 10
ConnectionPoolSize number of connections pool uint 10

Redis ConfigurationOptions

If you need more native Redis related configuration options, you can set them in the Configuration option:

services.AddCap(capOptions => 
{
    capOptions.UseRedis(redisOptions=>
    {
        // redis options.
        redisOptions.Configuration.EndPoints.Add(IPAddress.Loopback, 0);
    });
});

Configuration is a StackExchange.Redis ConfigurationOptions , you can find more details through this link

@MahmoudSamir101 MahmoudSamir101 changed the title Create redis-streams.md Add redis streams support to documentation May 9, 2021
Copy link
Contributor

@xiangxiren xiangxiren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LTGM , Thanks

@xiangxiren xiangxiren merged commit dc67421 into master May 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants