Safe Haskell	None
Language	Haskell2010

DMQ.Configuration

Synopsis

data Configuration' (f :: Type -> Type) = Configuration {
- dmqcIPv4 :: f (Maybe IPv4)
- dmqcIPv6 :: f (Maybe IPv6)
- dmqcLocalAddress :: f LocalAddress
- dmqcPortNumber :: f PortNumber
- dmqcConfigFile :: f FilePath
- dmqcTopologyFile :: f FilePath
- dmqcAcceptedConnectionsLimit :: f AcceptedConnectionsLimit
- dmqcDiffusionMode :: f DiffusionMode
- dmqcTargetOfRootPeers :: f Int
- dmqcTargetOfKnownPeers :: f Int
- dmqcTargetOfEstablishedPeers :: f Int
- dmqcTargetOfActivePeers :: f Int
- dmqcTargetOfKnownBigLedgerPeers :: f Int
- dmqcTargetOfEstablishedBigLedgerPeers :: f Int
- dmqcTargetOfActiveBigLedgerPeers :: f Int
- dmqcProtocolIdleTimeout :: f DiffTime
- dmqcChurnInterval :: f DiffTime
- dmqcPeerSharing :: f PeerSharing
- dmqcNetworkMagic :: f NetworkMagic
- dmqcPrettyLog :: f Bool
- dmqcMuxTracer :: f Bool
- dmqcChannelTracer :: f Bool
- dmqcBearerTracer :: f Bool
- dmqcHandshakeTracer :: f Bool
- dmqcLocalMuxTracer :: f Bool
- dmqcLocalChannelTracer :: f Bool
- dmqcLocalBearerTracer :: f Bool
- dmqcLocalHandshakeTracer :: f Bool
- dmqcDiffusionTracer :: f Bool
- dmqcTraceLocalRootPeersTracer :: f Bool
- dmqcTracePublicRootPeersTracer :: f Bool
- dmqcTraceLedgerPeersTracer :: f Bool
- dmqcTracePeerSelectionTracer :: f Bool
- dmqcTraceChurnCounters :: f Bool
- dmqcDebugPeerSelectionInitiatorTracer :: f Bool
- dmqcDebugPeerSelectionInitiatorResponderTracer :: f Bool
- dmqcTracePeerSelectionCounters :: f Bool
- dmqcPeerSelectionActionsTracer :: f Bool
- dmqcConnectionManagerTracer :: f Bool
- dmqcConnectionManagerTransitionTracer :: f Bool
- dmqcServerTracer :: f Bool
- dmqcInboundGovernorTracer :: f Bool
- dmqcInboundGovernorTransitionTracer :: f Bool
- dmqcLocalConnectionManagerTracer :: f Bool
- dmqcLocalServerTracer :: f Bool
- dmqcLocalInboundGovernorTracer :: f Bool
- dmqcDnsTracer :: f Bool
- dmqcSigSubmissionClientProtocolTracer :: f Bool
- dmqcSigSubmissionServerProtocolTracer :: f Bool
- dmqcKeepAliveClientProtocolTracer :: f Bool
- dmqcKeepAliveServerProtocolTracer :: f Bool
- dmqcPeerSharingClientProtocolTracer :: f Bool
- dmqcPeerSharingServerProtocolTracer :: f Bool
- dmqcLocalMsgSubmissionServerProtocolTracer :: f Bool
- dmqcLocalMsgNotificationServerProtocolTracer :: f Bool
- dmqcSigSubmissionLogicTracer :: f Bool
- dmqcSigSubmissionOutboundTracer :: f Bool
- dmqcSigSubmissionInboundTracer :: f Bool
- dmqcLocalMsgSubmissionServerTracer :: f Bool
- dmqcVersion :: f Bool
}
type PartialConfig = Configuration' Last
type Configuration = Configuration' I
newtype I a = I {
- unI :: a
}
readConfigurationFileOrError :: FilePath -> IO PartialConfig
mkDiffusionConfiguration :: HasCallStack => Configuration -> NetworkTopology NoExtraConfig NoExtraFlags -> IO (Configuration NoExtraFlags IO ntnFd RemoteAddress ntcFd LocalAddress)
defaultSigDecisionPolicy :: TxDecisionPolicy
defaultConfiguration :: Configuration
data NoExtraConfig = NoExtraConfig
data NoExtraFlags = NoExtraFlags
newtype LocalAddress = LocalAddress {
- getFilePath :: FilePath
}

