Modulekes-agent-1.3.0.0Haskell2010

Cardano.KESAgent.Serialization.RawUtil

Various bits and pieces for raw serialization.

2 types
33 values

Packagekes-agent-1.3.0.0
Exports35
LanguageHaskell2010
LicenceApache-2.0
SourceRawUtil.hs

The ReadResult type

1 declaration

datadata ReadResult a

Result of a read operation.

Constructors

ReadOK a
read succeeded, yielding a result
ReadMalformed !String
encountered malformed data
ReadVersionMismatch !VersionIdentifier !VersionIdentifier
read failed due to a protocol version mismatch
ReadEOF
read failed due to unexpected end of stream/file

Instances4Functor, Eq, Show, Exception

Functor ReadResultDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Serialization.RawUtil
Eq a => Eq (ReadResult a)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Serialization.RawUtil
Show a => Show (ReadResult a)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Serialization.RawUtil
(Show a, Typeable a) => Exception (ReadResult a)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Serialization.RawUtil

The ReadResultT monad transformer.

2 declarations

newtypenewtype ReadResultT (m :: Type -> Type) a

This works much like ExceptT, short-circuiting upon encountering any ReadResult other than ReadOK.

Constructors

ReadResultT
- runReadResultT :: m (ReadResult a)

Instances4MonadTrans, Monad, Functor, Applicative

MonadTrans ReadResultTDefined in kes-agent-1.3.0.0 · Cardano.KESAgent.Serialization.RawUtil
Monad m => Monad (ReadResultT m)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Serialization.RawUtil
Functor m => Functor (ReadResultT m)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Serialization.RawUtil
(Functor m, Applicative m, Monad m) => Applicative (ReadResultT m)Defined in kes-agent-1.3.0.0 · Cardano.KESAgent.Serialization.RawUtil

valuereadResultT :: Applicative m => ReadResult a -> ReadResultT m a

Turn a pure ReadResult into a ReadResultT action.

ReadResultT send and receive functions for specific types

31 declarations

valuesendVersion

:: (VersionedProtocol protocol, MonadST m, MonadThrow m)
=> Proxy protocol
-> RawBearer m
-> Tracer m VersionIdentifier
-> m ()

Send a VersionIdentifier

valuecheckVersion

:: (VersionedProtocol protocol, MonadST m, MonadThrow m, MonadFail m)
=> Proxy protocol
-> RawBearer m
-> Tracer m VersionIdentifier
-> m (ReadResult ())

Receive a VersionIdentifier and verify that it matches the expected version.

valuereceiveSK

:: (MonadST m, MonadSTM m, MonadMVar m, MonadThrow m, KESAlgorithm k, DirectDeserialise (SignKeyKES k))
=> RawBearer m
-> Tracer m String
-> m (ReadResult (SignKeyKES k))

Receive a sign key

valuesendSKP

:: (MonadST m, MonadSTM m, MonadThrow m, KESAlgorithm k, DirectSerialise (SignKeyKES k))
=> RawBearer m
-> CRef m (SignKeyWithPeriodKES k)
-> m ()

Send a sign key + KES period

valuereceiveSKP

:: (MonadST m, MonadSTM m, MonadMVar m, MonadThrow m, KESAlgorithm k, DirectDeserialise (SignKeyKES k))
=> RawBearer m
-> Tracer m String
-> m (ReadResult (CRef m (SignKeyWithPeriodKES k)))

Receive a sign key + KES period

valuereceiveBS

:: (MonadST m, MonadThrow m)
=> RawBearer m
-> Int
-> m (ReadResult ByteString)

valuesendBS :: (MonadST m, MonadThrow m) => RawBearer m -> ByteString -> m Int

valuereceiveWord8

:: (MonadThrow m, MonadST m)
=> RawBearer m
-> m (ReadResult Word8)

valuereceiveWord16

:: (MonadThrow m, MonadST m)
=> RawBearer m
-> m (ReadResult Word16)

valuereceiveWord32

:: (MonadThrow m, MonadST m)
=> RawBearer m
-> m (ReadResult Word32)

valuereceiveWord64

:: (MonadThrow m, MonadST m)
=> RawBearer m
-> m (ReadResult Word64)

valuereceiveInt8

:: (MonadThrow m, MonadST m)
=> RawBearer m
-> m (ReadResult Int8)

valuereceiveInt16

:: (MonadThrow m, MonadST m)
=> RawBearer m
-> m (ReadResult Int16)

valuereceiveInt32

:: (MonadThrow m, MonadST m)
=> RawBearer m
-> m (ReadResult Int32)

valuereceiveInt64

:: (MonadThrow m, MonadST m)
=> RawBearer m
-> m (ReadResult Int64)

valuesendWord8 :: (MonadThrow m, MonadST m) => RawBearer m -> Word8 -> m ()

valuesendWord16 :: (MonadThrow m, MonadST m) => RawBearer m -> Word16 -> m ()

valuesendWord32 :: (MonadThrow m, MonadST m) => RawBearer m -> Word32 -> m ()

valuesendWord64 :: (MonadThrow m, MonadST m) => RawBearer m -> Word64 -> m ()

valuesendInt8 :: (MonadThrow m, MonadST m) => RawBearer m -> Int8 -> m ()

valuesendInt16 :: (MonadThrow m, MonadST m) => RawBearer m -> Int16 -> m ()

valuesendInt32 :: (MonadThrow m, MonadST m) => RawBearer m -> Int32 -> m ()

valuesendInt64 :: (MonadThrow m, MonadST m) => RawBearer m -> Int64 -> m ()

valuesendUTCTime :: (MonadThrow m, MonadST m) => RawBearer m -> UTCTime -> m ()

valuereceiveUTCTime

:: (MonadThrow m, MonadST m)
=> RawBearer m
-> m (ReadResult UTCTime)

valuesendEnum

:: (MonadST m, MonadThrow m, Enum a, Bounded a)
=> RawBearer m
-> a
-> m ()

valuereceiveEnum

:: (MonadST m, MonadThrow m, Enum a, Bounded a)
=> String
-> RawBearer m
-> m (ReadResult a)

valuesendRecvResult

:: (MonadST m, MonadThrow m)
=> RawBearer m
-> RecvResult
-> m ()

valuereceiveRecvResult

:: (MonadST m, MonadThrow m)
=> RawBearer m
-> m (ReadResult RecvResult)

valueencodeRecvResult :: RecvResult -> Word32

valuedecodeRecvResult :: Word32 -> RecvResult

Unsafe API

1 declaration

valueunsafeReceiveN

:: Monad m
=> RawBearer m
-> Ptr CChar
-> CSize
-> m (ReadResult CSize)

Receive bytes into a memory buffer through a raw pointer. unsafeReceiveN s buf bufSize will attempt to read up to bufSize bytes from bearer s into the buffer pointed to by buf, returning a ReadOK with the number of bytes actually read on success, or a suitable ReadResult on failure. buf must point to a block of memory at least bufSize bytes in size; it may be larger though. bufSize must not be 0. The return value may signal fewer than bufSize bytes in cases where not enough bytes are available from the bearer. In such cases, the caller should call unsafeReceiveN again with an appropriate bufSize to fetch the remaining bytes.