Every cmdlet, in full

Every one of the 139 cmdlets the module exports, with each parameter, its type, whether it is required, and what the cmdlet writes, followed by the properties and methods of whatever came back. Generated from the built module by crates/subetha-pwrs/tools/Export-Reference.ps1, so it cannot disagree with the surface it describes.

For the shape of an actual returned value rather than its type, see What the values look like . In a shell, Get-Help <name> -Full adds an example to any of these.

Contents

The front door (7) - New-SubEthaAdaptiveQueue , New-SubEthaChannel , New-SubEthaKvMap , New-SubEthaQosPolicy , New-SubEthaWorkQueue , Open-SubEthaChannel , Open-SubEthaWorkQueue

Rings and channels (11) - New-SubEthaBroadcastRing , New-SubEthaLamportPair , New-SubEthaMpmcGrid , New-SubEthaMpscPool , New-SubEthaPubSub , New-SubEthaRing , New-SubEthaSpscRing , Open-SubEthaBroadcastRing , Open-SubEthaPubSub , Open-SubEthaRing , Open-SubEthaSpscRing

Rings that change themselves (4) - New-SubEthaCapacityRing , New-SubEthaLocaleRing , Open-SubEthaCapacityRing , Open-SubEthaLocaleRing

The sidecar (4) - Get-SubEthaSidecar , Invoke-SubEthaSidecarScan , New-SubEthaAdaptive , Set-SubEthaSidecar

Order (1) - New-SubEthaReorderWindow

Shared state (40) - New-SubEthaArena , New-SubEthaAtomic , New-SubEthaBitVec , New-SubEthaBTreeMap , New-SubEthaCell , New-SubEthaDeque , New-SubEthaFrameRegion , New-SubEthaGraph , New-SubEthaHandleTable , New-SubEthaHashMap , New-SubEthaLazyValue , New-SubEthaLinkedList , New-SubEthaRegion , New-SubEthaSharedArc , New-SubEthaSlab , New-SubEthaStack , New-SubEthaTopologyMap , New-SubEthaTower , New-SubEthaUniversal , New-SubEthaVec , Open-SubEthaArena , Open-SubEthaAtomic , Open-SubEthaBitVec , Open-SubEthaBTreeMap , Open-SubEthaCell , Open-SubEthaDeque , Open-SubEthaFrameRegion , Open-SubEthaGraph , Open-SubEthaHandleTable , Open-SubEthaHashMap , Open-SubEthaLazyValue , Open-SubEthaLinkedList , Open-SubEthaRegion , Open-SubEthaSharedArc , Open-SubEthaSlab , Open-SubEthaStack , Open-SubEthaTopologyMap , Open-SubEthaTower , Open-SubEthaUniversal , Open-SubEthaVec

State with a history (12) - New-SubEthaEpochs , New-SubEthaLanedMap , New-SubEthaTimePointTile , New-SubEthaVersionChain , New-SubEthaVersionedMap , New-SubEthaVersionedSlab , Open-SubEthaEpochs , Open-SubEthaLanedMap , Open-SubEthaTimePointTile , Open-SubEthaVersionChain , Open-SubEthaVersionedMap , Open-SubEthaVersionedSlab

Coordination (20) - New-SubEthaCondvar , New-SubEthaEpochBarrier , New-SubEthaFenceClock , New-SubEthaHeartbeat , New-SubEthaHolderTable , New-SubEthaLeaderElection , New-SubEthaNotifierSet , New-SubEthaOwnerLease , New-SubEthaRWLock , New-SubEthaSemaphore , Open-SubEthaCondvar , Open-SubEthaEpochBarrier , Open-SubEthaFenceClock , Open-SubEthaHeartbeat , Open-SubEthaHolderTable , Open-SubEthaLeaderElection , Open-SubEthaOwnerLease , Open-SubEthaRWLock , Open-SubEthaSemaphore , Wait-SubEthaCondition

