File size: 9,121 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Diagnostics.CodeAnalysis;
using System.Diagnostics.PerformanceData;
namespace System.Management.Automation.PerformanceData
{
/// <summary>
/// A struct that encapsulates the information pertaining to a given counter
/// like name,type and id.
/// </summary>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1815:OverrideEqualsAndOperatorEqualsOnValueTypes")]
public struct CounterInfo
{
#region Private Members
#endregion
#region Constructors
/// <summary>
/// Constructor.
/// </summary>
public CounterInfo(int id, CounterType type, string name)
{
Id = id;
Type = type;
Name = name;
}
/// <summary>
/// Constructor.
/// </summary>
public CounterInfo(int id, CounterType type)
{
Id = id;
Type = type;
Name = null;
}
#endregion
#region Properties
/// <summary>
/// Getter for Counter Name property.
/// </summary>
public string Name { get; }
/// <summary>
/// Getter for Counter Id property.
/// </summary>
public int Id { get; }
/// <summary>
/// Getter for Counter Type property.
/// </summary>
[SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods")]
public CounterType Type { get; }
#endregion
}
/// <summary>
/// An abstract class that forms the base class for any CounterSetRegistrar type.
/// Any client that needs to register a new type of perf counter category with the
/// PSPerfCountersMgr, should create an instance of CounterSetRegistrarBase's
/// derived non-abstract type.
/// The created instance is then passed to PSPerfCounterMgr's AddCounterSetInstance()
/// method.
/// </summary>
public abstract class CounterSetRegistrarBase
{
#region Private Members
#endregion
#region Protected Members
/// <summary>
/// A reference to the encapsulated counter set instance.
/// </summary>
[SuppressMessage("Microsoft.Design", "CA1051:DoNotDeclareVisibleInstanceFields")]
protected CounterSetInstanceBase _counterSetInstanceBase;
/// <summary>
/// Method that creates an instance of the CounterSetInstanceBase's derived type.
/// This method is invoked by the PSPerfCountersMgr to retrieve the appropriate
/// instance of CounterSet to register with its internal datastructure.
/// </summary>
protected abstract CounterSetInstanceBase CreateCounterSetInstance();
#endregion
#region Constructors
/// <summary>
/// Constructor that creates an instance of CounterSetRegistrarBase derived type
/// based on Provider Id, counterSetId, counterSetInstanceType, a collection
/// with counters information and an optional counterSetName.
/// </summary>
protected CounterSetRegistrarBase(
Guid providerId,
Guid counterSetId,
CounterSetInstanceType counterSetInstType,
CounterInfo[] counterInfoArray,
string counterSetName = null)
{
ProviderId = providerId;
CounterSetId = counterSetId;
CounterSetInstType = counterSetInstType;
CounterSetName = counterSetName;
if (counterInfoArray is null || counterInfoArray.Length == 0)
{
throw new ArgumentNullException(nameof(counterInfoArray));
}
CounterInfoArray = new CounterInfo[counterInfoArray.Length];
for (int i = 0; i < counterInfoArray.Length; i++)
{
CounterInfoArray[i] =
new CounterInfo(
counterInfoArray[i].Id,
counterInfoArray[i].Type,
counterInfoArray[i].Name
);
}
this._counterSetInstanceBase = null;
}
/// <summary>
/// Copy constructor.
/// </summary>
protected CounterSetRegistrarBase(
CounterSetRegistrarBase srcCounterSetRegistrarBase)
{
ArgumentNullException.ThrowIfNull(srcCounterSetRegistrarBase);
ProviderId = srcCounterSetRegistrarBase.ProviderId;
CounterSetId = srcCounterSetRegistrarBase.CounterSetId;
CounterSetInstType = srcCounterSetRegistrarBase.CounterSetInstType;
CounterSetName = srcCounterSetRegistrarBase.CounterSetName;
CounterInfo[] counterInfoArrayRef = srcCounterSetRegistrarBase.CounterInfoArray;
CounterInfoArray = new CounterInfo[counterInfoArrayRef.Length];
for (int i = 0; i < counterInfoArrayRef.Length; i++)
{
CounterInfoArray[i] =
new CounterInfo(
counterInfoArrayRef[i].Id,
counterInfoArrayRef[i].Type,
counterInfoArrayRef[i].Name);
}
}
#endregion
#region Properties
/// <summary>
/// Getter method for ProviderId property.
/// </summary>
public Guid ProviderId { get; }
/// <summary>
/// Getter method for CounterSetId property.
/// </summary>
public Guid CounterSetId { get; }
/// <summary>
/// Getter method for CounterSetName property.
/// </summary>
public string CounterSetName { get; }
/// <summary>
/// Getter method for CounterSetInstanceType property.
/// </summary>
public CounterSetInstanceType CounterSetInstType { get; }
/// <summary>
/// Getter method for array of counters information property.
/// </summary>
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public CounterInfo[] CounterInfoArray { get; }
/// <summary>
/// Getter method that returns an instance of the CounterSetInstanceBase's
/// derived type.
/// </summary>
public CounterSetInstanceBase CounterSetInstance
{
get { return _counterSetInstanceBase ?? (_counterSetInstanceBase = CreateCounterSetInstance()); }
}
#endregion
#region Public Methods
/// <summary>
/// Method that disposes the referenced instance of the CounterSetInstanceBase's derived type.
/// This method is invoked by the PSPerfCountersMgr to dispose the appropriate
/// instance of CounterSet from its internal datastructure as part of PSPerfCountersMgr
/// cleanup procedure.
/// </summary>
public abstract void DisposeCounterSetInstance();
#endregion
}
/// <summary>
/// PSCounterSetRegistrar implements the abstract methods of CounterSetRegistrarBase.
/// Any client that needs to register a new type of perf counter category with the
/// PSPerfCountersMgr, should create an instance of PSCounterSetRegistrar.
/// The created instance is then passed to PSPerfCounterMgr's AddCounterSetInstance()
/// method.
/// </summary>
public class PSCounterSetRegistrar : CounterSetRegistrarBase
{
#region Constructors
/// <summary>
/// Constructor that creates an instance of PSCounterSetRegistrar.
/// </summary>
public PSCounterSetRegistrar(
Guid providerId,
Guid counterSetId,
CounterSetInstanceType counterSetInstType,
CounterInfo[] counterInfoArray,
string counterSetName = null)
: base(providerId, counterSetId, counterSetInstType, counterInfoArray, counterSetName)
{
}
/// <summary>
/// Copy Constructor.
/// </summary>
public PSCounterSetRegistrar(
PSCounterSetRegistrar srcPSCounterSetRegistrar)
: base(srcPSCounterSetRegistrar)
{
ArgumentNullException.ThrowIfNull(srcPSCounterSetRegistrar);
}
#endregion
#region CounterSetRegistrarBase Overrides
#region Protected Methods
/// <summary>
/// Method that creates an instance of the CounterSetInstanceBase's derived type.
/// </summary>
protected override CounterSetInstanceBase CreateCounterSetInstance()
{
return new PSCounterSetInstance(this);
}
#endregion
#region Public Methods
/// <summary>
/// Method that disposes the referenced instance of the CounterSetInstanceBase's derived type.
/// </summary>
public override void DisposeCounterSetInstance()
{
base._counterSetInstanceBase.Dispose();
}
#endregion
#endregion
}
}
|