erebos-0.1.9: Decentralized messaging and synchronization
Safe HaskellNone
LanguageHaskell2010

Erebos.Service

Documentation

class (Typeable s, Storable s, Typeable (ServiceAttributes s), Typeable (ServiceState s), Typeable (ServiceGlobalState s)) => Service s where Source #

Minimal complete definition

serviceID, serviceHandler

Associated Types

type ServiceAttributes s = (attr :: Type) | attr -> s Source #

type ServiceAttributes s = Proxy s

type ServiceState s Source #

type ServiceState s = ()

type ServiceGlobalState s Source #

type ServiceGlobalState s = ()

Methods

serviceID :: proxy s -> ServiceID Source #

serviceHandler :: Stored s -> ServiceHandler s () Source #

serviceNewPeer :: ServiceHandler s () Source #

defaultServiceAttributes :: proxy s -> ServiceAttributes s Source #

default defaultServiceAttributes :: ServiceAttributes s ~ Proxy s => proxy s -> ServiceAttributes s Source #

emptyServiceState :: proxy s -> ServiceState s Source #

default emptyServiceState :: ServiceState s ~ () => proxy s -> ServiceState s Source #

emptyServiceGlobalState :: proxy s -> ServiceGlobalState s Source #

default emptyServiceGlobalState :: ServiceGlobalState s ~ () => proxy s -> ServiceGlobalState s Source #

serviceStorageWatchers :: proxy s -> [SomeStorageWatcher s] Source #

serviceStopServer :: proxy s -> Server -> ServiceGlobalState s -> [(Peer, ServiceState s)] -> IO () Source #

Instances

Instances details
Service ChatroomService Source # 
Instance details

Defined in Erebos.Chatroom

Associated Types

type ServiceAttributes ChatroomService 
Instance details

Defined in Erebos.Chatroom

type ServiceAttributes ChatroomService = Proxy ChatroomService
type ServiceState ChatroomService 
Instance details

Defined in Erebos.Chatroom

type ServiceState ChatroomService
type ServiceGlobalState ChatroomService 
Instance details

Defined in Erebos.Chatroom

type ServiceGlobalState ChatroomService = ()

Methods

serviceID :: proxy ChatroomService -> ServiceID Source #

serviceHandler :: Stored ChatroomService -> ServiceHandler ChatroomService () Source #

serviceNewPeer :: ServiceHandler ChatroomService () Source #

defaultServiceAttributes :: proxy ChatroomService -> ServiceAttributes ChatroomService Source #

emptyServiceState :: proxy ChatroomService -> ServiceState ChatroomService Source #

emptyServiceGlobalState :: proxy ChatroomService -> ServiceGlobalState ChatroomService Source #

serviceStorageWatchers :: proxy ChatroomService -> [SomeStorageWatcher ChatroomService] Source #

serviceStopServer :: proxy ChatroomService -> Server -> ServiceGlobalState ChatroomService -> [(Peer, ServiceState ChatroomService)] -> IO () Source #

Service DiscoveryService Source # 
Instance details

Defined in Erebos.Discovery

Associated Types

type ServiceAttributes DiscoveryService 
Instance details

Defined in Erebos.Discovery

type ServiceAttributes DiscoveryService = DiscoveryAttributes
type ServiceState DiscoveryService 
Instance details

Defined in Erebos.Discovery

type ServiceState DiscoveryService
type ServiceGlobalState DiscoveryService 
Instance details

Defined in Erebos.Discovery

type ServiceGlobalState DiscoveryService

Methods

serviceID :: proxy DiscoveryService -> ServiceID Source #

serviceHandler :: Stored DiscoveryService -> ServiceHandler DiscoveryService () Source #

serviceNewPeer :: ServiceHandler DiscoveryService () Source #

defaultServiceAttributes :: proxy DiscoveryService -> ServiceAttributes DiscoveryService Source #

emptyServiceState :: proxy DiscoveryService -> ServiceState DiscoveryService Source #

emptyServiceGlobalState :: proxy DiscoveryService -> ServiceGlobalState DiscoveryService Source #