Probabilistic (20) - Measure-SubEthaBloomSize , Measure-SubEthaSketchSize , New-SubEthaBlockedBloomFilter , New-SubEthaBloomFilter , New-SubEthaCountMinSketch , New-SubEthaFineBloom , New-SubEthaHistogram , New-SubEthaHyperLogLog , New-SubEthaLruCache , New-SubEthaRateLimiter , New-SubEthaReservoir , New-SubEthaTinyBloom , Open-SubEthaBlockedBloomFilter , Open-SubEthaBloomFilter , Open-SubEthaCountMinSketch , Open-SubEthaHistogram , Open-SubEthaHyperLogLog , Open-SubEthaLruCache , Open-SubEthaRateLimiter , Open-SubEthaReservoir

Clocks (2) - New-SubEthaCausalClock , New-SubEthaClock

Sensing (10) - New-SubEthaCapacity , New-SubEthaForecast , New-SubEthaLossBursts , New-SubEthaLossKind , New-SubEthaPathChanges , New-SubEthaPeriodicity , New-SubEthaRoundTripShape , New-SubEthaSensReceiver , New-SubEthaSensSender , New-SubEthaTiming

Bridges (6) - Get-SubEthaTransport , New-SubEthaQuicBridgeClient , New-SubEthaQuicBridgeServer , New-SubEthaSelfSignedCert , New-SubEthaTcpBridgeClient , New-SubEthaTcpBridgeServer

The pipeline (2) - Receive-SubEthaItem , Send-SubEthaItem

The front door

New-SubEthaAdaptiveQueue

Creates the adaptive queue at Path with Capacity items in flight (1024 when absent), starting as a ring for Senders and Readers and changing shape as the traffic says.

Also New-SEAdaptiveQueue.

Writes SubEtha.AdaptiveQueue.

New-SubEthaChannel

Obtains the channel at Path with Capacity items in flight (1024 when absent, rounded up to a power of two), creating it for Senders and Readers when the file does not exist.

Also New-SEChannel.

Writes SubEtha.Channel.

New-SubEthaKvMap

Creates the map at Path with Capacity entries (1024 when absent), shaped for Readers and Writers.

Also New-SEKvMap.

Writes SubEtha.KvMap.

New-SubEthaQosPolicy

Builds a policy from its settings, or from a Preset with any of the settings overriding it.

Also New-SEQosPolicy.

Writes SubEtha.QosPolicy.

New-SubEthaWorkQueue

Creates the work queue at Path as its owner, with Capacity items in flight (1024 when absent) and Thieves expected to take from it.

Also New-SEWorkQueue.

Writes SubEtha.WorkQueue.

Open-SubEthaChannel

Attaches to the channel at Path, which must exist with the Capacity it was created with.

Also Open-SEChannel.

Writes SubEtha.Channel.

Open-SubEthaWorkQueue

Attaches to the work queue at Path as a thief, to take from it.

Also Open-SEWorkQueue.

Writes SubEtha.WorkQueue.

Rings and channels

New-SubEthaBroadcastRing

Obtains the broadcast ring at Path holding Capacity slots, creating it when the file does not exist.

Also New-SEBroadcastRing.

Writes SubEtha.BroadcastRing.

New-SubEthaLamportPair

Makes a Lamport pair at Path, one producer and one consumer over one ring of Capacity slots, and writes the two in that order. Exactly one of each may exist per ring: within a process the types enforce that, and across processes it is the caller’s undertaking, which is why the pair is handed out rather than opened twice.

Also New-SELamportPair.

Writes SubEtha.LamportConsumer, SubEtha.LamportProducer.

On the SubEtha.LamportConsumer:

On the SubEtha.LamportProducer:

New-SubEthaMpmcGrid

Makes a grid at Path of Producers rings of Capacity slots shared out among Consumers, and writes the producers and the consumers together. Open attaches to a grid that exists with the shape it was built at.

Also New-SEMpmcGrid.

Writes SubEtha.MpmcGrid.

