lib/fullscreen.Collector.xml
|
<?xml version="1.0"?> <doc> <assembly> <name>fullscreen.Collector</name> </assembly> <members> <member name="T:fullscreen.Monitoring.CollectorMetrics"> <summary>Selects which performance counters a collection cycle refreshes.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.None"> <summary>Collects no optional metric groups.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.Processes"> <summary>Collects processes metrics.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.Cpu"> <summary>Collects cpu metrics.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.Memory"> <summary>Collects memory metrics.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.Network"> <summary>Collects network metrics.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.Gpu"> <summary>Collects gpu metrics.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.ProcessGpu"> <summary>Collects process gpu metrics.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.ProcessDisk"> <summary>Collects process disk metrics.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.ProcessNetwork"> <summary>Collects process network metrics.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.Owners"> <summary>Collects owners metrics.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.Services"> <summary>Collects services metrics.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.Users"> <summary>Collects users metrics.</summary> </member> <member name="F:fullscreen.Monitoring.CollectorMetrics.All"> <summary>Collects all supported metric groups.</summary> </member> <member name="T:fullscreen.Monitoring.NetworkRow"> <summary>Stores network-interface identity, throughput, and cumulative counters.</summary> <param name="Id">The stable resource or process identifier.</param> <param name="Name">The display name.</param> <param name="ReceiveBytesPerSecond">The network receive rate in bytes per second, or null when unavailable.</param> <param name="SendBytesPerSecond">The network send rate in bytes per second, or null when unavailable.</param> <param name="ReceivedBytes">The cumulative received byte count.</param> <param name="SentBytes">The cumulative sent byte count.</param> <param name="Errors">The collection errors associated with the row.</param> <param name="Speed">The interface link speed in bits per second.</param> </member> <member name="M:fullscreen.Monitoring.NetworkRow.#ctor(System.String,System.String,System.Nullable{System.Double},System.Nullable{System.Double},System.Int64,System.Int64,System.Int64,System.Int64)"> <summary>Stores network-interface identity, throughput, and cumulative counters.</summary> <param name="Id">The stable resource or process identifier.</param> <param name="Name">The display name.</param> <param name="ReceiveBytesPerSecond">The network receive rate in bytes per second, or null when unavailable.</param> <param name="SendBytesPerSecond">The network send rate in bytes per second, or null when unavailable.</param> <param name="ReceivedBytes">The cumulative received byte count.</param> <param name="SentBytes">The cumulative sent byte count.</param> <param name="Errors">The collection errors associated with the row.</param> <param name="Speed">The interface link speed in bits per second.</param> </member> <member name="P:fullscreen.Monitoring.NetworkRow.Id"> <summary>The stable resource or process identifier.</summary> </member> <member name="P:fullscreen.Monitoring.NetworkRow.Name"> <summary>The display name.</summary> </member> <member name="P:fullscreen.Monitoring.NetworkRow.ReceiveBytesPerSecond"> <summary>The network receive rate in bytes per second, or null when unavailable.</summary> </member> <member name="P:fullscreen.Monitoring.NetworkRow.SendBytesPerSecond"> <summary>The network send rate in bytes per second, or null when unavailable.</summary> </member> <member name="P:fullscreen.Monitoring.NetworkRow.ReceivedBytes"> <summary>The cumulative received byte count.</summary> </member> <member name="P:fullscreen.Monitoring.NetworkRow.SentBytes"> <summary>The cumulative sent byte count.</summary> </member> <member name="P:fullscreen.Monitoring.NetworkRow.Errors"> <summary>The collection errors associated with the row.</summary> </member> <member name="P:fullscreen.Monitoring.NetworkRow.Speed"> <summary>The interface link speed in bits per second.</summary> </member> <member name="T:fullscreen.Monitoring.GpuRow"> <summary>Stores graphics-device utilization, memory usage, and temperature.</summary> <param name="Name">The display name.</param> <param name="Provider">The platform provider that supplied the device metrics.</param> <param name="Utilization">The graphics-device utilization percentage, or null when unavailable.</param> <param name="UsedMemory">The used graphics-device memory in bytes, or null when unavailable.</param> <param name="TotalMemory">The total physical memory in bytes.</param> <param name="Temperature">The device temperature in degrees Celsius, or null when unavailable.</param> </member> <member name="M:fullscreen.Monitoring.GpuRow.#ctor(System.String,System.String,System.Nullable{System.Double},System.Nullable{System.UInt64},System.Nullable{System.UInt64},System.Nullable{System.Double})"> <summary>Stores graphics-device utilization, memory usage, and temperature.</summary> <param name="Name">The display name.</param> <param name="Provider">The platform provider that supplied the device metrics.</param> <param name="Utilization">The graphics-device utilization percentage, or null when unavailable.</param> <param name="UsedMemory">The used graphics-device memory in bytes, or null when unavailable.</param> <param name="TotalMemory">The total physical memory in bytes.</param> <param name="Temperature">The device temperature in degrees Celsius, or null when unavailable.</param> </member> <member name="P:fullscreen.Monitoring.GpuRow.Name"> <summary>The display name.</summary> </member> <member name="P:fullscreen.Monitoring.GpuRow.Provider"> <summary>The platform provider that supplied the device metrics.</summary> </member> <member name="P:fullscreen.Monitoring.GpuRow.Utilization"> <summary>The graphics-device utilization percentage, or null when unavailable.</summary> </member> <member name="P:fullscreen.Monitoring.GpuRow.UsedMemory"> <summary>The used graphics-device memory in bytes, or null when unavailable.</summary> </member> <member name="P:fullscreen.Monitoring.GpuRow.TotalMemory"> <summary>The total physical memory in bytes.</summary> </member> <member name="P:fullscreen.Monitoring.GpuRow.Temperature"> <summary>The device temperature in degrees Celsius, or null when unavailable.</summary> </member> <member name="T:fullscreen.Monitoring.ServiceRow"> <summary>Stores a service's display metadata and optional process ownership.</summary> <param name="Name">The display name.</param> <param name="Description">The human-readable description.</param> <param name="State">The state exposed to the current view or callback.</param> <param name="Detail">The additional display text for the row.</param> <param name="ProcessId">The associated process identifier, or null when unavailable.</param> <param name="UserName">The account name associated with the session or process. Defaults to null.</param> </member> <member name="M:fullscreen.Monitoring.ServiceRow.#ctor(System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.String)"> <summary>Stores a service's display metadata and optional process ownership.</summary> <param name="Name">The display name.</param> <param name="Description">The human-readable description.</param> <param name="State">The state exposed to the current view or callback.</param> <param name="Detail">The additional display text for the row.</param> <param name="ProcessId">The associated process identifier, or null when unavailable.</param> <param name="UserName">The account name associated with the session or process. Defaults to null.</param> </member> <member name="P:fullscreen.Monitoring.ServiceRow.Name"> <summary>The display name.</summary> </member> <member name="P:fullscreen.Monitoring.ServiceRow.Description"> <summary>The human-readable description.</summary> </member> <member name="P:fullscreen.Monitoring.ServiceRow.State"> <summary>The state exposed to the current view or callback.</summary> </member> <member name="P:fullscreen.Monitoring.ServiceRow.Detail"> <summary>The additional display text for the row.</summary> </member> <member name="P:fullscreen.Monitoring.ServiceRow.ProcessId"> <summary>The associated process identifier, or null when unavailable.</summary> </member> <member name="P:fullscreen.Monitoring.ServiceRow.UserName"> <summary>The account name associated with the session or process. Defaults to null.</summary> </member> <member name="T:fullscreen.Monitoring.UserSessionRow"> <summary>Stores a named login session and its client, idle, and logon metadata.</summary> <param name="UserName">The account name associated with the session or process.</param> <param name="Session">The existing PowerShell remoting session.</param> <param name="State">The state exposed to the current view or callback.</param> <param name="Host">The GitHub host name.</param> <param name="LoginTime">The formatted login timestamp.</param> <param name="SessionId">The Windows terminal-services session identifier. Defaults to null.</param> <param name="LogonTime">The expected Windows logon FILETIME used to reject a reused session identifier. Defaults to null.</param> <param name="IdleTime">The time elapsed since the session's last input, or null when unavailable. Defaults to null.</param> <param name="LastInputTime">The session's last-input timestamp, or null when unavailable. Defaults to null.</param> <param name="ConnectTime">The session connection timestamp, or null when unavailable. Defaults to null.</param> <param name="DisconnectTime">The session disconnection timestamp, or null when unavailable. Defaults to null.</param> <param name="ClientName">The terminal-services client computer name. Defaults to "".</param> <param name="Protocol">The terminal-services connection protocol. Defaults to "".</param> </member> <member name="M:fullscreen.Monitoring.UserSessionRow.#ctor(System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.DateTimeOffset},System.Nullable{System.TimeSpan},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.String,System.String)"> <summary>Stores a named login session and its client, idle, and logon metadata.</summary> <param name="UserName">The account name associated with the session or process.</param> <param name="Session">The existing PowerShell remoting session.</param> <param name="State">The state exposed to the current view or callback.</param> <param name="Host">The GitHub host name.</param> <param name="LoginTime">The formatted login timestamp.</param> <param name="SessionId">The Windows terminal-services session identifier. Defaults to null.</param> <param name="LogonTime">The expected Windows logon FILETIME used to reject a reused session identifier. Defaults to null.</param> <param name="IdleTime">The time elapsed since the session's last input, or null when unavailable. Defaults to null.</param> <param name="LastInputTime">The session's last-input timestamp, or null when unavailable. Defaults to null.</param> <param name="ConnectTime">The session connection timestamp, or null when unavailable. Defaults to null.</param> <param name="DisconnectTime">The session disconnection timestamp, or null when unavailable. Defaults to null.</param> <param name="ClientName">The terminal-services client computer name. Defaults to "".</param> <param name="Protocol">The terminal-services connection protocol. Defaults to "".</param> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.UserName"> <summary>The account name associated with the session or process.</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.Session"> <summary>The existing PowerShell remoting session.</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.State"> <summary>The state exposed to the current view or callback.</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.Host"> <summary>The GitHub host name.</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.LoginTime"> <summary>The formatted login timestamp.</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.SessionId"> <summary>The Windows terminal-services session identifier. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.LogonTime"> <summary>The expected Windows logon FILETIME used to reject a reused session identifier. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.IdleTime"> <summary>The time elapsed since the session's last input, or null when unavailable. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.LastInputTime"> <summary>The session's last-input timestamp, or null when unavailable. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.ConnectTime"> <summary>The session connection timestamp, or null when unavailable. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.DisconnectTime"> <summary>The session disconnection timestamp, or null when unavailable. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.ClientName"> <summary>The terminal-services client computer name. Defaults to "".</summary> </member> <member name="P:fullscreen.Monitoring.UserSessionRow.Protocol"> <summary>The terminal-services connection protocol. Defaults to "".</summary> </member> <member name="T:fullscreen.Monitoring.CollectorFrame"> <summary>Reusable snapshot. Counts delimit valid array entries; arrays never escape the source's gate.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.MachineName"> <summary>Gets or sets the machine that produced the snapshot.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.Platform"> <summary>Gets or sets the operating-system label reported by the collector.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.CapturedAt"> <summary>Gets or sets the timestamp of metric capture.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.CpuPercent"> <summary>Gets or sets the CPU utilization percentage.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.TotalMemory"> <summary>Gets or sets the total physical memory in bytes.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.AvailableMemory"> <summary>Gets or sets the available physical memory in bytes.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.SampleMilliseconds"> <summary>Gets or sets the elapsed metric-collection time in milliseconds.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.SampleAllocation"> <summary>Gets or sets the managed allocation count in bytes for the capture.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.Processes"> <summary>Gets or sets whether per-process GPU counters are collected.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.Networks"> <summary>Gets or sets the reusable network row buffer; only the counted prefix is active.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.Gpus"> <summary>Gets or sets the reusable graphics-device row buffer; only the counted prefix is active.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.Services"> <summary>Gets or sets the reusable service buffer; only ServiceCount entries are active.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.Users"> <summary>Gets or sets the reusable login-session buffer; only UserCount entries are active.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.UserCount"> <summary>Gets or sets the number of valid login-session rows.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.UserStatus"> <summary>Gets or sets the login-session collection status message.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.ServiceCount"> <summary>Gets or sets the number of valid service rows.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.ServiceStatus"> <summary>Gets or sets the service collection status message.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.ProcessCount"> <summary>Gets or sets the number of valid process rows in the process buffer.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.NetworkCount"> <summary>Gets or sets the number of valid network-interface rows.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.GpuCount"> <summary>Gets or sets the number of valid graphics-device rows.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.GpuStatus"> <summary>Gets or sets the graphics collection status message.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.NetworkStatus"> <summary>Gets or sets the network collection status message.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.ReceiveBytesPerSecond"> <summary>Gets or sets the network receive rate in bytes per second, or null when unavailable.</summary> </member> <member name="P:fullscreen.Monitoring.CollectorFrame.SendBytesPerSecond"> <summary>Gets or sets the network send rate in bytes per second, or null when unavailable.</summary> </member> <member name="M:fullscreen.Monitoring.CollectorFrame.CopyFrom(fullscreen.Monitoring.CollectorFrame)"> <summary>Copies the active data in another frame into this frame's reusable buffers.</summary> <param name="other">The source frame to copy.</param> </member> <member name="M:fullscreen.Monitoring.CollectorFrame.EnsureCapacity``1(``0[],System.Int32)"> <summary>Grows an array only when its current capacity is insufficient.</summary> <param name="array">The existing array to reuse when its capacity is sufficient.</param> <param name="count">The minimum required array capacity.</param> <typeparam name="T">The element type stored in the buffer.</typeparam> <returns>The existing array or a larger replacement.</returns> </member> <member name="T:fullscreen.Monitoring.CollectorSessions"> <summary>Owns independent collectors for remote callers without PowerShell session variables.</summary> </member> <member name="M:fullscreen.Monitoring.CollectorSessions.LogoffSession(System.Int32,System.String,System.Int64)"> <summary>Revalidates a named session's identity before logging it off.</summary> <param name="sessionId">The Windows terminal-services session identifier.</param> <param name="userName">The account name associated with the session or process.</param> <param name="logonTime">The expected Windows logon FILETIME used to reject a reused session identifier.</param> </member> <member name="M:fullscreen.Monitoring.CollectorSessions.Open(System.String)"> <summary>Creates a collector associated with an opaque handle.</summary> <param name="handle">The opaque identifier of a reusable collector.</param> </member> <member name="M:fullscreen.Monitoring.CollectorSessions.IsOpen(System.String)"> <summary>Checks whether an opaque collector handle is active.</summary> <param name="handle">The opaque identifier of a reusable collector.</param> <returns>True when the handle identifies an active collector.</returns> </member> <member name="M:fullscreen.Monitoring.CollectorSessions.CaptureBase64(System.String,System.Int32)"> <summary>Captures selected metrics and serializes the frame for remoting.</summary> <param name="handle">The opaque identifier of a reusable collector.</param> <param name="metrics">The numeric CollectorMetrics flags requested for this capture.</param> <returns>The Base64-encoded frame.</returns> </member> <member name="M:fullscreen.Monitoring.CollectorSessions.InvalidateServices(System.String)"> <summary>Requests refresh of cached service metadata for a collector.</summary> <param name="handle">The opaque identifier of a reusable collector.</param> </member> <member name="M:fullscreen.Monitoring.CollectorSessions.Close(System.String)"> <summary>Disposes the collector associated with a handle.</summary> <param name="handle">The opaque identifier of a reusable collector.</param> </member> <member name="T:fullscreen.Monitoring.EtwIoCounters"> <summary>Only kernel byte counters and thread identities; no event objects or payload copies.</summary> </member> <member name="M:fullscreen.Monitoring.EtwIoCounters.#ctor(System.Boolean,System.Boolean)"> <summary>Only kernel byte counters and thread identities; no event objects or payload copies.</summary> </member> <member name="T:fullscreen.Monitoring.FrameCodec"> <summary>Versioned wire format. Only populated rows cross PSRP; no TUI dependencies or deserialized CLR types.</summary> </member> <member name="M:fullscreen.Monitoring.FrameCodec.Encode(fullscreen.Monitoring.CollectorFrame)"> <summary>Serializes the active portions of a collector frame.</summary> <param name="frame">The reusable collector frame to encode or populate.</param> <returns>The encoded frame bytes.</returns> </member> <member name="M:fullscreen.Monitoring.FrameCodec.Decode(System.Byte[],fullscreen.Monitoring.CollectorFrame)"> <summary>Decodes transported frame data into reusable destination buffers.</summary> <param name="bytes">The binary frame produced by Encode.</param> <param name="frame">The reusable collector frame to encode or populate.</param> </member> <member name="T:fullscreen.Monitoring.GpuSampler"> <summary>Samples graphics-device and per-process GPU counters where supported.</summary> </member> <member name="M:fullscreen.Monitoring.GpuSampler.Sample(fullscreen.Monitoring.CollectorFrame,System.Boolean,System.Boolean)"> <summary>Updates graphics-device and optional per-process GPU counters in a frame.</summary> <param name="frame">The reusable metric snapshot to read or fill.</param> <param name="devices">Whether device-wide GPU counters are collected. Defaults to true.</param> <param name="processes">Whether per-process GPU counters are collected. Defaults to true.</param> </member> <member name="M:fullscreen.Monitoring.GpuSampler.Enrich(fullscreen.Monitoring.ProcessRow[],System.Int32)"> <summary>Adds sampled GPU counters to active process rows.</summary> <param name="rows">The source rows or requested terminal row count.</param> <param name="count">The active entry count.</param> </member> <member name="M:fullscreen.Monitoring.GpuSampler.Dispose"> <inheritdoc/> </member> <member name="T:fullscreen.Monitoring.NetworkSampler"> <summary>Samples network-interface counters and calculates transfer rates.</summary> </member> <member name="M:fullscreen.Monitoring.NetworkSampler.Sample(fullscreen.Monitoring.CollectorFrame)"> <summary>Updates network-interface counters and rates in a frame.</summary> <param name="frame">The reusable metric snapshot to read or fill.</param> </member> <member name="M:fullscreen.Monitoring.NetworkSampler.Rate(System.Int64,System.Int64,System.Double)"> <summary>Calculates a transfer rate from monotonic counter samples.</summary> <param name="current">The current monotonic counter sample.</param> <param name="previous">The previous monotonic counter sample.</param> <param name="seconds">The elapsed seconds between counter samples.</param> <returns>The per-second rate, or null when a valid rate cannot be calculated.</returns> </member> <member name="T:fullscreen.Monitoring.NvmlSampler"> <summary>Optional NVIDIA driver API. Cached entry points keep their library loaded for process lifetime.</summary> </member> <member name="T:fullscreen.Monitoring.PerformanceCollector"> <summary>Runtime-only collector; safe to load into a remote PowerShell process without the UI or module.</summary> </member> <member name="P:fullscreen.Monitoring.PerformanceCollector.Frame"> <summary>Gets the reusable metric snapshot to read or fill.</summary> </member> <member name="M:fullscreen.Monitoring.PerformanceCollector.Capture"> <summary>Refreshes requested metrics in the collector's reusable frame.</summary> <returns>The reusable frame; copy it before retaining it across later captures.</returns> </member> <member name="M:fullscreen.Monitoring.PerformanceCollector.Capture(fullscreen.Monitoring.CollectorMetrics)"> <summary>Refreshes requested metrics in the collector's reusable frame.</summary> <param name="metrics">The metric groups requested for this capture.</param> <returns>The reusable frame; copy it before retaining it across later captures.</returns> </member> <member name="M:fullscreen.Monitoring.PerformanceCollector.CaptureBase64"> <summary>Captures metrics and serializes the active frame for transport.</summary> <returns>The Base64-encoded frame.</returns> </member> <member name="M:fullscreen.Monitoring.PerformanceCollector.InvalidateServices"> <summary>Requests refresh of cached service metadata on the next applicable capture.</summary> </member> <member name="M:fullscreen.Monitoring.PerformanceCollector.InvalidateUsers"> <summary>Requests refresh of cached login-session metadata on the next applicable capture.</summary> </member> <member name="M:fullscreen.Monitoring.PerformanceCollector.CaptureBase64(System.Int32)"> <summary>Captures metrics and serializes the active frame for transport.</summary> <param name="metrics">The metric groups requested for this capture.</param> <returns>The Base64-encoded frame.</returns> </member> <member name="M:fullscreen.Monitoring.PerformanceCollector.Dispose"> <inheritdoc/> </member> <member name="T:fullscreen.Monitoring.ProcessOwnerReader"> <summary>Read-only ownership metadata. Native handles are lexical; denied lookups are cached as unknown.</summary> </member> <member name="M:fullscreen.Monitoring.ProcessOwnerReader.Read(System.Int32,System.Int64,System.Nullable{System.UInt32})"> <summary>Resolves ownership for a process identity, using the platform cache where possible.</summary> <param name="id">The stable resource or process identifier.</param> <param name="birth">The process start identity used to distinguish reused process identifiers.</param> <param name="uid">The effective user identifier. Defaults to null.</param> <returns>The owner name, or null when ownership cannot be resolved.</returns> </member> <member name="M:fullscreen.Monitoring.ProcessOwnerReader.Remove(System.Int32)"> <summary>Removes a process identifier from the ownership cache.</summary> <param name="id">The stable resource or process identifier.</param> </member> <member name="M:fullscreen.Monitoring.ProcessOwnerReader.ReadMacIdentity(System.Int32,System.Int64,System.Nullable{System.Int32}@,System.Nullable{System.UInt32}@)"> <summary>Reads the parent identifier and effective user identifier for a macOS process.</summary> <param name="id">The stable resource or process identifier.</param> <param name="birth">The process start identity used to distinguish reused process identifiers.</param> <param name="parent">The parent directory or returned parent process identifier.</param> <param name="uid">The effective user identifier.</param> </member> <member name="M:fullscreen.Monitoring.ProcessOwnerReader.TryReadEffectiveUid(System.Byte[],System.UInt32@)"> <summary>Parses the effective user identifier from Linux procfs status bytes.</summary> <param name="text">The source text to parse or display.</param> <param name="uid">The effective user identifier.</param> <returns>True when an effective user identifier was parsed.</returns> </member> <member name="T:fullscreen.Monitoring.ProcessRow"> <summary>Stores process identity, resource usage, ownership, and optional platform metadata.</summary> <param name="Id">The stable resource or process identifier.</param> <param name="Name">The display name.</param> <param name="CpuPercent">The CPU utilization percentage.</param> <param name="WorkingSet">The resident process memory in bytes.</param> <param name="Threads">The process thread count.</param> <param name="GpuPercent">The process GPU utilization percentage, or null when unavailable. Defaults to null.</param> <param name="GpuMemory">The process graphics memory usage in bytes, or null when unavailable. Defaults to null.</param> <param name="ParentId">The parent process identifier, or null when unavailable. Defaults to null.</param> <param name="UserName">The account name associated with the session or process. Defaults to null.</param> <param name="StartTimeTicks">The process start identity used to distinguish reused identifiers. Defaults to 0.</param> <param name="CpuTimeTicks">The accumulated process CPU time in TimeSpan ticks. Defaults to 0.</param> <param name="Status">The raw Git porcelain status text. Defaults to null.</param> <param name="DiskBytesPerSecond">The process disk throughput in bytes per second, or null when unavailable. Defaults to null.</param> <param name="NetworkBytesPerSecond">The process network throughput in bytes per second, or null when unavailable. Defaults to null.</param> </member> <member name="M:fullscreen.Monitoring.ProcessRow.#ctor(System.Int32,System.String,System.Double,System.Int64,System.Int32,System.Nullable{System.Double},System.Nullable{System.UInt64},System.Nullable{System.Int32},System.String,System.Int64,System.Int64,System.String,System.Nullable{System.Double},System.Nullable{System.Double})"> <summary>Stores process identity, resource usage, ownership, and optional platform metadata.</summary> <param name="Id">The stable resource or process identifier.</param> <param name="Name">The display name.</param> <param name="CpuPercent">The CPU utilization percentage.</param> <param name="WorkingSet">The resident process memory in bytes.</param> <param name="Threads">The process thread count.</param> <param name="GpuPercent">The process GPU utilization percentage, or null when unavailable. Defaults to null.</param> <param name="GpuMemory">The process graphics memory usage in bytes, or null when unavailable. Defaults to null.</param> <param name="ParentId">The parent process identifier, or null when unavailable. Defaults to null.</param> <param name="UserName">The account name associated with the session or process. Defaults to null.</param> <param name="StartTimeTicks">The process start identity used to distinguish reused identifiers. Defaults to 0.</param> <param name="CpuTimeTicks">The accumulated process CPU time in TimeSpan ticks. Defaults to 0.</param> <param name="Status">The raw Git porcelain status text. Defaults to null.</param> <param name="DiskBytesPerSecond">The process disk throughput in bytes per second, or null when unavailable. Defaults to null.</param> <param name="NetworkBytesPerSecond">The process network throughput in bytes per second, or null when unavailable. Defaults to null.</param> </member> <member name="P:fullscreen.Monitoring.ProcessRow.Id"> <summary>The stable resource or process identifier.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.Name"> <summary>The display name.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.CpuPercent"> <summary>The CPU utilization percentage.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.WorkingSet"> <summary>The resident process memory in bytes.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.Threads"> <summary>The process thread count.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.GpuPercent"> <summary>The process GPU utilization percentage, or null when unavailable. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.GpuMemory"> <summary>The process graphics memory usage in bytes, or null when unavailable. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.ParentId"> <summary>The parent process identifier, or null when unavailable. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.UserName"> <summary>The account name associated with the session or process. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.StartTimeTicks"> <summary>The process start identity used to distinguish reused identifiers. Defaults to 0.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.CpuTimeTicks"> <summary>The accumulated process CPU time in TimeSpan ticks. Defaults to 0.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.Status"> <summary>The raw Git porcelain status text. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.DiskBytesPerSecond"> <summary>The process disk throughput in bytes per second, or null when unavailable. Defaults to null.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessRow.NetworkBytesPerSecond"> <summary>The process network throughput in bytes per second, or null when unavailable. Defaults to null.</summary> </member> <member name="T:fullscreen.Monitoring.ProcessSampler"> <summary>Single-writer sampler. Buffers are reused; consumers copy under the gate.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.Gate"> <summary>Gets the synchronization object protecting shared collector state.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.Count"> <summary>Gets the active entry count.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.SampleMilliseconds"> <summary>Gets the elapsed metric-collection time in milliseconds.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.AllocatedBytes"> <summary>Gets the managed bytes allocated during the latest collection.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.TotalWorkingSet"> <summary>Gets the total process working-set memory in bytes.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.Rows"> <summary>Gets the source rows or requested terminal row count.</summary> </member> <member name="M:fullscreen.Monitoring.ProcessSampler.Sample"> <summary>Refreshes process counters and optional ownership and disk metrics.</summary> </member> <member name="M:fullscreen.Monitoring.ProcessSampler.Sample(System.Boolean,System.Boolean)"> <summary>Refreshes process counters and optional ownership and disk metrics.</summary> <param name="owners">Whether to resolve and cache process account names.</param> <param name="disk">Whether to collect per-process disk counters.</param> </member> <member name="M:fullscreen.Monitoring.ProcessSampler.Dispose"> <inheritdoc/> </member> <member name="T:fullscreen.Monitoring.ProcessSampler.LinuxStat"> <summary>Stores process fields parsed from a Linux procfs stat record.</summary> <param name="NameStart">The byte offset of the process name in the raw stat record.</param> <param name="NameLength">The byte length of the process name.</param> <param name="CpuTicks">The accumulated CPU counter ticks.</param> <param name="StartTicks">The process start counter used as a stable identity.</param> <param name="ResidentPages">The resident memory page count.</param> <param name="Threads">The process thread count.</param> <param name="ParentId">The parent process identifier, or null when unavailable.</param> <param name="State">The state exposed to the current view or callback. Defaults to '?'.</param> </member> <member name="M:fullscreen.Monitoring.ProcessSampler.LinuxStat.#ctor(System.Int32,System.Int32,System.Int64,System.Int64,System.Int64,System.Int32,System.Int32,System.Char)"> <summary>Stores process fields parsed from a Linux procfs stat record.</summary> <param name="NameStart">The byte offset of the process name in the raw stat record.</param> <param name="NameLength">The byte length of the process name.</param> <param name="CpuTicks">The accumulated CPU counter ticks.</param> <param name="StartTicks">The process start counter used as a stable identity.</param> <param name="ResidentPages">The resident memory page count.</param> <param name="Threads">The process thread count.</param> <param name="ParentId">The parent process identifier, or null when unavailable.</param> <param name="State">The state exposed to the current view or callback. Defaults to '?'.</param> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.LinuxStat.NameStart"> <summary>The byte offset of the process name in the raw stat record.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.LinuxStat.NameLength"> <summary>The byte length of the process name.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.LinuxStat.CpuTicks"> <summary>The accumulated CPU counter ticks.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.LinuxStat.StartTicks"> <summary>The process start counter used as a stable identity.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.LinuxStat.ResidentPages"> <summary>The resident memory page count.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.LinuxStat.Threads"> <summary>The process thread count.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.LinuxStat.ParentId"> <summary>The parent process identifier, or null when unavailable.</summary> </member> <member name="P:fullscreen.Monitoring.ProcessSampler.LinuxStat.State"> <summary>The state exposed to the current view or callback. Defaults to '?'.</summary> </member> <member name="M:fullscreen.Monitoring.ProcessSampler.TryReadLinuxStat(System.Byte[],fullscreen.Monitoring.ProcessSampler.LinuxStat@)"> <summary>Parses a Linux procfs process stat record.</summary> <param name="data">The raw process-information bytes.</param> <param name="stat">The parsed Linux process stat fields.</param> <returns>True when the required process fields were parsed.</returns> </member> <member name="M:fullscreen.Monitoring.ProcessSampler.TryReadLinuxDisk(System.Byte[])"> <summary>Parses process disk byte counters from Linux procfs data.</summary> <param name="data">The raw process-information bytes.</param> <returns>The accumulated disk byte count, or null when unavailable.</returns> </member> <member name="M:fullscreen.Monitoring.ProcessSampler.ReadWindowsStatus(System.Byte[],System.Int32)"> <summary>Reads process status from a Windows process-information record.</summary> <param name="record">The Windows process-information record bytes.</param> <param name="threads">The process thread count.</param> <returns>The display status, or null when unavailable.</returns> </member> <member name="T:fullscreen.Monitoring.ServiceSampler"> <summary>Read-only service inventory using the OS service manager. Refreshed at most every five seconds.</summary> </member> <member name="T:fullscreen.Monitoring.SystemSampler"> <summary>OS CPU deltas and physical memory. Unknown values remain null.</summary> </member> <member name="P:fullscreen.Monitoring.SystemSampler.CpuPercent"> <summary>Gets the system CPU utilization percentage, or null before a usable delta exists.</summary> </member> <member name="P:fullscreen.Monitoring.SystemSampler.TotalMemory"> <summary>Gets the total physical memory in bytes.</summary> </member> <member name="P:fullscreen.Monitoring.SystemSampler.AvailableMemory"> <summary>Gets the available physical memory in bytes.</summary> </member> <member name="M:fullscreen.Monitoring.SystemSampler.Sample"> <summary>Refreshes system CPU and memory counters selected by the caller.</summary> </member> <member name="M:fullscreen.Monitoring.SystemSampler.Sample(System.Boolean,System.Boolean)"> <summary>Refreshes system CPU and memory counters selected by the caller.</summary> <param name="cpu">Whether CPU counters are collected.</param> <param name="memory">Whether memory counters are collected.</param> </member> <member name="M:fullscreen.Monitoring.SystemSampler.ReadKilobytes(System.Byte[],System.String)"> <summary>Reads a named memory counter from Linux procfs data.</summary> <param name="text">The source text to parse or display.</param> <param name="key">The stable lookup key.</param> <returns>The memory quantity in bytes, or null when the key is absent.</returns> </member> <member name="T:fullscreen.Monitoring.UserSessionSampler"> <summary>Structured local login inventory, created only when Users metrics are requested.</summary> </member> <member name="T:fullscreen.Monitoring.WindowsIoSampler"> <summary>Demand-driven ETW sampling. Access denial leaves counters unavailable, never synthetic zeroes.</summary> </member> <member name="T:fullscreen.Monitoring.WindowsKernelTrace"> <summary>A real-time system logger with no files, symbol loading or general-purpose event decoding.</summary> </member> <member name="M:fullscreen.Monitoring.WindowsKernelTrace.StopOrphans"> <summary>System loggers outlive a crashed process and Windows allows only a few; stop ours whose owner is gone.</summary> </member> <member name="T:Microsoft.CodeAnalysis.EmbeddedAttribute"> <summary> A special attribute recognized by Roslyn, that marks a type as "embedded", meaning it won't ever be visible from other assemblies. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.ConstantExpectedAttribute"> <summary> Indicates that the specified method parameter expects a constant. </summary> <remarks> This can be used to inform tooling that a constant should be used as an argument for the annotated parameter. </remarks> </member> <member name="P:System.Diagnostics.CodeAnalysis.ConstantExpectedAttribute.Min"> <summary> Indicates the minimum bound of the expected constant, inclusive. </summary> </member> <member name="P:System.Diagnostics.CodeAnalysis.ConstantExpectedAttribute.Max"> <summary> Indicates the maximum bound of the expected constant, inclusive. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.UnscopedRefAttribute"> <summary> Used to indicate a byref escapes and is not scoped. </summary> <remarks> <para> There are several cases where the C# compiler treats a <see langword="ref"/> as implicitly <see langword="scoped"/> - where the compiler does not allow the <see langword="ref"/> to escape the method. </para> <para> For example: <list type="number"> <item><see langword="this"/> for <see langword="struct"/> instance methods.</item> <item><see langword="ref"/> parameters that refer to <see langword="ref"/> <see langword="struct"/> types.</item> <item><see langword="out"/> parameters.</item> </list> </para> <para> This attribute is used in those instances where the <see langword="ref"/> should be allowed to escape. </para> <para> Applying this attribute, in any form, has impact on consumers of the applicable API. It is necessary for API authors to understand the lifetime implications of applying this attribute and how it may impact their users. </para> </remarks> </member> <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute"> <summary> Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it. </summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)"> <summary> Initializes the attribute with the specified return value condition. </summary> <param name="returnValue">The return value condition. If the method returns this value, the associated parameter may be null.</param> </member> <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"> <summary> Gets the return value condition. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute"> <summary> Specifies that the method or property will ensure that the listed field and property members have not-null values. </summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)"> <summary> Initializes the attribute with a field or property member. </summary> <param name="member">The field or property member that is promised to be not-null.</param> </member> <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])"> <summary> Initializes the attribute with the list of field and property members. </summary> <param name="members">The list of field and property members that are promised to be not-null.</param> </member> <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members"> <summary> Gets field or property member names. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute"> <summary> Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it. </summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)"> <summary> Initializes the attribute with the specified return value condition. </summary> <param name="returnValue">The return value condition. If the method returns this value, the associated parameter will not be null.</param> </member> <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"> <summary>Gets the return value condition.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute"> <summary> Specifies that the output will be non-null if the named parameter is non-null. </summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)"> <summary> Initializes the attribute with the associated parameter name. </summary> <param name="parameterName">The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.</param> </member> <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName"> <summary> Gets the associated parameter name. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute"> <summary> Specifies that null is allowed as an input even if the corresponding type disallows it. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute"> <summary> Applied to a method that will never return under any circumstance. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute"> <summary> Specifies that the method will not return if the associated Boolean parameter is passed the specified value. </summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)"> <summary> Initializes the attribute with the specified parameter value. </summary> <param name="parameterValue"> The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to the associated parameter matches this value. </param> </member> <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue"> <summary> Gets the condition parameter value. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute"> <summary> Specifies that null is disallowed as an input even if the corresponding type allows it. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute"> <summary> Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.ExperimentalAttribute"> <summary> Indicates that an API is experimental and it may change in the future. </summary> <remarks> This attribute allows call sites to be flagged with a diagnostic that indicates that an experimental feature is used. Authors can use this attribute to ship preview features in their assemblies. </remarks> </member> <member name="M:System.Diagnostics.CodeAnalysis.ExperimentalAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.ExperimentalAttribute"/> class, specifying the ID that the compiler will use when reporting a use of the API the attribute applies to. </summary> <param name="diagnosticId">The ID that the compiler will use when reporting a use of the API the attribute applies to.</param> </member> <member name="P:System.Diagnostics.CodeAnalysis.ExperimentalAttribute.DiagnosticId"> <summary> Gets the ID that the compiler will use when reporting a use of the API the attribute applies to. </summary> <value>The unique diagnostic ID.</value> <remarks> The diagnostic ID is shown in build output for warnings and errors. <para>This property represents the unique ID that can be used to suppress the warnings or errors, if needed.</para> </remarks> </member> <member name="P:System.Diagnostics.CodeAnalysis.ExperimentalAttribute.UrlFormat"> <summary> Gets or sets the URL for corresponding documentation. The API accepts a format string instead of an actual URL, creating a generic URL that includes the diagnostic ID. </summary> <value>The format string that represents a URL to corresponding documentation.</value> <remarks>An example format string is <c>https://contoso.com/obsoletion-warnings/{0}</c>.</remarks> </member> <member name="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"> <summary> Specifies the syntax used in a string. </summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String)"> <summary> Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used. </summary> <param name="syntax">The syntax identifier.</param> </member> <member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String,System.Object[])"> <summary>Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used.</summary> <param name="syntax">The syntax identifier.</param> <param name="arguments">Optional arguments associated with the specific syntax employed.</param> </member> <member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Syntax"> <summary>Gets the identifier of the syntax used.</summary> </member> <member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Arguments"> <summary>Optional arguments associated with the specific syntax employed.</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.CompositeFormat"> <summary>The syntax identifier for strings containing composite formats for string formatting.</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateOnlyFormat"> <summary>The syntax identifier for strings containing date format specifiers.</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateTimeFormat"> <summary>The syntax identifier for strings containing date and time format specifiers.</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.EnumFormat"> <summary>The syntax identifier for strings containing <see cref="T:System.Enum"/> format specifiers.</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat"> <summary>The syntax identifier for strings containing <see cref="T:System.Guid"/> format specifiers.</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Json"> <summary>The syntax identifier for strings containing JavaScript Object Notation (JSON).</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat"> <summary>The syntax identifier for strings containing numeric format specifiers.</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Regex"> <summary>The syntax identifier for strings containing regular expressions.</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeOnlyFormat"> <summary>The syntax identifier for strings containing time format specifiers.</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeSpanFormat"> <summary>The syntax identifier for strings containing <see cref="T:System.TimeSpan"/> format specifiers.</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Uri"> <summary>The syntax identifier for strings containing URIs.</summary> </member> <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Xml"> <summary>The syntax identifier for strings containing XML.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.SetsRequiredMembersAttribute"> <summary> Specifies that this constructor sets all required members for the current type, and callers do not need to set any required members themselves. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute"> <summary> Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition. </summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)"> <summary> Initializes the attribute with the specified return value condition and a field or property member. </summary> <param name="returnValue">The return value condition. If the method returns this value, the associated parameter will not be null.</param> <param name="member">The field or property member that is promised to be not-null.</param> </member> <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])"> <summary> Initializes the attribute with the specified return value condition and list of field and property members. </summary> <param name="returnValue">The return value condition. If the method returns this value, the associated parameter will not be null.</param> <param name="members">The list of field and property members that are promised to be not-null.</param> </member> <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue"> <summary> Gets the return value condition. </summary> </member> <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members"> <summary> Gets field or property member names. </summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute"> <summary> Specifies that an output may be null even if the corresponding type disallows it. </summary> </member> <member name="T:System.Runtime.CompilerServices.RequiresLocationAttribute"> <summary> Reserved for use by a compiler for tracking metadata. This attribute should not be used by developers in source code. </summary> </member> <member name="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute"> <summary> An attribute that allows parameters to receive the expression of other parameters. </summary> </member> <member name="M:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute"/> class. </summary> <param name="parameterName">The condition parameter value.</param> </member> <member name="P:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.ParameterName"> <summary> Gets the parameter name the expression is retrieved from. </summary> </member> <member name="T:System.Runtime.CompilerServices.OverloadResolutionPriorityAttribute"> <summary> Specifies the priority of a member in overload resolution. When unspecified, the default priority is 0. </summary> </member> <member name="M:System.Runtime.CompilerServices.OverloadResolutionPriorityAttribute.#ctor(System.Int32)"> <summary> Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.OverloadResolutionPriorityAttribute"/> class. </summary> <param name="priority">The priority of the attributed member. Higher numbers are prioritized, lower numbers are deprioritized. 0 is the default if no attribute is present.</param> </member> <member name="P:System.Runtime.CompilerServices.OverloadResolutionPriorityAttribute.Priority"> <summary> The priority of the member. </summary> </member> <member name="T:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute"> <summary> Indicates the type of the async method builder that should be used by a language compiler to build the attributed async method or to build the attributed type when used as the return type of an async method. </summary> </member> <member name="M:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute.#ctor(System.Type)"> <summary>Initializes the <see cref="T:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute"/>.</summary> <param name="builderType">The <see cref="T:System.Type"/> of the associated builder.</param> </member> <member name="P:System.Runtime.CompilerServices.AsyncMethodBuilderAttribute.BuilderType"> <summary>Gets the <see cref="T:System.Type"/> of the associated builder.</summary> </member> <member name="T:System.Runtime.CompilerServices.IsExternalInit"> <summary> Reserved to be used by the compiler for tracking metadata. This class should not be used by developers in source code. </summary> </member> <member name="T:System.Runtime.CompilerServices.RequiredMemberAttribute"> <summary> Specifies that a type has required members or that a member is required. </summary> </member> <member name="T:System.Runtime.CompilerServices.SkipLocalsInitAttribute"> <summary> Used to indicate to the compiler that the <c>.locals init</c> flag should not be set in method headers. </summary> </member> <member name="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute"> <summary> When applied to an attribute class, instructs the compiler to flow applications of that attribute, from source code down to compiler-generated symbols. This can help IL-based analysis tools. </summary> <remarks> One example where this attribute applies is in C# primary constructor parameters. If an attribute marked with <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute"/> gets applied to a primary constructor parameter, the attribute will also be applied to any compiler-generated fields storing that parameter. </remarks> </member> <member name="M:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute.#ctor"> <summary> Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerLoweringPreserveAttribute"/> class. </summary> </member> <member name="T:System.Runtime.CompilerServices.ExtensionMarkerAttribute"> <summary> This attribute is used to mark extension members and associate them with a specific marker type (which provides detailed information about an extension block and its receiver parameter). This attribute should not be used by developers in source code. </summary> </member> <member name="M:System.Runtime.CompilerServices.ExtensionMarkerAttribute.#ctor(System.String)"> <summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.ExtensionMarkerAttribute"/> class.</summary> <param name="name">The name of the marker type this extension member is associated with.</param> </member> <member name="P:System.Runtime.CompilerServices.ExtensionMarkerAttribute.Name"> <summary>The name of the marker type this extension member is associated with.</summary> </member> <member name="M:System.Runtime.CompilerServices.CollectionBuilderAttribute.#ctor(System.Type,System.String)"> <summary> Initialize the attribute to refer to the <paramref name="methodName"/> method on the <paramref name="builderType"/> type. </summary> <param name="builderType">The type of the builder to use to construct the collection.</param> <param name="methodName">The name of the method on the builder to use to construct the collection.</param> <remarks> <paramref name="methodName"/> must refer to a static method that accepts a single parameter of type <see cref="!:ReadOnlySpan<T>"/> and returns an instance of the collection being built containing a copy of the data from that span. In future releases of .NET, additional patterns may be supported. </remarks> </member> <member name="P:System.Runtime.CompilerServices.CollectionBuilderAttribute.BuilderType"> <summary> Gets the type of the builder to use to construct the collection. </summary> </member> <member name="P:System.Runtime.CompilerServices.CollectionBuilderAttribute.MethodName"> <summary> Gets the name of the method on the builder to use to construct the collection. </summary> <remarks> This should match the metadata name of the target method. For example, this might be ".ctor" if targeting the type's constructor. </remarks> </member> <member name="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute"> <summary> Indicates which arguments to a method involving an interpolated string handler should be passed to that handler. </summary> </member> <member name="M:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute"/> class. </summary> <param name="argument">The name of the argument that should be passed to the handler.</param> <remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks> </member> <member name="M:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.#ctor(System.String[])"> <summary> Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute"/> class. </summary> <param name="arguments">The names of the arguments that should be passed to the handler.</param> <remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks> </member> <member name="P:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.Arguments"> <summary> Gets the names of the arguments that should be passed to the handler. </summary> <remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks> </member> <member name="T:System.Runtime.CompilerServices.ParamCollectionAttribute"> <summary> Indicates that a method will allow a variable number of arguments in its invocation. </summary> </member> <member name="T:System.Runtime.CompilerServices.ModuleInitializerAttribute"> <summary> Used to indicate to the compiler that a method should be called in its containing module's initializer. </summary> <remarks> When one or more valid methods with this attribute are found in a compilation, the compiler will emit a module initializer which calls each of the attributed methods. Certain requirements are imposed on any method targeted with this attribute: - The method must be `static`. - The method must be an ordinary member method, as opposed to a property accessor, constructor, local function, etc. - The method must be parameterless. - The method must return `void`. - The method must not be generic or be contained in a generic type. - The method's effective accessibility must be `internal` or `public`. The specification for module initializers in the .NET runtime can be found here: https://github.com/dotnet/runtime/blob/main/docs/design/specs/Ecma-335-Augments.md#module-initializer </remarks> </member> <member name="T:System.Runtime.CompilerServices.InterpolatedStringHandlerAttribute"> <summary> Indicates the attributed type is to be used as an interpolated string handler. </summary> </member> <member name="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute"> <summary> Indicates that compiler support for a particular feature is required for the location where this attribute is applied. </summary> </member> <member name="M:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.#ctor(System.String)"> <summary> Creates a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute"/> type. </summary> <param name="featureName">The name of the feature to indicate.</param> </member> <member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"> <summary> The name of the compiler feature. </summary> </member> <member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.IsOptional"> <summary> If true, the compiler can choose to allow access to the location where this attribute is applied if it does not understand <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/>. </summary> </member> <member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RefStructs"> <summary> The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the ref structs C# feature. </summary> </member> <member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RequiredMembers"> <summary> The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the required members C# feature. </summary> </member> <member name="M:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.#ctor"> <summary> Initializes a new instance of the <see cref="T:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute"/> class. </summary> </member> <member name="M:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute"/> class with the specified message. </summary> <param name="message">An optional message associated with this attribute instance.</param> </member> <member name="P:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.Message"> <summary> Returns the optional message associated with this attribute instance. </summary> </member> <member name="P:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.Url"> <summary> Returns the optional URL associated with this attribute instance. </summary> </member> <member name="T:System.Range"> <summary>Represent a range has start and end indexes.</summary> <remarks> Range is used by the C# compiler to support the range syntax. <code> int[] someArray = new int[5] { 1, 2, 3, 4, 5 }; int[] subArray1 = someArray[0..2]; // { 1, 2 } int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 } </code> </remarks> </member> <member name="P:System.Range.Start"> <summary>Represent the inclusive start index of the Range.</summary> </member> <member name="P:System.Range.End"> <summary>Represent the exclusive end index of the Range.</summary> </member> <member name="M:System.Range.#ctor(System.Index,System.Index)"> <summary>Construct a Range object using the start and end indexes.</summary> <param name="start">Represent the inclusive start index of the range.</param> <param name="end">Represent the exclusive end index of the range.</param> </member> <member name="M:System.Range.Equals(System.Object)"> <summary>Indicates whether the current Range object is equal to another object of the same type.</summary> <param name="value">An object to compare with this object</param> </member> <member name="M:System.Range.Equals(System.Range)"> <summary>Indicates whether the current Range object is equal to another Range object.</summary> <param name="other">An object to compare with this object</param> </member> <member name="M:System.Range.GetHashCode"> <summary>Returns the hash code for this instance.</summary> </member> <member name="M:System.Range.ToString"> <summary>Converts the value of the current Range object to its equivalent string representation.</summary> </member> <member name="M:System.Range.StartAt(System.Index)"> <summary>Create a Range object starting from start index to the end of the collection.</summary> </member> <member name="M:System.Range.EndAt(System.Index)"> <summary>Create a Range object starting from first element in the collection to the end Index.</summary> </member> <member name="P:System.Range.All"> <summary>Create a Range object starting from first element to the end.</summary> </member> <member name="M:System.Range.GetOffsetAndLength(System.Int32)"> <summary>Calculate the start offset and length of range object using a collection length.</summary> <param name="length">The length of the collection that the range will be used with. length has to be a positive value.</param> <remarks> For performance reason, we don't validate the input length parameter against negative values. It is expected Range will be used with collections which always have non negative length/count. We validate the range is inside the length scope though. </remarks> </member> <member name="T:System.Index"> <summary>Represent a type can be used to index a collection either from the start or the end.</summary> <remarks> Index is used by the C# compiler to support the new index syntax <code> int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ; int lastElement = someArray[^1]; // lastElement = 5 </code> </remarks> </member> <member name="M:System.Index.#ctor(System.Int32,System.Boolean)"> <summary>Construct an Index using a value and indicating if the index is from the start or from the end.</summary> <param name="value">The index value. it has to be zero or positive number.</param> <param name="fromEnd">Indicating if the index is from the start or from the end.</param> <remarks> If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element. </remarks> </member> <member name="P:System.Index.Start"> <summary>Create an Index pointing at first element.</summary> </member> <member name="P:System.Index.End"> <summary>Create an Index pointing at beyond last element.</summary> </member> <member name="M:System.Index.FromStart(System.Int32)"> <summary>Create an Index from the start at the position indicated by the value.</summary> <param name="value">The index value from the start.</param> </member> <member name="M:System.Index.FromEnd(System.Int32)"> <summary>Create an Index from the end at the position indicated by the value.</summary> <param name="value">The index value from the end.</param> </member> <member name="P:System.Index.Value"> <summary>Returns the index value.</summary> </member> <member name="P:System.Index.IsFromEnd"> <summary>Indicates whether the index is from the start or the end.</summary> </member> <member name="M:System.Index.GetOffset(System.Int32)"> <summary>Calculate the offset from the start using the giving collection length.</summary> <param name="length">The length of the collection that the Index will be used with. length has to be a positive value</param> <remarks> For performance reason, we don't validate the input length parameter and the returned offset value against negative values. we don't validate either the returned offset is greater than the input length. It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and then used to index a collection will get out of range exception which will be same affect as the validation. </remarks> </member> <member name="M:System.Index.Equals(System.Object)"> <summary>Indicates whether the current Index object is equal to another object of the same type.</summary> <param name="value">An object to compare with this object</param> </member> <member name="M:System.Index.Equals(System.Index)"> <summary>Indicates whether the current Index object is equal to another Index object.</summary> <param name="other">An object to compare with this object</param> </member> <member name="M:System.Index.GetHashCode"> <summary>Returns the hash code for this instance.</summary> </member> <member name="M:System.Index.op_Implicit(System.Int32)~System.Index"> <summary>Converts integer number to an Index.</summary> </member> <member name="M:System.Index.ToString"> <summary>Converts the value of the current Index object to its equivalent string representation.</summary> </member> </members> </doc> |