Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create v2.3.0 release #269

Merged
merged 1 commit into from
Feb 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.BlockCreatedEventArgs class

Arguments for the BlockCreated event.
Arguments for the [`BlockCreated`](./RecyclableMemoryStreamManager/BlockCreated.md) event.

```csharp
public sealed class BlockCreatedEventArgs : EventArgs
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.BufferDiscardedEventArgs class

Arguments for the BufferDiscarded event.
Arguments for the [`BufferDiscarded`](./RecyclableMemoryStreamManager/BufferDiscarded.md) event.

```csharp
public sealed class BufferDiscardedEventArgs : EventArgs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Logged when a buffer is discarded (not put back in the pool, but given to GC to

```csharp
public void MemoryStreamDiscardBuffer(Guid guid, string tag, MemoryStreamBufferType bufferType,
MemoryStreamDiscardReason reason)
MemoryStreamDiscardReason reason, long smallBlocksFree, long smallPoolBytesFree,
long smallPoolBytesInUse, long largeBlocksFree, long largePoolBytesFree,
long largePoolBytesInUse)
```

| parameter | description |
Expand All @@ -13,6 +15,12 @@ public void MemoryStreamDiscardBuffer(Guid guid, string tag, MemoryStreamBufferT
| tag | A temporary ID for this stream, usually indicates current usage. |
| bufferType | Type of the buffer being discarded. |
| reason | Reason for the discard. |
| smallBlocksFree | Number of free small pool blocks. |
| smallPoolBytesFree | Bytes free in the small pool. |
| smallPoolBytesInUse | Bytes in use from the small pool. |
| largeBlocksFree | Number of free large pool blocks. |
| largePoolBytesFree | Bytes free in the large pool. |
| largePoolBytesInUse | Bytes in use from the large pool. |

## See Also

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
Logged when the stream is disposed.

```csharp
public void MemoryStreamDisposed(Guid guid, string tag, string allocationStack, string disposeStack)
public void MemoryStreamDisposed(Guid guid, string tag, TimeSpan lifetime, string allocationStack,
string disposeStack)
```

| parameter | description |
| --- | --- |
| guid | A unique ID for this stream. |
| tag | A temporary ID for this stream, usually indicates current usage. |
| lifetime | Lifetime of the stream |
| allocationStack | Call stack of initial allocation. |
| disposeStack | Call stack of the dispose. |

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs class

Arguments for the LargeBufferCreated events.
Arguments for the [`LargeBufferCreated`](./RecyclableMemoryStreamManager/LargeBufferCreated.md) events.

```csharp
public sealed class LargeBufferCreatedEventArgs : EventArgs
Expand All @@ -10,7 +10,7 @@ public sealed class LargeBufferCreatedEventArgs : EventArgs

| name | description |
| --- | --- |
| [CallStack](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/CallStack.md) { get; } | If the buffer was not satisfied from the pool, and GenerateCallstacks is turned on, then. this will contain the callstack of the allocation request. |
| [CallStack](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/CallStack.md) { get; } | If the buffer was not satisfied from the pool, and [`GenerateCallStacks`](./RecyclableMemoryStreamManager/GenerateCallStacks.md) is turned on, then. this will contain the callstack of the allocation request. |
| [Id](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/Id.md) { get; } | Unique ID for the stream. |
| [LargePoolInUse](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/LargePoolInUse.md) { get; } | How many bytes are in use from the large pool. |
| [Pooled](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/Pooled.md) { get; } | Whether the buffer was satisfied from the pool or not. |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.CallStack property

If the buffer was not satisfied from the pool, and GenerateCallstacks is turned on, then. this will contain the callstack of the allocation request.
If the buffer was not satisfied from the pool, and [`GenerateCallStacks`](../RecyclableMemoryStreamManager/GenerateCallStacks.md) is turned on, then. this will contain the callstack of the allocation request.

```csharp
public string CallStack { get; }
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs class

Arguments for the StreamConvertedToArray event.
Arguments for the [`StreamConvertedToArray`](./RecyclableMemoryStreamManager/StreamConvertedToArray.md) event.

```csharp
public sealed class StreamConvertedToArrayEventArgs : EventArgs
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.StreamCreatedEventArgs class

Arguments for the StreamCreated event.
Arguments for the [`StreamCreated`](./RecyclableMemoryStreamManager/StreamCreated.md) event.

```csharp
public sealed class StreamCreatedEventArgs : EventArgs
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.StreamDisposedEventArgs class

Arguments for the StreamDisposed event.
Arguments for the [`StreamDisposed`](./RecyclableMemoryStreamManager/StreamDisposed.md) event.

```csharp
public sealed class StreamDisposedEventArgs : EventArgs
Expand All @@ -10,10 +10,11 @@ public sealed class StreamDisposedEventArgs : EventArgs

| name | description |
| --- | --- |
| [StreamDisposedEventArgs](RecyclableMemoryStreamManager.StreamDisposedEventArgs/StreamDisposedEventArgs.md)(…) | Initializes a new instance of the [`StreamDisposedEventArgs`](./RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) class. |
| [StreamDisposedEventArgs](RecyclableMemoryStreamManager.StreamDisposedEventArgs/StreamDisposedEventArgs.md)(…) | Initializes a new instance of the [`StreamDisposedEventArgs`](./RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) class. (2 constructors) |
| [AllocationStack](RecyclableMemoryStreamManager.StreamDisposedEventArgs/AllocationStack.md) { get; } | Stack where the stream was allocated. |
| [DisposeStack](RecyclableMemoryStreamManager.StreamDisposedEventArgs/DisposeStack.md) { get; } | Stack where stream was disposed. |
| [Id](RecyclableMemoryStreamManager.StreamDisposedEventArgs/Id.md) { get; } | Unique ID for the stream. |
| [Lifetime](RecyclableMemoryStreamManager.StreamDisposedEventArgs/Lifetime.md) { get; } | Lifetime of the stream. |
| [Tag](RecyclableMemoryStreamManager.StreamDisposedEventArgs/Tag.md) { get; } | Optional Tag for the event. |

## See Also
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# RecyclableMemoryStreamManager.StreamDisposedEventArgs.Lifetime property

Lifetime of the stream.

```csharp
public TimeSpan Lifetime { get; }
```

## See Also

* class [StreamDisposedEventArgs](../RecyclableMemoryStreamManager.StreamDisposedEventArgs.md)
* namespace [Microsoft.IO](../../Microsoft.IO.RecyclableMemoryStream.md)

<!-- DO NOT EDIT: generated by xmldocmd for Microsoft.IO.RecyclableMemoryStream.dll -->
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# RecyclableMemoryStreamManager.StreamDisposedEventArgs constructor
# RecyclableMemoryStreamManager.StreamDisposedEventArgs constructor (1 of 2)

Initializes a new instance of the [`StreamDisposedEventArgs`](../RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) class.

```csharp
[Obsolete("Use another constructor override")]
public StreamDisposedEventArgs(Guid guid, string tag, string allocationStack, string disposeStack)
```

Expand All @@ -18,4 +19,28 @@ public StreamDisposedEventArgs(Guid guid, string tag, string allocationStack, st
* class [StreamDisposedEventArgs](../RecyclableMemoryStreamManager.StreamDisposedEventArgs.md)
* namespace [Microsoft.IO](../../Microsoft.IO.RecyclableMemoryStream.md)

---

# RecyclableMemoryStreamManager.StreamDisposedEventArgs constructor (2 of 2)

Initializes a new instance of the [`StreamDisposedEventArgs`](../RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) class.

```csharp
public StreamDisposedEventArgs(Guid guid, string tag, TimeSpan lifetime, string allocationStack,
string disposeStack)
```

| parameter | description |
| --- | --- |
| guid | Unique ID of the stream. |
| tag | Tag of the stream. |
| lifetime | Lifetime of the stream |
| allocationStack | Stack of original allocation. |
| disposeStack | Dispose stack. |

## See Also

* class [StreamDisposedEventArgs](../RecyclableMemoryStreamManager.StreamDisposedEventArgs.md)
* namespace [Microsoft.IO](../../Microsoft.IO.RecyclableMemoryStream.md)

<!-- DO NOT EDIT: generated by xmldocmd for Microsoft.IO.RecyclableMemoryStream.dll -->
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs class

Arguments for the StreamDoubleDisposed event.
Arguments for the [`StreamDoubleDisposed`](./RecyclableMemoryStreamManager/StreamDoubleDisposed.md) event.

```csharp
public sealed class StreamDoubleDisposedEventArgs : EventArgs
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.StreamFinalizedEventArgs class

Arguments for the StreamFinalized event.
Arguments for the [`StreamFinalized`](./RecyclableMemoryStreamManager/StreamFinalized.md) event.

```csharp
public sealed class StreamFinalizedEventArgs : EventArgs
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.StreamLengthEventArgs class

Arguments for the StreamLength event.
Arguments for the [`StreamLength`](./RecyclableMemoryStreamManager/StreamLength.md) event.

```csharp
public sealed class StreamLengthEventArgs : EventArgs
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.StreamOverCapacityEventArgs class

Arguments for the StreamOverCapacity event.
Arguments for the [`StreamOverCapacity`](./RecyclableMemoryStreamManager/StreamOverCapacity.md) event.

```csharp
public sealed class StreamOverCapacityEventArgs : EventArgs
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RecyclableMemoryStreamManager.UsageReportEventArgs class

Arguments for the UsageReport event.
Arguments for the [`UsageReport`](./RecyclableMemoryStreamManager/UsageReport.md) event.

```csharp
public sealed class UsageReportEventArgs : EventArgs
Expand Down
22 changes: 11 additions & 11 deletions docs/Microsoft.IO/RecyclableMemoryStreamManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,18 @@ public sealed class RecyclableMemoryStreamManager
| const [DefaultBlockSize](RecyclableMemoryStreamManager/DefaultBlockSize.md) | Default block size, in bytes. |
| const [DefaultLargeBufferMultiple](RecyclableMemoryStreamManager/DefaultLargeBufferMultiple.md) | Default large buffer multiple, in bytes. |
| const [DefaultMaximumBufferSize](RecyclableMemoryStreamManager/DefaultMaximumBufferSize.md) | Default maximum buffer size, in bytes. |
| class [BlockCreatedEventArgs](RecyclableMemoryStreamManager.BlockCreatedEventArgs.md) | Arguments for the BlockCreated event. |
| class [BufferDiscardedEventArgs](RecyclableMemoryStreamManager.BufferDiscardedEventArgs.md) | Arguments for the BufferDiscarded event. |
| class [BlockCreatedEventArgs](RecyclableMemoryStreamManager.BlockCreatedEventArgs.md) | Arguments for the [`BlockCreated`](./RecyclableMemoryStreamManager/BlockCreated.md) event. |
| class [BufferDiscardedEventArgs](RecyclableMemoryStreamManager.BufferDiscardedEventArgs.md) | Arguments for the [`BufferDiscarded`](./RecyclableMemoryStreamManager/BufferDiscarded.md) event. |
| class [Events](RecyclableMemoryStreamManager.Events.md) | ETW events for RecyclableMemoryStream. |
| class [LargeBufferCreatedEventArgs](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.md) | Arguments for the LargeBufferCreated events. |
| class [StreamConvertedToArrayEventArgs](RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.md) | Arguments for the StreamConvertedToArray event. |
| class [StreamCreatedEventArgs](RecyclableMemoryStreamManager.StreamCreatedEventArgs.md) | Arguments for the StreamCreated event. |
| class [StreamDisposedEventArgs](RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) | Arguments for the StreamDisposed event. |
| class [StreamDoubleDisposedEventArgs](RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.md) | Arguments for the StreamDoubleDisposed event. |
| class [StreamFinalizedEventArgs](RecyclableMemoryStreamManager.StreamFinalizedEventArgs.md) | Arguments for the StreamFinalized event. |
| class [StreamLengthEventArgs](RecyclableMemoryStreamManager.StreamLengthEventArgs.md) | Arguments for the StreamLength event. |
| class [StreamOverCapacityEventArgs](RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.md) | Arguments for the StreamOverCapacity event. |
| class [UsageReportEventArgs](RecyclableMemoryStreamManager.UsageReportEventArgs.md) | Arguments for the UsageReport event. |
| class [LargeBufferCreatedEventArgs](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.md) | Arguments for the [`LargeBufferCreated`](./RecyclableMemoryStreamManager/LargeBufferCreated.md) events. |
| class [StreamConvertedToArrayEventArgs](RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.md) | Arguments for the [`StreamConvertedToArray`](./RecyclableMemoryStreamManager/StreamConvertedToArray.md) event. |
| class [StreamCreatedEventArgs](RecyclableMemoryStreamManager.StreamCreatedEventArgs.md) | Arguments for the [`StreamCreated`](./RecyclableMemoryStreamManager/StreamCreated.md) event. |
| class [StreamDisposedEventArgs](RecyclableMemoryStreamManager.StreamDisposedEventArgs.md) | Arguments for the [`StreamDisposed`](./RecyclableMemoryStreamManager/StreamDisposed.md) event. |
| class [StreamDoubleDisposedEventArgs](RecyclableMemoryStreamManager.StreamDoubleDisposedEventArgs.md) | Arguments for the [`StreamDoubleDisposed`](./RecyclableMemoryStreamManager/StreamDoubleDisposed.md) event. |
| class [StreamFinalizedEventArgs](RecyclableMemoryStreamManager.StreamFinalizedEventArgs.md) | Arguments for the [`StreamFinalized`](./RecyclableMemoryStreamManager/StreamFinalized.md) event. |
| class [StreamLengthEventArgs](RecyclableMemoryStreamManager.StreamLengthEventArgs.md) | Arguments for the [`StreamLength`](./RecyclableMemoryStreamManager/StreamLength.md) event. |
| class [StreamOverCapacityEventArgs](RecyclableMemoryStreamManager.StreamOverCapacityEventArgs.md) | Arguments for the [`StreamOverCapacity`](./RecyclableMemoryStreamManager/StreamOverCapacity.md) event. |
| class [UsageReportEventArgs](RecyclableMemoryStreamManager.UsageReportEventArgs.md) | Arguments for the [`UsageReport`](./RecyclableMemoryStreamManager/UsageReport.md) event. |

## Remarks

Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.IO.RecyclableMemoryStream.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<DocumentationFile>bin\$(Configuration)\$(TargetFramework)\Microsoft.IO.RecyclableMemoryStream.xml</DocumentationFile>
<!-- NuGet properties -->
<PackageId>Microsoft.IO.RecyclableMemoryStream</PackageId>
<PackageVersion>2.2.1</PackageVersion>
<PackageVersion>2.3.0</PackageVersion>
<Title>Microsoft.IO.RecyclableMemoryStream</Title>
<Authors>Microsoft</Authors>
<Description>A pooled MemoryStream allocator to decrease GC load and improve performance on highly scalable systems.</Description>
Expand Down
4 changes: 2 additions & 2 deletions src/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
// You can specify all the values or you can default the Build and Revision Numbers
// by using the '*' as shown below:
// [assembly: AssemblyVersion("1.0.*")]
[assembly: AssemblyVersion("2.2.1.0")]
[assembly: AssemblyFileVersion("2.2.1.0")]
[assembly: AssemblyVersion("2.3.0.0")]
[assembly: AssemblyFileVersion("2.3.0.0")]

[assembly: CLSCompliant(true)]

Expand Down