New-SubEthaMpscPool

Makes a pool at Path of Producers rings of Capacity slots, drained by one consumer, and writes the producers and the consumer together. Open attaches to a pool that exists with the shape it was built at.

Also New-SEMpscPool.

Writes SubEtha.MpscPool.

New-SubEthaPubSub

Obtains the publish/subscribe ring at Path keeping Capacity items, creating it when the file does not exist.

Also New-SEPubSub.

Writes SubEtha.PubSub.

New-SubEthaRing

Obtains the adaptive ring at Path holding Capacity slots, creating it when the file does not exist.

Also New-SERing.

Writes SubEtha.Ring.

New-SubEthaSpscRing

Obtains the single-producer ring at Path holding Capacity slots, creating it when the file does not exist.

Also New-SESpscRing.

Writes SubEtha.SpscRing.

Open-SubEthaBroadcastRing

Attaches to the broadcast ring at Path, which must exist with the Capacity it was created with.

Also Open-SEBroadcastRing.

Writes SubEtha.BroadcastRing.

Open-SubEthaPubSub

Attaches to the publish/subscribe ring at Path, which must exist with the Capacity it was created with.

Also Open-SEPubSub.

Writes SubEtha.PubSub.

Open-SubEthaRing

Attaches to the adaptive ring at Path, which must exist with the capacity, counts and stamps it was created with.

Also Open-SERing.

Writes SubEtha.Ring.

Open-SubEthaSpscRing

Attaches to the single-producer ring at Path, which must exist with the Capacity it was created with.

Also Open-SESpscRing.

Writes SubEtha.SpscRing.

Rings that change themselves

New-SubEthaCapacityRing

Obtains the resizable ring at Path holding Capacity slots, a power of two, creating it when the file does not exist.

Also New-SECapacityRing.

Writes SubEtha.CapacityRing.

New-SubEthaLocaleRing

Obtains the relocatable ring at Path holding Capacity slots, a power of two, creating it when the file does not exist. All three backings are built, so a later migration has somewhere to go without allocating.

Also New-SELocaleRing.

Writes SubEtha.LocaleRing.

Open-SubEthaCapacityRing

Attaches to the resizable ring at Path, which must exist with the capacity, counts and stamping it was created with.

Also Open-SECapacityRing.

Writes SubEtha.CapacityRing.

Open-SubEthaLocaleRing

Attaches to the relocatable ring at Path, which must exist with the capacity, counts and stamping it was created with.

Also Open-SELocaleRing.

Writes SubEtha.LocaleRing.

The sidecar

Get-SubEthaSidecar

Reports the process’s sidecar: how many objects it holds, the most it allows, and its scan threads.

Also Get-SESidecar.

No parameters.

Writes SubEtha.SidecarStatus.

Invoke-SubEthaSidecarScan

Has every scan thread of the process’s sidecar scan now, and waits for it: an observation recorded before the call has been drained, and its policy asked, when it returns. With PassThru it writes the sidecar’s status once the scan is done; without it, nothing.

Also Invoke-SESidecarScan.

Writes SubEtha.SidecarStatus.

New-SubEthaAdaptive

Makes an adaptive object of the script’s own, at tag 0.

Also New-SEAdaptive.

No parameters.

Writes SubEtha.Adaptive.

Set-SubEthaSidecar

Sets the most objects the process’s sidecar holds at once. What one scan can cost grows with the number registered, so raise it for a count you have measured and have room to scan. With PassThru it writes the sidecar’s status once the cap is set; without it, nothing.

Also Set-SESidecar.

Writes SubEtha.SidecarStatus.

Order

New-SubEthaReorderWindow

Builds a reorder window. Floor is the window to start at and Cap the widest it may grow to; a window at least as wide as the number of senders puts every item back in order.

Also New-SEReorderWindow.

Writes SubEtha.ReorderWindow.

Shared state

New-SubEthaArena

Obtains the arena at Path holding CapacityBytes, creating it when the file does not exist.