serviceStorageWatchers :: proxy DiscoveryService -> [SomeStorageWatcher DiscoveryService] Source #

serviceStopServer :: proxy DiscoveryService -> Server -> ServiceGlobalState DiscoveryService -> [(Peer, ServiceState DiscoveryService)] -> IO () Source #

Service DirectMessage Source # 
Instance details

Defined in Erebos.Message

Associated Types

type ServiceAttributes DirectMessage 
Instance details

Defined in Erebos.Message

type ServiceAttributes DirectMessage = DirectMessageAttributes
type ServiceState DirectMessage 
Instance details

Defined in Erebos.Message

type ServiceState DirectMessage = ()
type ServiceGlobalState DirectMessage 
Instance details

Defined in Erebos.Message

type ServiceGlobalState DirectMessage = ()

Methods

serviceID :: proxy DirectMessage -> ServiceID Source #

serviceHandler :: Stored DirectMessage -> ServiceHandler DirectMessage () Source #

serviceNewPeer :: ServiceHandler DirectMessage () Source #

defaultServiceAttributes :: proxy DirectMessage -> ServiceAttributes DirectMessage Source #

emptyServiceState :: proxy DirectMessage -> ServiceState DirectMessage Source #

emptyServiceGlobalState :: proxy DirectMessage -> ServiceGlobalState DirectMessage Source #

serviceStorageWatchers :: proxy DirectMessage -> [SomeStorageWatcher DirectMessage] Source #

serviceStopServer :: proxy DirectMessage -> Server -> ServiceGlobalState DirectMessage -> [(Peer, ServiceState DirectMessage)] -> IO () Source #

Service SyncService Source # 
Instance details

Defined in Erebos.Sync

Associated Types

type ServiceAttributes SyncService 
Instance details

Defined in Erebos.Sync

type ServiceAttributes SyncService = Proxy SyncService
type ServiceState SyncService 
Instance details

Defined in Erebos.Sync

type ServiceState SyncService = ()
type ServiceGlobalState SyncService 
Instance details

Defined in Erebos.Sync

type ServiceGlobalState SyncService = ()

Methods

serviceID :: proxy SyncService -> ServiceID Source #

serviceHandler :: Stored SyncService -> ServiceHandler SyncService () Source #

serviceNewPeer :: ServiceHandler SyncService () Source #

defaultServiceAttributes :: proxy SyncService -> ServiceAttributes SyncService Source #

emptyServiceState :: proxy SyncService -> ServiceState SyncService Source #

emptyServiceGlobalState :: proxy SyncService -> ServiceGlobalState SyncService Source #

serviceStorageWatchers :: proxy SyncService -> [SomeStorageWatcher SyncService] Source #

serviceStopServer :: proxy SyncService -> Server -> ServiceGlobalState SyncService -> [(Peer, ServiceState SyncService)] -> IO () Source #

PairingResult a => Service (PairingService a) Source # 
Instance details

Defined in Erebos.Pairing

Associated Types

type ServiceAttributes (PairingService a) 
Instance details

Defined in Erebos.Pairing

type ServiceAttributes (PairingService a) = PairingAttributes a
type ServiceState (PairingService a) 
Instance details

Defined in Erebos.Pairing

type ServiceState (PairingService a) = PairingState a
type ServiceGlobalState (PairingService a) 
Instance details

Defined in Erebos.Pairing

type ServiceGlobalState (PairingService a) = ()

Methods

serviceID :: proxy (PairingService a) -> ServiceID Source #

serviceHandler :: Stored (PairingService a) -> ServiceHandler (PairingService a) () Source #

serviceNewPeer :: ServiceHandler (PairingService a) () Source #

defaultServiceAttributes :: proxy (PairingService a) -> ServiceAttributes (PairingService a) Source #

emptyServiceState :: proxy (PairingService a) -> ServiceState (PairingService a) Source #

emptyServiceGlobalState :: proxy (PairingService a) -> ServiceGlobalState (PairingService a) Source #

serviceStorageWatchers :: proxy (PairingService a) -> [SomeStorageWatcher (PairingService a)] Source #

