Network.Flink.Stateful

Primary module containing everything needed to create stateful functions with Flink.

All stateful functions should have a single record type that represents the entire internal state of the function. Stateful functions API provides many "slots" to store state, but for the purposes of this library that is hardcoded to the single key flink_state which you can see in the example module.yaml.

The Serde typeclass abstracts serialization away from the library so that users can decide how state should be serialized. Aeson is very convenient so I use it in the example, but protobuf or any other binary format is also acceptable. Flink essentially stores function state as an opaque ByteString regardless.

When running your program don't forget to pass +RTS -N to your binary to run on all cores.

Documentation

class MonadIO m => StatefulFunc s m | m -> s where

Used to represent all Flink stateful function capabilities.

Contexts are received from Flink and deserializeBytesd into s all modifications to state are shipped back to Flink at the end of the batch to be persisted.

Message passing is also queued up and passed back at the end of the current batch.

Minimal complete definition

setInitialCtx, insideCtx, getCtx, setCtx, modifyCtx, sendEgressMsg, sendMsg, sendMsgDelay

Methods

insideCtx :: (s -> a) -> m a

getCtx :: m s

setCtx :: s -> m ()

modifyCtx :: (s -> s) -> m ()

sendEgressMsg

Arguments

:: Message a

=> (Text, Text)

egress address (namespace, type)

-> a

protobuf message to send (should be a Kafka or Kinesis protobuf record)

-> m ()

sendMsg

Arguments

:: Serde a

=> Address

Function address (namespace, type, id)

-> a

message to send

-> m ()

sendMsgDelay

Arguments

:: Serde a

=> Address

Function address (namespace, type, id)

-> NominalDiffTime

delay before message send

-> a

message to send

-> m ()

returns cancelation token with which delivery of the message could be canceled

Instances

StatefulFunc s (Function s)

Defined in Network.Flink.Internal.Stateful

Methods

setInitialCtx :: s -> Function s ()

insideCtx :: (s -> a) -> Function s a

getCtx :: Function s s

setCtx :: s -> Function s ()

modifyCtx :: (s -> s) -> Function s ()

sendEgressMsg :: Message a => (Text, Text) -> a -> Function s ()

sendMsg :: Serde a => Address -> a -> Function s ()

sendMsgDelay :: Serde a => Address -> NominalDiffTime -> a -> Function s ()

flinkWrapper :: forall a s. (Serde a, Serde s) => s -> Expiration -> (a -> Function s ()) -> FuncExec

Takes a function taking an arbitrary state type and converts it to take ByteStrings. This allows each function in the FunctionTable to take its own individual type of state and just expose a function accepting ByteString to the library code.

createApp :: FunctionTable -> Application

Takes function table and creates a wai Application to serve flink requests

flinkServer :: FunctionTable -> Server FlinkApi

Takes function table and creates a servant Server to serve flink requests

flinkApi :: Proxy FlinkApi

data Address

Constructors

Address FuncType Text

Bundled Patterns

pattern Address' :: Text -> Text -> Text -> Address

data FuncType

Constructors

FuncType Text Text

Instances

Eq FuncType

Defined in Network.Flink.Internal.Stateful

Methods

(==) :: FuncType -> FuncType -> Bool

(/=) :: FuncType -> FuncType -> Bool

Ord FuncType

Defined in Network.Flink.Internal.Stateful

Methods

compare :: FuncType -> FuncType -> Ordering

(<) :: FuncType -> FuncType -> Bool

(<=) :: FuncType -> FuncType -> Bool

(>) :: FuncType -> FuncType -> Bool

(>=) :: FuncType -> FuncType -> Bool

max :: FuncType -> FuncType -> FuncType

min :: FuncType -> FuncType -> FuncType

class Serde a where

Methods

tpName :: Proxy a -> Text

Type name

deserializeBytes :: ByteString -> Either String a

decodes types from strict ByteStrings

serializeBytes :: a -> ByteString

encodes types to strict ByteStrings

Instances

Serde ()

Defined in Network.Flink.Internal.Stateful

Methods

tpName :: Proxy () -> Text