Also New-SEArena.

Writes SubEtha.Arena.

New-SubEthaAtomic

Obtains the atomic at Path, creating it holding Init when the file does not exist and attaching to its live value when it does.

Also New-SEAtomic.

Writes SubEtha.Atomic.

New-SubEthaBitVec

Obtains the bit vector at Path holding CapacityBits bits, creating it cleared when the file does not exist.

Also New-SEBitVec.

Writes SubEtha.BitVec.

New-SubEthaBTreeMap

Obtains the ordered map at Path holding Capacity entries of KeySize-byte keys and ValueSize-byte values, creating it when the file does not exist.

Also New-SEBTreeMap.

Writes SubEtha.BTreeMap.

New-SubEthaCell

Obtains the cell at Path holding a value of ValueSize bytes, creating it when the file does not exist.

Also New-SECell.

Writes SubEtha.Cell.

New-SubEthaDeque

Obtains the deque at Path as its owner, holding Capacity items, a power of two, of ElementSize bytes, creating it when the file does not exist.

Also New-SEDeque.

Writes SubEtha.Deque.

New-SubEthaFrameRegion

Obtains the frame region at Path holding BlockCount blocks of BlockSize bytes, creating it when the file does not exist.

Also New-SEFrameRegion.

Writes SubEtha.FrameRegion.

New-SubEthaGraph

Obtains the graph beside Path holding up to MaxNodes nodes and MaxEdges edges, creating it when the files do not exist.

Also New-SEGraph.

Writes SubEtha.Graph.

New-SubEthaHandleTable

Obtains the handle table at Path holding Capacity values, creating it when the file does not exist; with Reset, empties it and remakes it at that capacity.

Also New-SEHandleTable.

Writes SubEtha.HandleTable.

New-SubEthaHashMap

Obtains the hash map at Path holding Capacity entries of KeySize-byte keys and ValueSize-byte values, creating it when the file does not exist.

Also New-SEHashMap.

Writes SubEtha.HashMap.

New-SubEthaLazyValue

Obtains the lazy value at Path holding ValueSize bytes, creating it unpublished when the file does not exist.

Also New-SELazyValue.

Writes SubEtha.LazyValue.

New-SubEthaLinkedList

Obtains the list at Path holding up to Capacity elements of ElementSize bytes, creating it when the file does not exist.

Also New-SELinkedList.

Writes SubEtha.LinkedList.

New-SubEthaRegion

Obtains the region at Path holding Capacity slots of SlotSize bytes, creating it when the file does not exist.

Also New-SERegion.

Writes SubEtha.Region.

New-SubEthaSharedArc

Obtains the shared value at Path, creating it holding Value when the file does not exist.

Also New-SESharedArc.

Writes SubEtha.SharedArc.

New-SubEthaSlab

Obtains the slab at Path holding Capacity slots of ElementSize bytes, creating it when the file does not exist.

Also New-SESlab.

Writes SubEtha.Slab.

New-SubEthaStack

Obtains the stack at Path holding up to Capacity items of ElementSize bytes, creating it when the file does not exist.

Also New-SEStack.

Writes SubEtha.Stack.

New-SubEthaTopologyMap

Obtains the topology map at Path for Participants, creating it when the file does not exist; with Reset, empties the counts and remakes it. The thresholds are how many different places a participant has to reach, or be reached from, before the shape counts as one to many or many to one.

Also New-SETopologyMap.

Writes SubEtha.TopologyMap.

New-SubEthaTower

Obtains the tower whose bottom level lives at Path holding Capacity values of ValueSize bytes, with the levels above it at LevelPath holding LevelCapacity places each, given top first; creating them when the files do not exist. With no levels the tower is one deep, which is a plain region reached by a path of one number.

Also New-SETower.

Writes SubEtha.Tower.

New-SubEthaUniversal

Obtains the self-storing set beside Path holding Capacity values, creating it when the files do not exist; with Reset, empties it and remakes it at that capacity.

