| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Test.Ouroboros.Network.Diffusion.Node.NodeKernel
Contents
Description
Node kernel which does chain selection and block production.
Synopsis
- type NtNAddr = TestAddress NtNAddr_
- data NtNAddr_
- = EphemeralIPv4Addr Natural
- | EphemeralIPv6Addr Natural
- | IPAddr IP PortNumber
- encodeNtNAddr :: NtNAddr -> Encoding
- decodeNtNAddr :: Decoder s NtNAddr
- ntnAddrToRelayAccessPoint :: NtNAddr -> Maybe RelayAccessPoint
- type NtNVersion = UnversionedProtocol
- data NtNVersionData = NtNVersionData {
- ntnDiffusionMode :: DiffusionMode
- ntnPeerSharing :: PeerSharing
- type NtCAddr = TestAddress Int
- type NtCVersion = UnversionedProtocol
- type NtCVersionData = UnversionedProtocolData
- data BlockGeneratorArgs block s = BlockGeneratorArgs {
- bgaSlotDuration :: DiffTime
- bgaBlockGenerator :: s -> Anchor block -> SlotNo -> (Maybe block, s)
- bgaSeed :: s
- relayBlockGenerationArgs :: DiffTime -> seed -> BlockGeneratorArgs block seed
- randomBlockGenerationArgs :: DiffTime -> StdGen -> Int -> BlockGeneratorArgs Block StdGen
- data NodeKernel header block m = NodeKernel {
- nkClientChains :: StrictTVar m (Map NtNAddr (StrictTVar m (Chain header)))
- nkChainProducerState :: StrictTVar m (ChainProducerState block)
- nkFetchClientRegistry :: FetchClientRegistry NtNAddr header block m
- nkPeerSharingRegistry :: PeerSharingRegistry NtNAddr m
- nkChainDB :: ChainDB block m
- newNodeKernel :: MonadSTM m => m (NodeKernel header block m)
- registerClientChains :: MonadSTM m => NodeKernel header block m -> NtNAddr -> m (StrictTVar m (Chain header))
- unregisterClientChains :: MonadSTM m => NodeKernel header block m -> NtNAddr -> m ()
- withNodeKernelThread :: forall block header m seed a. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadMonotonicTime m, MonadTimer m, MonadThrow m, MonadThrow (STM m), HasFullHeader block) => BlockGeneratorArgs block seed -> (NodeKernel header block m -> Async m Void -> m a) -> m a
- data NodeKernelError = UnexpectedSlot !SlotNo !SlotNo
Common types
type NtNAddr = TestAddress NtNAddr_ Source #
Node-to-node address type.
Constructors
| EphemeralIPv4Addr Natural | |
| EphemeralIPv6Addr Natural | |
| IPAddr IP PortNumber |
Instances
encodeNtNAddr :: NtNAddr -> Encoding Source #
decodeNtNAddr :: Decoder s NtNAddr Source #
type NtNVersion = UnversionedProtocol Source #
data NtNVersionData Source #
Constructors
| NtNVersionData | |
Fields
| |
Instances
type NtCAddr = TestAddress Int Source #
type NtCVersion = UnversionedProtocol Source #
type NtCVersionData = UnversionedProtocolData Source #
Node kernel
data BlockGeneratorArgs block s Source #
Constructors
| BlockGeneratorArgs | |
Fields
| |
relayBlockGenerationArgs :: DiffTime -> seed -> BlockGeneratorArgs block seed Source #
Do not generate blocks.
randomBlockGenerationArgs :: DiffTime -> StdGen -> Int -> BlockGeneratorArgs Block StdGen Source #
Generate a block according to given probability.
data NodeKernel header block m Source #
Constructors
| NodeKernel | |
Fields
| |
newNodeKernel :: MonadSTM m => m (NodeKernel header block m) Source #
registerClientChains :: MonadSTM m => NodeKernel header block m -> NtNAddr -> m (StrictTVar m (Chain header)) Source #
Register a new upstream chain-sync client.
unregisterClientChains :: MonadSTM m => NodeKernel header block m -> NtNAddr -> m () Source #
Unregister an upstream chain-sync client.
Arguments
| :: forall block header m seed a. (Alternative (STM m), MonadAsync m, MonadDelay m, MonadMonotonicTime m, MonadTimer m, MonadThrow m, MonadThrow (STM m), HasFullHeader block) | |
| => BlockGeneratorArgs block seed | |
| -> (NodeKernel header block m -> Async m Void -> m a) | The continuation which has a handle to the chain selection / block production thread. The thread might throw an exception. |
| -> m a |
Run chain selection / block production thread.
data NodeKernelError Source #
Node kernel erros.
Constructors
| UnexpectedSlot !SlotNo !SlotNo |