Documentation

data Configuration' (f :: Type -> Type) Source #

Configuration comes in two flavours paramemtrised by f functor: PartialConfig is using Last and Configuration is using an identity functor I.

Constructors

Configuration

Fields

dmqcIPv4 :: f (Maybe IPv4)
dmqcIPv6 :: f (Maybe IPv6)
dmqcLocalAddress :: f LocalAddress
dmqcPortNumber :: f PortNumber
dmqcConfigFile :: f FilePath
dmqcTopologyFile :: f FilePath
dmqcAcceptedConnectionsLimit :: f AcceptedConnectionsLimit
dmqcDiffusionMode :: f DiffusionMode
dmqcTargetOfRootPeers :: f Int
dmqcTargetOfKnownPeers :: f Int
dmqcTargetOfEstablishedPeers :: f Int
dmqcTargetOfActivePeers :: f Int
dmqcTargetOfKnownBigLedgerPeers :: f Int
dmqcTargetOfEstablishedBigLedgerPeers :: f Int
dmqcTargetOfActiveBigLedgerPeers :: f Int
dmqcProtocolIdleTimeout :: f DiffTime
dmqcChurnInterval :: f DiffTime
dmqcPeerSharing :: f PeerSharing
dmqcNetworkMagic :: f NetworkMagic
dmqcPrettyLog :: f Bool
dmqcMuxTracer :: f Bool
dmqcChannelTracer :: f Bool
dmqcBearerTracer :: f Bool
dmqcHandshakeTracer :: f Bool
dmqcLocalMuxTracer :: f Bool
dmqcLocalChannelTracer :: f Bool
dmqcLocalBearerTracer :: f Bool
dmqcLocalHandshakeTracer :: f Bool
dmqcDiffusionTracer :: f Bool
dmqcTraceLocalRootPeersTracer :: f Bool
dmqcTracePublicRootPeersTracer :: f Bool
dmqcTraceLedgerPeersTracer :: f Bool
dmqcTracePeerSelectionTracer :: f Bool
dmqcTraceChurnCounters :: f Bool
dmqcDebugPeerSelectionInitiatorTracer :: f Bool
dmqcDebugPeerSelectionInitiatorResponderTracer :: f Bool
dmqcTracePeerSelectionCounters :: f Bool
dmqcPeerSelectionActionsTracer :: f Bool
dmqcConnectionManagerTracer :: f Bool
dmqcConnectionManagerTransitionTracer :: f Bool
dmqcServerTracer :: f Bool
dmqcInboundGovernorTracer :: f Bool
dmqcInboundGovernorTransitionTracer :: f Bool
dmqcLocalConnectionManagerTracer :: f Bool
dmqcLocalServerTracer :: f Bool
dmqcLocalInboundGovernorTracer :: f Bool
dmqcDnsTracer :: f Bool
dmqcSigSubmissionClientProtocolTracer :: f Bool
dmqcSigSubmissionServerProtocolTracer :: f Bool
dmqcKeepAliveClientProtocolTracer :: f Bool
dmqcKeepAliveServerProtocolTracer :: f Bool
dmqcPeerSharingClientProtocolTracer :: f Bool
dmqcPeerSharingServerProtocolTracer :: f Bool
dmqcLocalMsgSubmissionServerProtocolTracer :: f Bool
dmqcLocalMsgNotificationServerProtocolTracer :: f Bool
dmqcSigSubmissionLogicTracer :: f Bool
dmqcSigSubmissionOutboundTracer :: f Bool
dmqcSigSubmissionInboundTracer :: f Bool
dmqcLocalMsgSubmissionServerTracer :: f Bool
dmqcVersion :: f Bool

