Use RecyclableMemoryStream instead of MemoryStream

[Odonno]

What is done on this PR:

• Make use of a RecyclableMemoryStreamManager from the Microsoft.IO.RecyclableMemoryStream to recycle MemoryStream instead of having extensive use of the Garbage Collector. More info here: https://github.com/microsoft/Microsoft.IO.RecyclableMemoryStream

I have a benchmark in place for a project I am working on. Here are the result benchmarks.

Before:

Method	Mean	Error	StdDev	Gen0	Gen1	Allocated
HttpWithClientFactory	1,036.2 μs	8.33 μs	7.79 μs	15.6250	3.9063	253.87 KB
WsText	4,626.6 μs	49.26 μs	43.67 μs	39.0625	15.6250	2675.36 KB
WsBinary	NA	NA	NA	NA	NA	NA

After:

Method	Mean	Error	StdDev	Gen0	Gen1	Allocated
HttpWithClientFactory	1,033.3 us	4.92 us	4.37 us	15.6250	3.9063	253.67 KB
WsText	3,212.6 us	60.18 us	53.34 us	27.3438	7.8125	1166.44 KB
WsBinary	NA	NA	NA	NA	NA	NA

I put the HttpWithClientFactory in reference because it should have a very close performance impact to WsText. CPU time and memory allocation are reduced by 80%-120%. Of course, it depends on the use case. For some scenarii, there are absolutely no impact (small batch, few/no data consumption).

[Odonno]

Some notes:

• ResponseMessage now has a MemoryStream property
• Dispose of the Stream need to be handled manually for this so we can access the stream
• A new property on the client: IsStreamDisposedAutomatically, allows to handle the dispose manually to have access to inner MemoryStream...
• ...default value is true, stream will be disposed automatically/immediately and so we do not provide access to the MemoryStream (as it is disposed before access)
• refactor the code around ReceiveClient to fully use the RecyclableMemoryStream & use recommended Memory<byte> instead of ArraySegment<byte> (except for .NET Standard 2.0) => I did not perceive any significant impact in terms of performance/memory allocation doing that, and the code is way cleaner

I made some final touches and now it is good for review.

[Odonno]

Just a final final touch:

• Add SendTextAsBinary and SendTextAsBinaryAsync methods to send TEXT message without having to serialize again from string to byte[]. On benchmark, it reduces memory allocation by half.

[Marfusios]

Thanks @Odonno for a nicely prepared PR, I'm going to review it

[Odonno]

Hi @Marfusios

Thank you for your effort. I resolved the conflicts after your changes. Mostly nullable reference types. Not sure if I am 100% compliant on this topic. Will make some check later to see if it works as expected.

[Odonno]

Since you upgraded to .NET Standard 2.1, I removed pragma conditions for .NET Standard 2.0.

[Odonno]

Hi @Marfusios

When do you think you can review this PR?

[kresseandreas51]

Bitte um unterstützung beim verifizieren der Dockomente Mit freundlichen gruß Kresse Andreas Am Di., 3. Okt. 2023 um 19:47 Uhr schrieb David Bottiau < ***@***.***>:

…

Hi @Marfusios <https://github.com/Marfusios> When do you think you can review this PR? — Reply to this email directly, view it on GitHub <#133 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A527QUGF4LXYEBP3NLFIC33X5RFR7AVCNFSM6AAAAAA3JA4IEOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONBVGQ2DKNBUG4> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[Marfusios]

Hey, finally got to it, thanks for the PR, looks good to me from here, will test it locally after the merge and do some slight polishing