Skip to content

Commit 27f27f4

Browse files
benmwatsonBen Watson
andauthored
Update version numbers, regenerate documentation (#269)
Co-authored-by: Ben Watson <bewatson@microsoft.com>
1 parent ef7f82f commit 27f27f4

19 files changed

+81
-31
lines changed

docs/Microsoft.IO/RecyclableMemoryStreamManager.BlockCreatedEventArgs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RecyclableMemoryStreamManager.BlockCreatedEventArgs class
22

3-
Arguments for the BlockCreated event.
3+
Arguments for the [`BlockCreated`](./RecyclableMemoryStreamManager/BlockCreated.md) event.
44

55
```csharp
66
public sealed class BlockCreatedEventArgs : EventArgs

docs/Microsoft.IO/RecyclableMemoryStreamManager.BufferDiscardedEventArgs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RecyclableMemoryStreamManager.BufferDiscardedEventArgs class
22

3-
Arguments for the BufferDiscarded event.
3+
Arguments for the [`BufferDiscarded`](./RecyclableMemoryStreamManager/BufferDiscarded.md) event.
44

55
```csharp
66
public sealed class BufferDiscardedEventArgs : EventArgs

docs/Microsoft.IO/RecyclableMemoryStreamManager.Events/MemoryStreamDiscardBuffer.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Logged when a buffer is discarded (not put back in the pool, but given to GC to
44

55
```csharp
66
public void MemoryStreamDiscardBuffer(Guid guid, string tag, MemoryStreamBufferType bufferType,
7-
MemoryStreamDiscardReason reason)
7+
MemoryStreamDiscardReason reason, long smallBlocksFree, long smallPoolBytesFree,
8+
long smallPoolBytesInUse, long largeBlocksFree, long largePoolBytesFree,
9+
long largePoolBytesInUse)
810
```
911

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

1725
## See Also
1826

docs/Microsoft.IO/RecyclableMemoryStreamManager.Events/MemoryStreamDisposed.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
Logged when the stream is disposed.
44

55
```csharp
6-
public void MemoryStreamDisposed(Guid guid, string tag, string allocationStack, string disposeStack)
6+
public void MemoryStreamDisposed(Guid guid, string tag, TimeSpan lifetime, string allocationStack,
7+
string disposeStack)
78
```
89

910
| parameter | description |
1011
| --- | --- |
1112
| guid | A unique ID for this stream. |
1213
| tag | A temporary ID for this stream, usually indicates current usage. |
14+
| lifetime | Lifetime of the stream |
1315
| allocationStack | Call stack of initial allocation. |
1416
| disposeStack | Call stack of the dispose. |
1517

docs/Microsoft.IO/RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs class
22

3-
Arguments for the LargeBufferCreated events.
3+
Arguments for the [`LargeBufferCreated`](./RecyclableMemoryStreamManager/LargeBufferCreated.md) events.
44

55
```csharp
66
public sealed class LargeBufferCreatedEventArgs : EventArgs
@@ -10,7 +10,7 @@ public sealed class LargeBufferCreatedEventArgs : EventArgs
1010

1111
| name | description |
1212
| --- | --- |
13-
| [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. |
13+
| [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. |
1414
| [Id](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/Id.md) { get; } | Unique ID for the stream. |
1515
| [LargePoolInUse](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/LargePoolInUse.md) { get; } | How many bytes are in use from the large pool. |
1616
| [Pooled](RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/Pooled.md) { get; } | Whether the buffer was satisfied from the pool or not. |

docs/Microsoft.IO/RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs/CallStack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RecyclableMemoryStreamManager.LargeBufferCreatedEventArgs.CallStack property
22

3-
If the buffer was not satisfied from the pool, and GenerateCallstacks is turned on, then. this will contain the callstack of the allocation request.
3+
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.
44

55
```csharp
66
public string CallStack { get; }

docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RecyclableMemoryStreamManager.StreamConvertedToArrayEventArgs class
22

3-
Arguments for the StreamConvertedToArray event.
3+
Arguments for the [`StreamConvertedToArray`](./RecyclableMemoryStreamManager/StreamConvertedToArray.md) event.
44

55
```csharp
66
public sealed class StreamConvertedToArrayEventArgs : EventArgs

docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamCreatedEventArgs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RecyclableMemoryStreamManager.StreamCreatedEventArgs class
22

3-
Arguments for the StreamCreated event.
3+
Arguments for the [`StreamCreated`](./RecyclableMemoryStreamManager/StreamCreated.md) event.
44

55
```csharp
66
public sealed class StreamCreatedEventArgs : EventArgs

docs/Microsoft.IO/RecyclableMemoryStreamManager.StreamDisposedEventArgs.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# RecyclableMemoryStreamManager.StreamDisposedEventArgs class
22

3-
Arguments for the StreamDisposed event.
3+
Arguments for the [`StreamDisposed`](./RecyclableMemoryStreamManager/StreamDisposed.md) event.
44

55
```csharp
66
public sealed class StreamDisposedEventArgs : EventArgs
@@ -10,10 +10,11 @@ public sealed class StreamDisposedEventArgs : EventArgs
1010

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

1920
## See Also
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# RecyclableMemoryStreamManager.StreamDisposedEventArgs.Lifetime property
2+
3+
Lifetime of the stream.
4+
5+
```csharp
6+
public TimeSpan Lifetime { get; }
7+
```
8+
9+
## See Also
10+
11+
* class [StreamDisposedEventArgs](../RecyclableMemoryStreamManager.StreamDisposedEventArgs.md)
12+
* namespace [Microsoft.IO](../../Microsoft.IO.RecyclableMemoryStream.md)
13+
14+
<!-- DO NOT EDIT: generated by xmldocmd for Microsoft.IO.RecyclableMemoryStream.dll -->

0 commit comments

Comments
 (0)