serviceStopServer :: proxy (PairingService a) -> Server -> ServiceGlobalState (PairingService a) -> [(Peer, ServiceState (PairingService a))] -> IO () Source #

data SomeService Source #

Constructors

Service s => SomeService (Proxy s) (ServiceAttributes s) 

someService :: Service s => proxy s -> SomeService Source #

someServiceAttr :: Service s => ServiceAttributes s -> SomeService Source #

someServiceID :: SomeService -> ServiceID Source #

data SomeServiceState Source #

Constructors

Service s => SomeServiceState (Proxy s) (ServiceState s) 

fromServiceState :: Service s => proxy s -> SomeServiceState -> Maybe (ServiceState s) Source #

someServiceEmptyState :: SomeService -> SomeServiceState Source #

data SomeServiceGlobalState Source #

Constructors

Service s => SomeServiceGlobalState (Proxy s) (ServiceGlobalState s) 

fromServiceGlobalState :: Service s => proxy s -> SomeServiceGlobalState -> Maybe (ServiceGlobalState s) Source #

someServiceEmptyGlobalState :: SomeService -> SomeServiceGlobalState Source #

data SomeStorageWatcher s Source #

Constructors

Eq a => SomeStorageWatcher (Stored LocalState -> a) (a -> ServiceHandler s ()) 
Eq a => GlobalStorageWatcher (Stored LocalState -> a) (Server -> a -> ExceptT String IO ()) 

data ServiceID Source #

Instances

Instances details
Show ServiceID Source # 
Instance details

Defined in Erebos.Service

Methods

showsPrec :: Int -> ServiceID -> ShowS #

show :: ServiceID -> String #

showList :: [ServiceID] -> ShowS #

StorableUUID ServiceID Source # 
Instance details

Defined in Erebos.Service

Methods

toUUID :: ServiceID -> UUID Source #

fromUUID :: UUID -> ServiceID Source #

Eq ServiceID Source # 
Instance details

Defined in Erebos.Service

Methods

(==) :: ServiceID -> ServiceID -> Bool #

(/=) :: ServiceID -> ServiceID -> Bool #

Ord ServiceID Source # 
Instance details

Defined in Erebos.Service

Methods

compare :: ServiceID -> ServiceID -> Ordering #

(<) :: ServiceID -> ServiceID -> Bool #

(<=) :: ServiceID -> ServiceID -> Bool #

(>) :: ServiceID -> ServiceID -> Bool #

(>=) :: ServiceID -> ServiceID -> Bool #

max :: ServiceID -> ServiceID -> ServiceID #

min :: ServiceID -> ServiceID -> ServiceID #

mkServiceID :: String -> ServiceID Source #

data ServiceHandler s a Source #

Instances

Instances details
MonadHead LocalState (ServiceHandler s) Source # 
Instance details

Defined in Erebos.Service

Methods

updateLocalHead :: (Stored LocalState -> ServiceHandler s (Stored LocalState, b)) -> ServiceHandler s b Source #

getLocalHead :: ServiceHandler s (Stored LocalState) Source #

MonadError String (ServiceHandler s) Source # 
Instance details

Defined in Erebos.Service

Methods

throwError :: String -> ServiceHandler s a #

catchError :: ServiceHandler s a -> (String -> ServiceHandler s a) -> ServiceHandler s a #

MonadIO (ServiceHandler s) Source # 
Instance details

Defined in Erebos.Service

Methods

liftIO :: IO a -> ServiceHandler s a #

Applicative (ServiceHandler s) Source # 
Instance details

Defined in Erebos.Service

Methods

pure :: a -> ServiceHandler s a #

(<*>) :: ServiceHandler s (a -> b) -> ServiceHandler s a -> ServiceHandler s b #

liftA2 :: (a -> b -> c) -> ServiceHandler s a -> ServiceHandler s b -> ServiceHandler s c #

(*>) :: ServiceHandler s a -> ServiceHandler s b -> ServiceHandler s b #

(<*) :: ServiceHandler s a -> ServiceHandler s b -> ServiceHandler s a #

Functor (ServiceHandler s) Source # 
Instance details

