A need for a detailed documentation

[JefferyHus]

Thanks first for this Circuit breaker module and the time you spent crafting such a beauty, but I would like to know if there will be any detailed documentation of this module soon or later, as I am using it inside an HttpModule class in async mode, I was lost because I had a timeout value for my Http request and dunno how much MS should I give to the breaker in the invocation nor the reset. Also in your samples you have a code for aync use like this:

await circuitBreaker.ExecuteAsync(action);

I have tried this code but no such ExecuteAsync() method, that's why I ask for a more clarification of your work, thanks.

[alexandrnikitin]

Hi Jeffery,

Thanks for the kind words! The documentations is very much wanted. But I'm not sure I can find time in near future. Regarding timeout, it depends, mostly on your dependency, its latency and SLA.

Regarding async, please make sure you use the latest, 0.4.0 atm. The support was added in the 0.2.2 version. You can find a working sample code in the repo https://github.com/alexandrnikitin/CircuitBreaker.Net/blob/de0d81029f970e014c017632991101107411dff5/samples/CircuitBreaker.Net.Sample/Program.cs#L25

[JefferyHus]

Hi Alex,

Thanks for your reply :+1: , I would like to help you so I will be writing down some docs from time to time as I am using it in my work daily, I will make sure to report it if done, thanks lot :100:

[Caldas]

Hey @alexandrnikitin, a better documentation would be amazing 😉