Instances

Instances details

FromJSON PartialConfig Source #

Parsing configuration used when reading it from disk

Instance details

Defined in DMQ.Configuration

Methods

parseJSON :: Value -> Parser PartialConfig #

parseJSONList :: Value -> Parser [PartialConfig] #

omittedField :: Maybe PartialConfig #

ToJSON Configuration Source #

ToJSON instance used by logging system.

Instance details

Defined in DMQ.Configuration

Methods

toJSON :: Configuration -> Value #

toEncoding :: Configuration -> Encoding #

toJSONList :: [Configuration] -> Value #

toEncodingList :: [Configuration] -> Encoding #

omitField :: Configuration -> Bool #

Show Configuration Source #

Instance details

Defined in DMQ.Configuration

Methods

showsPrec :: Int -> Configuration -> ShowS #

show :: Configuration -> String #

showList :: [Configuration] -> ShowS #

Show PartialConfig Source #

Instance details

Defined in DMQ.Configuration

Methods

showsPrec :: Int -> PartialConfig -> ShowS #

show :: PartialConfig -> String #

showList :: [PartialConfig] -> ShowS #

(forall a. Monoid (f a)) => Monoid (Configuration' f) Source #

Instance details

Defined in DMQ.Configuration

Methods

mempty :: Configuration' f #

mappend :: Configuration' f -> Configuration' f -> Configuration' f #

mconcat :: [Configuration' f] -> Configuration' f #

(forall a. Semigroup (f a)) => Semigroup (Configuration' f) Source #

Instance details

Defined in DMQ.Configuration

Methods

(<>) :: Configuration' f -> Configuration' f -> Configuration' f #

sconcat :: NonEmpty (Configuration' f) -> Configuration' f #

stimes :: Integral b => b -> Configuration' f -> Configuration' f #

Generic (Configuration' f) Source #

Instance details

Defined in DMQ.Configuration

Associated Types

type Rep (Configuration' f)

Instance details

Defined in DMQ.Configuration

Methods

from :: Configuration' f -> Rep (Configuration' f) x #

to :: Rep (Configuration' f) x -> Configuration' f #

(forall a. Act (f a) (g a)) => Act (Configuration' f) (Configuration' g) Source #

Instance details

Defined in DMQ.Configuration

Methods

(•) :: Configuration' f -> Configuration' g -> Configuration' g #

act :: Configuration' f -> Configuration' g -> Configuration' g #

type Rep (Configuration' f) Source #

Instance details

Defined in DMQ.Configuration

type PartialConfig = Configuration' Last Source #

type Configuration = Configuration' I Source #

newtype I a Source #

An Identity functor, but shorter to type.

Constructors

I
Fields unI :: a

Instances

Instances details

ToJSON Configuration Source #

ToJSON instance used by logging system.

Instance details

Defined in DMQ.Configuration

Methods

toJSON :: Configuration -> Value #

toEncoding :: Configuration -> Encoding #

toJSONList :: [Configuration] -> Value #

toEncodingList :: [Configuration] -> Encoding #

omitField :: Configuration -> Bool #

Applicative I Source #

Instance details

Defined in DMQ.Configuration

Methods

pure :: a -> I a #

(<*>) :: I (a -> b) -> I a -> I b #

liftA2 :: (a -> b -> c) -> I a -> I b -> I c #

(*>) :: I a -> I b -> I b #

(<*) :: I a -> I b -> I a #

Functor I Source #

Instance details

Defined in DMQ.Configuration

Methods

fmap :: (a -> b) -> I a -> I b #

(<$) :: a -> I b -> I a #

Monad I Source #

Instance details

Defined in DMQ.Configuration

Methods

(>>=) :: I a -> (a -> I b) -> I b #

(>>) :: I a -> I b -> I b #

return :: a -> I a #

Show Configuration Source #

Instance details

Defined in DMQ.Configuration

Methods

showsPrec :: Int -> Configuration -> ShowS #

show :: Configuration -> String #

showList :: [Configuration] -> ShowS #

Generic (I a) Source #

Instance details

Defined in DMQ.Configuration

Associated Types

type Rep (I a)
Instance details Defined in DMQ.Configuration type Rep (I a) = D1 ('MetaData "I" "DMQ.Configuration" "dmq-node-0.2.0.0-inplace" 'True) (C1 ('MetaCons "I" 'PrefixI 'True) (S1 ('MetaSel ('Just "unI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

Methods

from :: I a -> Rep (I a) x #

to :: Rep (I a) x -> I a #

Show a => Show (I a) Source #

Instance details

Defined in DMQ.Configuration

Methods

showsPrec :: Int -> I a -> ShowS #

show :: I a -> String #

showList :: [I a] -> ShowS #

Act (Last a) (I a) Source #

Instance details

Defined in DMQ.Configuration

Methods

(•) :: Last a -> I a -> I a #

act :: Last a -> I a -> I a #

type Rep (I a) Source #

Instance details

Defined in DMQ.Configuration

type Rep (I a) = D1 ('MetaData "I" "DMQ.Configuration" "dmq-node-0.2.0.0-inplace" 'True) (C1 ('MetaCons "I" 'PrefixI 'True) (S1 ('MetaSel ('Just "unI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

readConfigurationFileOrError :: FilePath -> IO PartialConfig Source #

mkDiffusionConfiguration :: HasCallStack => Configuration -> NetworkTopology NoExtraConfig NoExtraFlags -> IO (Configuration NoExtraFlags IO ntnFd RemoteAddress ntcFd LocalAddress) Source #

defaultSigDecisionPolicy :: TxDecisionPolicy Source #

defaultConfiguration :: Configuration Source #

By using Configuration type we enforce that every value has a default, except of IP addresses, which are using Maybe values. This is needed to make sure one can configure only the IP addresses which are available on the system.

data NoExtraConfig Source #

Constructors

NoExtraConfig

Instances

Instances details

Show NoExtraConfig Source #
Instance details Defined in DMQ.Configuration.Topology Methods showsPrec :: Int -> NoExtraConfig -> ShowS # show :: NoExtraConfig -> String # showList :: [NoExtraConfig] -> ShowS #
FromJSON (NetworkTopology NoExtraConfig NoExtraFlags) Source #
Instance details Defined in DMQ.Configuration.Topology Methods parseJSON :: Value -> Parser (NetworkTopology NoExtraConfig NoExtraFlags) # parseJSONList :: Value -> Parser [NetworkTopology NoExtraConfig NoExtraFlags] # omittedField :: Maybe (NetworkTopology NoExtraConfig NoExtraFlags) #
ToJSON (NetworkTopology NoExtraConfig NoExtraFlags) Source #
Instance details Defined in DMQ.Configuration.Topology Methods toJSON :: NetworkTopology NoExtraConfig NoExtraFlags -> Value # toEncoding :: NetworkTopology NoExtraConfig NoExtraFlags -> Encoding # toJSONList :: [NetworkTopology NoExtraConfig NoExtraFlags] -> Value # toEncodingList :: [NetworkTopology NoExtraConfig NoExtraFlags] -> Encoding # omitField :: NetworkTopology NoExtraConfig NoExtraFlags -> Bool #

data NoExtraFlags Source #

Constructors

NoExtraFlags

Instances

Instances details

ToJSON NoExtraFlags Source #
Instance details Defined in DMQ.Configuration.Topology Methods toJSON :: NoExtraFlags -> Value # toEncoding :: NoExtraFlags -> Encoding # toJSONList :: [NoExtraFlags] -> Value # toEncodingList :: [NoExtraFlags] -> Encoding # omitField :: NoExtraFlags -> Bool #
Show NoExtraFlags Source #
Instance details Defined in DMQ.Configuration.Topology Methods showsPrec :: Int -> NoExtraFlags -> ShowS # show :: NoExtraFlags -> String # showList :: [NoExtraFlags] -> ShowS #
Eq NoExtraFlags Source #
Instance details Defined in DMQ.Configuration.Topology Methods (==) :: NoExtraFlags -> NoExtraFlags -> Bool # (/=) :: NoExtraFlags -> NoExtraFlags -> Bool #
FromJSON (NetworkTopology NoExtraConfig NoExtraFlags) Source #
Instance details Defined in DMQ.Configuration.Topology Methods parseJSON :: Value -> Parser (NetworkTopology NoExtraConfig NoExtraFlags) # parseJSONList :: Value -> Parser [NetworkTopology NoExtraConfig NoExtraFlags] # omittedField :: Maybe (NetworkTopology NoExtraConfig NoExtraFlags) #
ToJSON (NetworkTopology NoExtraConfig NoExtraFlags) Source #
Instance details Defined in DMQ.Configuration.Topology Methods toJSON :: NetworkTopology NoExtraConfig NoExtraFlags -> Value # toEncoding :: NetworkTopology NoExtraConfig NoExtraFlags -> Encoding # toJSONList :: [NetworkTopology NoExtraConfig NoExtraFlags] -> Value # toEncodingList :: [NetworkTopology NoExtraConfig NoExtraFlags] -> Encoding # omitField :: NetworkTopology NoExtraConfig NoExtraFlags -> Bool #
ToJSON (DebugPeerSelection NoExtraState NoExtraFlags NoExtraPeers RemoteAddress) Source #
Instance details Defined in DMQ.Tracer Methods toJSON :: DebugPeerSelection NoExtraState NoExtraFlags NoExtraPeers RemoteAddress -> Value # toEncoding :: DebugPeerSelection NoExtraState NoExtraFlags NoExtraPeers RemoteAddress -> Encoding # toJSONList :: [DebugPeerSelection NoExtraState NoExtraFlags NoExtraPeers RemoteAddress] -> Value # toEncodingList :: [DebugPeerSelection NoExtraState NoExtraFlags NoExtraPeers RemoteAddress] -> Encoding # omitField :: DebugPeerSelection NoExtraState NoExtraFlags NoExtraPeers RemoteAddress -> Bool #

newtype LocalAddress #

Constructors

LocalAddress
Fields getFilePath :: FilePath

Instances

Instances details

ToJSON LocalAddress

Instance details

Defined in Ouroboros.Network.OrphanInstances

Methods

toJSON :: LocalAddress -> Value #

toEncoding :: LocalAddress -> Encoding #

toJSONList :: [LocalAddress] -> Value #

toEncodingList :: [LocalAddress] -> Encoding #

omitField :: LocalAddress -> Bool #

ToJSONKey LocalAddress

Instance details

Defined in Ouroboros.Network.OrphanInstances

Methods

toJSONKey :: ToJSONKeyFunction LocalAddress #

toJSONKeyList :: ToJSONKeyFunction [LocalAddress] #

Generic LocalAddress

Instance details

Defined in Ouroboros.Network.Snocket

Associated Types

type Rep LocalAddress
Instance details Defined in Ouroboros.Network.Snocket type Rep LocalAddress = D1 ('MetaData "LocalAddress" "Ouroboros.Network.Snocket" "ouroboros-network-0.23.0.0-inplace-framework" 'True) (C1 ('MetaCons "LocalAddress" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFilePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))