YMJake.Aspire.Hosting.RocketMQ
1.0.7
dotnet add package YMJake.Aspire.Hosting.RocketMQ --version 1.0.7
NuGet\Install-Package YMJake.Aspire.Hosting.RocketMQ -Version 1.0.7
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="YMJake.Aspire.Hosting.RocketMQ" Version="1.0.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="YMJake.Aspire.Hosting.RocketMQ" Version="1.0.7" />
<PackageReference Include="YMJake.Aspire.Hosting.RocketMQ" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add YMJake.Aspire.Hosting.RocketMQ --version 1.0.7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: YMJake.Aspire.Hosting.RocketMQ, 1.0.7"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package YMJake.Aspire.Hosting.RocketMQ@1.0.7
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=YMJake.Aspire.Hosting.RocketMQ&version=1.0.7
#tool nuget:?package=YMJake.Aspire.Hosting.RocketMQ&version=1.0.7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
YMJake.Aspire.Hosting.RocketMQ
AppHost extensions for running RocketMQ in .NET Aspire.
Resource Model
AddRocketMQCluster("rocketmq") creates:
rocketmq(logical root / connection-string source)rocketmq-nameserverrocketmq-brokerrocketmq-proxyrocketmq-dashboard(optional)
The application-facing connection string points to Proxy.
Quick Start
using Aspire.Hosting.RocketMQ;
using Projects;
var builder = DistributedApplication.CreateBuilder(args);
var rocketmq = builder.AddRocketMQCluster("rocketmq")
.WithDashboard()
.AddTopic("AspireRocketMQSmoke");
builder.AddProject<Aspire_RocketMQ_AspNet_Demo>("api")
.WaitForRocketMQCompletion(rocketmq)
.WithReference(rocketmq);
builder.Build().Run();
Common Customization
var rocketmq = builder.AddRocketMQCluster("rocketmq")
.WithBrokerConfig("../../rocketmq/conf/broker.conf", "/home/rocketmq/conf/broker.conf")
.WithProxyConfig("../../rocketmq/conf/rmq-proxy.json", "/home/rocketmq/conf/rmq-proxy.json")
.WithDataBindMount("../../.containers/rocketmq")
.WithJvmArgs(nameServerArgs: "-Xms256m -Xmx512m", brokerArgs: "-Xms256m -Xmx512m")
.AddTopic("AspireRocketMQSmoke");
Wait Guidance
- Use
WaitForRocketMQCompletion(rocketmq)for projects that depend on RocketMQ at startup. - Wait on runtime resources (
proxywhen present, otherwisenameserver).
Troubleshooting
- If app startup keeps waiting, verify both
WaitForRocketMQCompletion(...)andWithReference(rocketmq). - If proxy startup fails in topic bootstrap, verify NameServer/Broker health and bootstrap config.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Aspire.Hosting.AppHost (>= 13.3.5)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 10.0.7)
- Microsoft.Extensions.Http.Resilience (>= 10.5.0)
- YMJake.RocketMQ.Client (>= 5.5.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.