Defined in Erebos.Service

Methods

fmap :: (a -> b) -> ServiceHandler s a -> ServiceHandler s b #

(<$) :: a -> ServiceHandler s b -> ServiceHandler s a #

Monad (ServiceHandler s) Source # 
Instance details

Defined in Erebos.Service

Methods

(>>=) :: ServiceHandler s a -> (a -> ServiceHandler s b) -> ServiceHandler s b #

(>>) :: ServiceHandler s a -> ServiceHandler s b -> ServiceHandler s b #

return :: a -> ServiceHandler s a #

MonadStorage (ServiceHandler s) Source # 
Instance details

Defined in Erebos.Service

Methods

getStorage :: ServiceHandler s Storage Source #

mstore :: Storable a => a -> ServiceHandler s (Stored a) Source #

MonadReader (ServiceInput s) (ServiceHandler s) Source # 
Instance details

Defined in Erebos.Service

Methods

ask :: ServiceHandler s (ServiceInput s) #

local :: (ServiceInput s -> ServiceInput s) -> ServiceHandler s a -> ServiceHandler s a #

reader :: (ServiceInput s -> a) -> ServiceHandler s a #

MonadWriter [ServiceReply s] (ServiceHandler s) Source # 
Instance details

Defined in Erebos.Service

Methods

writer :: (a, [ServiceReply s]) -> ServiceHandler s a #

tell :: [ServiceReply s] -> ServiceHandler s () #

listen :: ServiceHandler s a -> ServiceHandler s (a, [ServiceReply s]) #

pass :: ServiceHandler s (a, [ServiceReply s] -> [ServiceReply s]) -> ServiceHandler s a #

data ServiceInput s Source #

Constructors

ServiceInput 

Fields

Instances

Instances details
MonadReader (ServiceInput s) (ServiceHandler s) Source # 
Instance details

Defined in Erebos.Service

Methods

ask :: ServiceHandler s (ServiceInput s) #

local :: (ServiceInput s -> ServiceInput s) -> ServiceHandler s a -> ServiceHandler s a #

reader :: (ServiceInput s -> a) -> ServiceHandler s a #

data ServiceReply s Source #

Constructors

ServiceReply (Either s (Stored s)) Bool 
ServiceFinally (IO ()) 

Instances

Instances details
MonadWriter [ServiceReply s] (ServiceHandler s) Source # 
Instance details

Defined in Erebos.Service

Methods

writer :: (a, [ServiceReply s]) -> ServiceHandler s a #

tell :: [ServiceReply s] -> ServiceHandler s () #

listen :: ServiceHandler s a -> ServiceHandler s (a, [ServiceReply s]) #

pass :: ServiceHandler s (a, [ServiceReply s] -> [ServiceReply s]) -> ServiceHandler s a #

runServiceHandler :: Service s => Head LocalState -> ServiceInput s -> ServiceState s -> ServiceGlobalState s -> ServiceHandler s () -> IO ([ServiceReply s], (ServiceState s, ServiceGlobalState s)) Source #

svcGet :: ServiceHandler s (ServiceState s) Source #

svcSet :: ServiceState s -> ServiceHandler s () Source #

svcModify :: (ServiceState s -> ServiceState s) -> ServiceHandler s () Source #

svcGetGlobal :: ServiceHandler s (ServiceGlobalState s) Source #

svcSetGlobal :: ServiceGlobalState s -> ServiceHandler s () Source #

svcModifyGlobal :: (ServiceGlobalState s -> ServiceGlobalState s) -> ServiceHandler s () Source #

svcGetLocal :: ServiceHandler s (Stored LocalState) Source #

svcSetLocal :: Stored LocalState -> ServiceHandler s () Source #

svcSelf :: ServiceHandler s UnifiedIdentity Source #

svcPrint :: String -> ServiceHandler s () Source #

replyPacket :: Service s => s -> ServiceHandler s () Source #

replyStored :: Service s => Stored s -> ServiceHandler s () Source #

replyStoredRef :: Service s => Stored s -> ServiceHandler s () Source #

afterCommit :: IO () -> ServiceHandler s () Source #