Files
Misaki.HighPerformance/docs/documents/api/Misaki.HighPerformance.Jobs.SPMCQueue-1.yml

582 lines
19 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: Misaki.HighPerformance.Jobs.SPMCQueue`1
commentId: T:Misaki.HighPerformance.Jobs.SPMCQueue`1
id: SPMCQueue`1
parent: Misaki.HighPerformance.Jobs
children:
- Misaki.HighPerformance.Jobs.SPMCQueue`1.#ctor(System.Int32)
- Misaki.HighPerformance.Jobs.SPMCQueue`1.IsEmpty
- Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPop(`0@)
- Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPush(`0)
- Misaki.HighPerformance.Jobs.SPMCQueue`1.TrySteal(`0@)
langs:
- csharp
- vb
name: SPMCQueue<T>
nameWithType: SPMCQueue<T>
fullName: Misaki.HighPerformance.Jobs.SPMCQueue<T>
type: Class
source:
remote:
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
branch: main
repo: https://git.personalnas.com/Misaki/Misaki.HighPerformance.git
id: SPMCQueue
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
startLine: 6
assemblies:
- Misaki.HighPerformance.Jobs
namespace: Misaki.HighPerformance.Jobs
syntax:
content: public class SPMCQueue<T>
typeParameters:
- id: T
content.vb: Public Class SPMCQueue(Of T)
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
nameWithType.vb: SPMCQueue(Of T)
fullName.vb: Misaki.HighPerformance.Jobs.SPMCQueue(Of T)
name.vb: SPMCQueue(Of T)
- uid: Misaki.HighPerformance.Jobs.SPMCQueue`1.IsEmpty
commentId: P:Misaki.HighPerformance.Jobs.SPMCQueue`1.IsEmpty
id: IsEmpty
parent: Misaki.HighPerformance.Jobs.SPMCQueue`1
langs:
- csharp
- vb
name: IsEmpty
nameWithType: SPMCQueue<T>.IsEmpty
fullName: Misaki.HighPerformance.Jobs.SPMCQueue<T>.IsEmpty
type: Property
source:
remote:
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
branch: main
repo: https://git.personalnas.com/Misaki/Misaki.HighPerformance.git
id: IsEmpty
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
startLine: 21
assemblies:
- Misaki.HighPerformance.Jobs
namespace: Misaki.HighPerformance.Jobs
syntax:
content: public bool IsEmpty { get; }
parameters: []
return:
type: System.Boolean
content.vb: Public ReadOnly Property IsEmpty As Boolean
overload: Misaki.HighPerformance.Jobs.SPMCQueue`1.IsEmpty*
nameWithType.vb: SPMCQueue(Of T).IsEmpty
fullName.vb: Misaki.HighPerformance.Jobs.SPMCQueue(Of T).IsEmpty
- uid: Misaki.HighPerformance.Jobs.SPMCQueue`1.#ctor(System.Int32)
commentId: M:Misaki.HighPerformance.Jobs.SPMCQueue`1.#ctor(System.Int32)
id: '#ctor(System.Int32)'
parent: Misaki.HighPerformance.Jobs.SPMCQueue`1
langs:
- csharp
- vb
name: SPMCQueue(int)
nameWithType: SPMCQueue<T>.SPMCQueue(int)
fullName: Misaki.HighPerformance.Jobs.SPMCQueue<T>.SPMCQueue(int)
type: Constructor
source:
remote:
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
branch: main
repo: https://git.personalnas.com/Misaki/Misaki.HighPerformance.git
id: .ctor
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
startLine: 30
assemblies:
- Misaki.HighPerformance.Jobs
namespace: Misaki.HighPerformance.Jobs
summary: Initializes a new instance of the SPMCQueue class with the specified capacity.
remarks: This queue will not resize when it reaches capacity.
example: []
syntax:
content: public SPMCQueue(int capacity)
parameters:
- id: capacity
type: System.Int32
description: The capacity of the queue.
content.vb: Public Sub New(capacity As Integer)
overload: Misaki.HighPerformance.Jobs.SPMCQueue`1.#ctor*
nameWithType.vb: SPMCQueue(Of T).New(Integer)
fullName.vb: Misaki.HighPerformance.Jobs.SPMCQueue(Of T).New(Integer)
name.vb: New(Integer)
- uid: Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPush(`0)
commentId: M:Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPush(`0)
id: TryPush(`0)
parent: Misaki.HighPerformance.Jobs.SPMCQueue`1
langs:
- csharp
- vb
name: TryPush(T)
nameWithType: SPMCQueue<T>.TryPush(T)
fullName: Misaki.HighPerformance.Jobs.SPMCQueue<T>.TryPush(T)
type: Method
source:
remote:
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
branch: main
repo: https://git.personalnas.com/Misaki/Misaki.HighPerformance.git
id: TryPush
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
startLine: 41
assemblies:
- Misaki.HighPerformance.Jobs
namespace: Misaki.HighPerformance.Jobs
summary: Tries to push an item onto the queue.
example: []
syntax:
content: public bool TryPush(T item)
parameters:
- id: item
type: '{T}'
description: The item to push.
return:
type: System.Boolean
description: True if the item was pushed successfully; otherwise, false.
content.vb: Public Function TryPush(item As T) As Boolean
overload: Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPush*
nameWithType.vb: SPMCQueue(Of T).TryPush(T)
fullName.vb: Misaki.HighPerformance.Jobs.SPMCQueue(Of T).TryPush(T)
- uid: Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPop(`0@)
commentId: M:Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPop(`0@)
id: TryPop(`0@)
parent: Misaki.HighPerformance.Jobs.SPMCQueue`1
langs:
- csharp
- vb
name: TryPop(out T?)
nameWithType: SPMCQueue<T>.TryPop(out T?)
fullName: Misaki.HighPerformance.Jobs.SPMCQueue<T>.TryPop(out T?)
type: Method
source:
remote:
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
branch: main
repo: https://git.personalnas.com/Misaki/Misaki.HighPerformance.git
id: TryPop
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
startLine: 62
assemblies:
- Misaki.HighPerformance.Jobs
namespace: Misaki.HighPerformance.Jobs
summary: Trys to pop an item from the queue.
example: []
syntax:
content: public bool TryPop(out T? item)
parameters:
- id: item
type: '{T}'
description: The item to pop.
attributes:
- type: System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute
ctor: System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)
arguments:
- type: System.Boolean
value: false
return:
type: System.Boolean
description: True if an item was popped successfully; otherwise, false.
content.vb: Public Function TryPop(item As T) As Boolean
overload: Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPop*
nameWithType.vb: SPMCQueue(Of T).TryPop(T)
fullName.vb: Misaki.HighPerformance.Jobs.SPMCQueue(Of T).TryPop(T)
name.vb: TryPop(T)
- uid: Misaki.HighPerformance.Jobs.SPMCQueue`1.TrySteal(`0@)
commentId: M:Misaki.HighPerformance.Jobs.SPMCQueue`1.TrySteal(`0@)
id: TrySteal(`0@)
parent: Misaki.HighPerformance.Jobs.SPMCQueue`1
langs:
- csharp
- vb
name: TrySteal(out T?)
nameWithType: SPMCQueue<T>.TrySteal(out T?)
fullName: Misaki.HighPerformance.Jobs.SPMCQueue<T>.TrySteal(out T?)
type: Method
source:
remote:
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
branch: main
repo: https://git.personalnas.com/Misaki/Misaki.HighPerformance.git
id: TrySteal
path: src/Misaki.HighPerformance.Jobs/SPMCQueue.cs
startLine: 102
assemblies:
- Misaki.HighPerformance.Jobs
namespace: Misaki.HighPerformance.Jobs
summary: Trys to steal an item from the queue.
example: []
syntax:
content: public bool TrySteal(out T? item)
parameters:
- id: item
type: '{T}'
description: The item to steal.
attributes:
- type: System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute
ctor: System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)
arguments:
- type: System.Boolean
value: false
return:
type: System.Boolean
description: True if an item was stolen successfully; otherwise, false.
content.vb: Public Function TrySteal(item As T) As Boolean
overload: Misaki.HighPerformance.Jobs.SPMCQueue`1.TrySteal*
nameWithType.vb: SPMCQueue(Of T).TrySteal(T)
fullName.vb: Misaki.HighPerformance.Jobs.SPMCQueue(Of T).TrySteal(T)
name.vb: TrySteal(T)
references:
- uid: Misaki.HighPerformance.Jobs
commentId: N:Misaki.HighPerformance.Jobs
href: Misaki.html
name: Misaki.HighPerformance.Jobs
nameWithType: Misaki.HighPerformance.Jobs
fullName: Misaki.HighPerformance.Jobs
spec.csharp:
- uid: Misaki
name: Misaki
href: Misaki.html
- name: .
- uid: Misaki.HighPerformance
name: HighPerformance
href: Misaki.HighPerformance.html
- name: .
- uid: Misaki.HighPerformance.Jobs
name: Jobs
href: Misaki.HighPerformance.Jobs.html
spec.vb:
- uid: Misaki
name: Misaki
href: Misaki.html
- name: .
- uid: Misaki.HighPerformance
name: HighPerformance
href: Misaki.HighPerformance.html
- name: .
- uid: Misaki.HighPerformance.Jobs
name: Jobs
href: Misaki.HighPerformance.Jobs.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: Misaki.HighPerformance.Jobs.SPMCQueue`1.IsEmpty*
commentId: Overload:Misaki.HighPerformance.Jobs.SPMCQueue`1.IsEmpty
href: Misaki.HighPerformance.Jobs.SPMCQueue-1.html#Misaki_HighPerformance_Jobs_SPMCQueue_1_IsEmpty
name: IsEmpty
nameWithType: SPMCQueue<T>.IsEmpty
fullName: Misaki.HighPerformance.Jobs.SPMCQueue<T>.IsEmpty
nameWithType.vb: SPMCQueue(Of T).IsEmpty
fullName.vb: Misaki.HighPerformance.Jobs.SPMCQueue(Of T).IsEmpty
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
name: bool
nameWithType: bool
fullName: bool
nameWithType.vb: Boolean
fullName.vb: Boolean
name.vb: Boolean
- uid: Misaki.HighPerformance.Jobs.SPMCQueue`1.#ctor*
commentId: Overload:Misaki.HighPerformance.Jobs.SPMCQueue`1.#ctor
href: Misaki.HighPerformance.Jobs.SPMCQueue-1.html#Misaki_HighPerformance_Jobs_SPMCQueue_1__ctor_System_Int32_
name: SPMCQueue
nameWithType: SPMCQueue<T>.SPMCQueue
fullName: Misaki.HighPerformance.Jobs.SPMCQueue<T>.SPMCQueue
nameWithType.vb: SPMCQueue(Of T).New
fullName.vb: Misaki.HighPerformance.Jobs.SPMCQueue(Of T).New
name.vb: New
- uid: System.Int32
commentId: T:System.Int32
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.int32
name: int
nameWithType: int
fullName: int
nameWithType.vb: Integer
fullName.vb: Integer
name.vb: Integer
- uid: Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPush*
commentId: Overload:Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPush
href: Misaki.HighPerformance.Jobs.SPMCQueue-1.html#Misaki_HighPerformance_Jobs_SPMCQueue_1_TryPush__0_
name: TryPush
nameWithType: SPMCQueue<T>.TryPush
fullName: Misaki.HighPerformance.Jobs.SPMCQueue<T>.TryPush
nameWithType.vb: SPMCQueue(Of T).TryPush
fullName.vb: Misaki.HighPerformance.Jobs.SPMCQueue(Of T).TryPush
- uid: '{T}'
commentId: '!:T'
definition: T
name: T
nameWithType: T
fullName: T
- uid: T
name: T
nameWithType: T
fullName: T
- uid: Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPop*
commentId: Overload:Misaki.HighPerformance.Jobs.SPMCQueue`1.TryPop
href: Misaki.HighPerformance.Jobs.SPMCQueue-1.html#Misaki_HighPerformance_Jobs_SPMCQueue_1_TryPop__0__
name: TryPop
nameWithType: SPMCQueue<T>.TryPop
fullName: Misaki.HighPerformance.Jobs.SPMCQueue<T>.TryPop
nameWithType.vb: SPMCQueue(Of T).TryPop
fullName.vb: Misaki.HighPerformance.Jobs.SPMCQueue(Of T).TryPop
- uid: Misaki.HighPerformance.Jobs.SPMCQueue`1.TrySteal*
commentId: Overload:Misaki.HighPerformance.Jobs.SPMCQueue`1.TrySteal
href: Misaki.HighPerformance.Jobs.SPMCQueue-1.html#Misaki_HighPerformance_Jobs_SPMCQueue_1_TrySteal__0__
name: TrySteal
nameWithType: SPMCQueue<T>.TrySteal
fullName: Misaki.HighPerformance.Jobs.SPMCQueue<T>.TrySteal
nameWithType.vb: SPMCQueue(Of T).TrySteal
fullName.vb: Misaki.HighPerformance.Jobs.SPMCQueue(Of T).TrySteal