cardano-node-8.8.1: The cardano full node
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Node.Handlers.Shutdown

Synopsis

Documentation

data ShutdownOn Source #

Constructors

ASlot !SlotNo 
ABlock !BlockNo 
NoShutdown 

Instances

Instances details
FromJSON ShutdownOn Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Methods

parseJSON :: Value -> Parser ShutdownOn #

parseJSONList :: Value -> Parser [ShutdownOn] #

omittedField :: Maybe ShutdownOn #

ToJSON ShutdownOn Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Methods

toJSON :: ShutdownOn -> Value #

toEncoding :: ShutdownOn -> Encoding #

toJSONList :: [ShutdownOn] -> Value #

toEncodingList :: [ShutdownOn] -> Encoding #

omitField :: ShutdownOn -> Bool #

Generic ShutdownOn Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Associated Types

type Rep ShutdownOn :: Type -> Type Source #

Methods

from :: ShutdownOn -> Rep ShutdownOn x Source #

to :: Rep ShutdownOn x -> ShutdownOn Source #

Show ShutdownOn Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Methods

showsPrec :: Int -> ShutdownOn -> ShowS Source #

show :: ShutdownOn -> String Source #

showList :: [ShutdownOn] -> ShowS Source #

NFData ShutdownOn Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Methods

rnf :: ShutdownOn -> () Source #

Eq ShutdownOn Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Methods

(==) :: ShutdownOn -> ShutdownOn -> Bool Source #

(/=) :: ShutdownOn -> ShutdownOn -> Bool Source #

type Rep ShutdownOn Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

type Rep ShutdownOn = D1 ('MetaData "ShutdownOn" "Cardano.Node.Handlers.Shutdown" "cardano-node-8.8.1-inplace" 'False) (C1 ('MetaCons "ASlot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNo)) :+: (C1 ('MetaCons "ABlock" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BlockNo)) :+: C1 ('MetaCons "NoShutdown" 'PrefixI 'False) (U1 :: Type -> Type)))

parseShutdownOn :: Parser ShutdownOn Source #

Generalised shutdown handling

data ShutdownConfig Source #

Constructors

ShutdownConfig 

Fields

Instances

Instances details
Show ShutdownConfig Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Methods

showsPrec :: Int -> ShutdownConfig -> ShowS Source #

show :: ShutdownConfig -> String Source #

showList :: [ShutdownConfig] -> ShowS Source #

Eq ShutdownConfig Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Methods

(==) :: ShutdownConfig -> ShutdownConfig -> Bool Source #

(/=) :: ShutdownConfig -> ShutdownConfig -> Bool Source #

withShutdownHandling Source #

Arguments

:: ShutdownConfig 
-> Tracer IO ShutdownTrace 
-> IO ()

Action to potentially shutdown via file descriptor

-> IO () 

We provide an optional cross-platform method to politely request shut down. The parent process passes us the file descriptor number of the read end of a pipe, via the CLI with --shutdown-ipc FD

data ShutdownTrace Source #

Constructors

ShutdownRequested

Received shutdown request

AbnormalShutdown

Non-isEOFError shutdown request

ShutdownUnexpectedInput Text

Received shutdown request but found unexpected input in --shutdown-ipc FD:

RequestingShutdown Text

Ringing the node shutdown doorbell for reason

ShutdownArmedAt ShutdownOn

Will terminate upon reaching a ChainDB sync limit

Instances

Instances details
FromJSON ShutdownTrace Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Methods

parseJSON :: Value -> Parser ShutdownTrace #

parseJSONList :: Value -> Parser [ShutdownTrace] #

omittedField :: Maybe ShutdownTrace #

ToJSON ShutdownTrace Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Methods

toJSON :: ShutdownTrace -> Value #

toEncoding :: ShutdownTrace -> Encoding #

toJSONList :: [ShutdownTrace] -> Value #

toEncodingList :: [ShutdownTrace] -> Encoding #

omitField :: ShutdownTrace -> Bool #

Generic ShutdownTrace Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Associated Types

type Rep ShutdownTrace :: Type -> Type Source #

Methods

from :: ShutdownTrace -> Rep ShutdownTrace x Source #

to :: Rep ShutdownTrace x -> ShutdownTrace Source #

NFData ShutdownTrace Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

Methods

rnf :: ShutdownTrace -> () Source #

HasPrivacyAnnotation ShutdownTrace Source # 
Instance details

Defined in Cardano.Tracing.Shutdown

Methods

getPrivacyAnnotation :: ShutdownTrace -> PrivacyAnnotation #

HasSeverityAnnotation ShutdownTrace Source # 
Instance details

Defined in Cardano.Tracing.Shutdown

Methods

getSeverityAnnotation :: ShutdownTrace -> Severity #

HasTextFormatter ShutdownTrace Source # 
Instance details

Defined in Cardano.Tracing.Shutdown

Methods

formatText :: ShutdownTrace -> Object -> Text #

ToObject ShutdownTrace Source # 
Instance details

Defined in Cardano.Tracing.Shutdown

Methods

toObject :: TracingVerbosity -> ShutdownTrace -> Object #

textTransformer :: ShutdownTrace -> Object -> Text #

LogFormatting ShutdownTrace Source # 
Instance details

Defined in Cardano.Node.Tracing.Tracers.Shutdown

Methods

forMachine :: DetailLevel -> ShutdownTrace -> Object Source #

forHuman :: ShutdownTrace -> Text Source #

forHumanOrMachine :: ShutdownTrace -> Text Source #

asMetrics :: ShutdownTrace -> [Metric] Source #

MetaTrace ShutdownTrace Source # 
Instance details

Defined in Cardano.Node.Tracing.Tracers.Shutdown

Methods

namespaceFor :: ShutdownTrace -> Namespace ShutdownTrace Source #

severityFor :: Namespace ShutdownTrace -> Maybe ShutdownTrace -> Maybe SeverityS Source #

privacyFor :: Namespace ShutdownTrace -> Maybe ShutdownTrace -> Maybe Privacy Source #

detailsFor :: Namespace ShutdownTrace -> Maybe ShutdownTrace -> Maybe DetailLevel Source #

documentFor :: Namespace ShutdownTrace -> Maybe Text Source #

metricsDocFor :: Namespace ShutdownTrace -> [(Text, Text)] Source #

allNamespaces :: [Namespace ShutdownTrace] Source #

Transformable Text IO ShutdownTrace Source # 
Instance details

Defined in Cardano.Tracing.Shutdown

Methods

trTransformer :: TracingVerbosity -> Trace IO Text -> Tracer IO ShutdownTrace #

type Rep ShutdownTrace Source # 
Instance details

Defined in Cardano.Node.Handlers.Shutdown

type Rep ShutdownTrace = D1 ('MetaData "ShutdownTrace" "Cardano.Node.Handlers.Shutdown" "cardano-node-8.8.1-inplace" 'False) ((C1 ('MetaCons "ShutdownRequested" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AbnormalShutdown" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ShutdownUnexpectedInput" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "RequestingShutdown" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "ShutdownArmedAt" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShutdownOn)))))

Watch ChainDB for passing a configured slot sync limit threshold,

maybeSpawnOnSlotSyncedShutdownHandler :: HasHeader (Header blk) => ShutdownConfig -> Tracer IO ShutdownTrace -> ResourceRegistry IO -> ChainDB IO blk -> IO () Source #

Spawn a thread that would cause node to shutdown upon ChainDB reaching the configuration-defined slot.