deserializeBytes :: ByteString -> Either String ()

serializeBytes :: () -> ByteString

Serde ByteString

Defined in Network.Flink.Internal.Stateful

Methods

tpName :: Proxy ByteString -> Text

deserializeBytes :: ByteString -> Either String ByteString

serializeBytes :: ByteString -> ByteString

Serde ByteString

Defined in Network.Flink.Internal.Stateful

Methods

tpName :: Proxy ByteString -> Text

deserializeBytes :: ByteString0 -> Either String ByteString

serializeBytes :: ByteString -> ByteString0

Json a => Serde (JsonSerde a)

Defined in Network.Flink.Internal.Stateful

Methods

tpName :: Proxy (JsonSerde a) -> Text

deserializeBytes :: ByteString -> Either String (JsonSerde a)

serializeBytes :: JsonSerde a -> ByteString

Message a => Serde (ProtoSerde a)

Defined in Network.Flink.Internal.Stateful

Methods

tpName :: Proxy (ProtoSerde a) -> Text

deserializeBytes :: ByteString -> Either String (ProtoSerde a)

serializeBytes :: ProtoSerde a -> ByteString

type FunctionTable = Map FuncType FuncExec

newtype JsonSerde a

Constructors

JsonSerde

Fields

• getJson :: a

Instances

Functor JsonSerde

Defined in Network.Flink.Internal.Stateful

Methods

fmap :: (a -> b) -> JsonSerde a -> JsonSerde b

(<$) :: a -> JsonSerde b -> JsonSerde a

Json a => Serde (JsonSerde a)

Defined in Network.Flink.Internal.Stateful

Methods

tpName :: Proxy (JsonSerde a) -> Text

deserializeBytes :: ByteString -> Either String (JsonSerde a)

serializeBytes :: JsonSerde a -> ByteString

newtype ProtoSerde a

Constructors

ProtoSerde

Fields

• getProto :: a

Instances

Functor ProtoSerde

Defined in Network.Flink.Internal.Stateful

Methods

fmap :: (a -> b) -> ProtoSerde a -> ProtoSerde b

(<$) :: a -> ProtoSerde b -> ProtoSerde a

Message a => Serde (ProtoSerde a)

Defined in Network.Flink.Internal.Stateful

Methods

tpName :: Proxy (ProtoSerde a) -> Text

deserializeBytes :: ByteString -> Either String (ProtoSerde a)

serializeBytes :: ProtoSerde a -> ByteString

data Expiration

Constructors

Expiration

Fields

• emode :: ExpirationMode
• expireAfterMillis :: NominalDiffTime

Instances

Eq Expiration

Defined in Network.Flink.Internal.Stateful

Methods

(==) :: Expiration -> Expiration -> Bool

(/=) :: Expiration -> Expiration -> Bool

Show Expiration

Defined in Network.Flink.Internal.Stateful

Methods

showsPrec :: Int -> Expiration -> ShowS

show :: Expiration -> String

showList :: [Expiration] -> ShowS

data ExpirationMode

Constructors

NONE

AFTER_WRITE

AFTER_CALL

Instances

Eq ExpirationMode

Defined in Network.Flink.Internal.Stateful

Methods

(==) :: ExpirationMode -> ExpirationMode -> Bool

(/=) :: ExpirationMode -> ExpirationMode -> Bool

Show ExpirationMode

Defined in Network.Flink.Internal.Stateful

Methods

showsPrec :: Int -> ExpirationMode -> ShowS

show :: ExpirationMode -> String

showList :: [ExpirationMode] -> ShowS

jsonState :: Json s => Function s () -> Function (JsonSerde s) ()

Convenience function for wrapping state in newtype for JSON serialization

protoState :: Message s => Function s () -> Function (ProtoSerde s) ()

Convenience function for wrapping state in newtype for Protobuf serialization

sendProtoMsg :: (StatefulFunc s m, Message a) => Address -> a -> m ()

Convinience function to send protobuf messages

sendProtoMsgDelay :: (StatefulFunc s m, Message a) => Address -> NominalDiffTime -> a -> m ()

Convinience function to send delayed protobuf messages