Also New-SEUniversal.

Writes SubEtha.Universal.

New-SubEthaVec

Obtains the vector at Path holding up to Capacity elements of ElementSize bytes, creating it when the file does not exist.

Also New-SEVec.

Writes SubEtha.Vec.

Open-SubEthaArena

Attaches to the arena at Path, which must exist with the CapacityBytes it was created with; ReadOnly opens it to resolve without interning.

Also Open-SEArena.

Writes SubEtha.Arena.

Open-SubEthaAtomic

Attaches to the atomic at Path, which must exist, leaving its value alone.

Also Open-SEAtomic.

Writes SubEtha.Atomic.

Open-SubEthaBitVec

Attaches to the bit vector at Path, which must exist holding CapacityBits bits.

Also Open-SEBitVec.

Writes SubEtha.BitVec.

Open-SubEthaBTreeMap

Attaches to the ordered map at Path, which must exist with the capacity and sizes it was created with.

Also Open-SEBTreeMap.

Writes SubEtha.BTreeMap.

Open-SubEthaCell

Attaches to the cell at Path, which must exist with the same value size it was created with.

Also Open-SECell.

Writes SubEtha.Cell.

Open-SubEthaDeque

Attaches to the deque at Path as a thief: the handle steals from the deque another process owns, and neither pushes nor pops. No capacity is asked for, because the file states it.

Also Open-SEDeque.

Writes SubEtha.Deque.

Open-SubEthaFrameRegion

Attaches to the frame region at Path, which must exist with the block size and count it was created with.

Also Open-SEFrameRegion.

Writes SubEtha.FrameRegion.

Open-SubEthaGraph

Attaches to the graph beside Path, which must exist with the sizes it was made with.

Also Open-SEGraph.

Writes SubEtha.Graph.

Open-SubEthaHandleTable

Attaches to the handle table at Path, which must exist with the Capacity it was made with.

Also Open-SEHandleTable.

Writes SubEtha.HandleTable.

Open-SubEthaHashMap

Attaches to the hash map at Path, which must exist with the capacity and sizes it was created with.

Also Open-SEHashMap.

Writes SubEtha.HashMap.

Open-SubEthaLazyValue

Attaches to the lazy value at Path, which must exist holding ValueSize bytes.

Also Open-SELazyValue.

Writes SubEtha.LazyValue.

Open-SubEthaLinkedList

Attaches to the list at Path, which must exist with the capacity and layout it was created with.

Also Open-SELinkedList.

Writes SubEtha.LinkedList.

Open-SubEthaRegion

Attaches to the region at Path, which must exist with the same capacity and layout it was created with.

Also Open-SERegion.

Writes SubEtha.Region.

Open-SubEthaSharedArc

Attaches to the shared value at Path, which must exist holding ValueSize bytes.

Also Open-SESharedArc.

Writes SubEtha.SharedArc.

Open-SubEthaSlab

Attaches to the slab at Path, which must exist with the capacity and layout it was created with; ReadOnly opens it without write access.

Also Open-SESlab.

Writes SubEtha.Slab.

Open-SubEthaStack

Attaches to the stack at Path, which must exist with the capacity and layout it was created with.

Also Open-SEStack.

Writes SubEtha.Stack.

Open-SubEthaTopologyMap

Attaches to the topology map at Path, which must exist with the Participants it was made with.

Also Open-SETopologyMap.

Writes SubEtha.TopologyMap.

Open-SubEthaTower

Attaches to the tower at Path, which must exist with the shape it was made with.

Also Open-SETower.

Writes SubEtha.Tower.

Open-SubEthaUniversal

Attaches to the self-storing set beside Path, which must exist with the Capacity it was made with.

Also Open-SEUniversal.

Writes SubEtha.Universal.

Open-SubEthaVec

Attaches to the vector at Path, which must exist with the same capacity and layout it was created with.

Also Open-SEVec.

Writes SubEtha.Vec.