Transient.Move.Internals

Documentation

data Node

Constructors

Node

Fields

• nodeHost :: HostName
• nodePort :: Int
• connection :: MVar Pool
• nodeServices :: [Service]

Instances

Eq Node

Methods

(==) :: Node -> Node -> Bool

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

Ord Node

Methods

compare :: Node -> Node -> Ordering

(<) :: Node -> Node -> Bool

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

(>) :: Node -> Node -> Bool

(>=) :: Node -> Node -> Bool

max :: Node -> Node -> Node

min :: Node -> Node -> Node

Read Node

Methods

readsPrec :: Int -> ReadS Node

readList :: ReadS [Node]

readPrec :: ReadPrec Node

readListPrec :: ReadPrec [Node]

Show Node

Methods

showsPrec :: Int -> Node -> ShowS

show :: Node -> String

showList :: [Node] -> ShowS

newtype Cloud a

Constructors

Cloud

Fields

• runCloud' :: TransIO a

Instances

Monad Cloud

Methods

(>>=) :: Cloud a -> (a -> Cloud b) -> Cloud b

(>>) :: Cloud a -> Cloud b -> Cloud b

return :: a -> Cloud a

fail :: String -> Cloud a

Functor Cloud

Methods

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

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

Applicative Cloud

Methods

pure :: a -> Cloud a

(<*>) :: Cloud (a -> b) -> Cloud a -> Cloud b

(*>) :: Cloud a -> Cloud b -> Cloud b

(<*) :: Cloud a -> Cloud b -> Cloud a

Alternative Cloud

Methods

empty :: Cloud a

(<|>) :: Cloud a -> Cloud a -> Cloud a

some :: Cloud a -> Cloud [a]

many :: Cloud a -> Cloud [a]

MonadState EventF Cloud

Methods

get :: Cloud EventF

put :: EventF -> Cloud ()

state :: (EventF -> (a, EventF)) -> Cloud a

(Eq a, Num a) => Num (Cloud a)

Methods

(+) :: Cloud a -> Cloud a -> Cloud a

(-) :: Cloud a -> Cloud a -> Cloud a

(*) :: Cloud a -> Cloud a -> Cloud a

negate :: Cloud a -> Cloud a

abs :: Cloud a -> Cloud a

signum :: Cloud a -> Cloud a

fromInteger :: Integer -> Cloud a

Monoid a => Monoid (Cloud a)

Methods

mempty :: Cloud a

mappend :: Cloud a -> Cloud a -> Cloud a

mconcat :: [Cloud a] -> Cloud a

runCloud :: Cloud b -> TransIO b

Execute a distributed computation in the TransIO monad. Note that all the computations inside the TransIO monad that enclose the cloud computation must be logged.

tlsHooks :: IORef (SData -> ByteString -> IO (), SData -> IO ByteString, Socket -> ByteString -> TransIO (), String -> Socket -> ByteString -> TransIO ())

sendTLSData :: SData -> ByteString -> IO ()

local :: Loggable a => TransIO a -> Cloud a

Means that this computation will be executed in the current node. the result will be logged so the closure will be recovered if the computation is translated to other node by means of primitives like beamTo, forkTo, runAt, teleport, clustered, mclustered etc

runCloudIO :: Typeable a => Cloud a -> IO (Maybe a)

Run a distributed computation inside the IO monad. Enables asynchronous console input (see keep).

runCloudIO' :: Typeable a => Cloud a -> IO (Maybe a)

Run a distributed computation inside the IO monad with no console input.

onAll :: TransIO a -> Cloud a

alternative to local It means that if the computation is translated to other node this will be executed again if this has not been executed inside a local computation.

onAll foo
local foo'
local $ do
      bar
      runCloud $ do
              onAll baz
              runAt node ....
callTo node' .....

Here foo will be executed in node' but foo' bar and baz don't.

However foo bar and baz will e executed in node.

lazy :: TransIO a -> Cloud a

loggedc :: Loggable a => Cloud a -> Cloud a

loggedc' :: Loggable a => Cloud a -> Cloud a

lliftIO :: Loggable a => IO a -> Cloud a

the Cloud monad has no MonadIO instance. `lliftIO= local . liftIO`

localIO :: Loggable a => IO a -> Cloud a

locally perform IO. `localIO = lliftIO`

fullStop :: Cloud stop

stop the current computation and does not execute any alternative computation

beamTo :: Node -> Cloud ()

continue the execution in a new node all the previous actions from listen to this statement must have been logged

forkTo :: Node -> Cloud ()

execute in the remote node a process with the same execution state

callTo :: Loggable a => Node -> Cloud a -> Cloud a

open a wormhole to another node and executes an action on it. currently by default it keep open the connection to receive additional requests and responses (streaming)

callTo' :: (Show a, Read a, Typeable a) => Node -> Cloud a -> Cloud a

A connectionless version of callTo for long running remote calls

atRemote :: Loggable a => Cloud a -> Cloud a

Within an open connection to other node opened by wormhole, it run the computation in the remote node and return the result back to the original node.

runAt :: Loggable a => Node -> Cloud a -> Cloud a

synonymous of callTo

single :: TransIO a -> TransIO a

run a single thread with that action for each connection created. When the same action is re-executed within that connection, all the threads generated by the previous execution are killed

  box <-  foo
  r <- runAt node . local . single $ getMailbox box
  localIO $ print r

if foo return differnt mainbox indentifiers, the above code would print the messages of the last one. Without single, it would print the messages of all of them.

unique :: a -> TransIO ()

run an unique continuation for each connection. The first thread that execute unique is executed for that connection. The rest are ignored.

wormhole :: Loggable a => Node -> Cloud a -> Cloud a

A wormhole opens a connection with another node anywhere in a computation. teleport uses this connection to translate the computation back and forth between the two nodes connected

type JSString = String

pack :: a -> a

teleport :: Cloud ()

translates computations back and forth between two nodes reusing a connection opened by wormhole

each teleport transport to the other node what is new in the log since the last teleport

It is used trough other primitives like runAt which involves two teleports:

runAt node= wormhole node $ loggedc $ do > teleport > r <- Cloud $ runCloud proc <** setData WasRemote > teleport > return r

copyData :: (Typeable * b, Read b, Show b) => b -> Cloud b

copy a session data variable from the local to the remote node. If there is none set in the local node, The parameter is the default value. In this case, the default value is also set in the local node.

putMailbox :: Typeable a => a -> TransIO ()

write to the mailbox Mailboxes are node-wide, for all processes that share the same connection data, that is, are under the same listen or connect while EVars are only visible by the process that initialized it and his children. Internally, the mailbox is in a well known EVar stored by listen in the Connection state.

putMailbox' :: (Typeable b, Ord b, Typeable a) => b -> a -> TransIO ()

write to a mailbox identified by an Integer besides the type

newMailbox :: MailboxId -> TransIO ()

errorMailBox :: a

getMailbox :: Typeable a => TransIO a

get messages from the mailbox that matches with the type expected. The order of reading is defined by readTChan This is reactive. it means that each new message trigger the execution of the continuation each message wake up all the getMailbox computations waiting for it.

getMailbox' :: (Typeable b, Ord b, Typeable a) => b -> TransIO a

read from a mailbox identified by a number besides the type

cleanMailbox :: Typeable a => a -> TransIO ()

delete all subscriptions for that mailbox expecting this kind of data

cleanMailbox' :: Typeable a => Int -> a -> TransIO ()

clean a mailbox identified by an Int and the type

clustered :: Loggable a => Cloud a -> Cloud a

execute a Transient action in each of the nodes connected.

The response of each node is received by the invoking node and processed by the rest of the procedure. By default, each response is processed in a new thread. To restrict the number of threads use the thread control primitives.

this snippet receive a message from each of the simulated nodes:

main = keep $ do
   let nodes= map createLocalNode [2000..2005]
   addNodes nodes
   (foldl (<|>) empty $ map listen nodes) <|> return ()

   r <- clustered $ do
              Connection (Just(PortNumber port, _, _, _)) _ <- getSData
              return $ "hi from " ++ show port++ "\n"
   liftIO $ putStrLn r
   where
   createLocalNode n= createNode "localhost" (PortNumber n)

mclustered :: (Monoid a, Loggable a) => Cloud a -> Cloud a

callNodes :: (Typeable * a, Typeable * a1, Read a, Read a1, Show a, Show a1) => (Cloud a1 -> Cloud a -> Cloud a) -> Cloud a -> Cloud a1 -> Cloud a

callNodes' :: (Typeable * a, Read a, Show a) => [Node] -> (Cloud a -> b -> b) -> b -> Cloud a -> b

sendRaw :: MonadIO m => Connection -> ByteString -> m ()

data NodeMSG

Constructors

ClosureData IdClosure IdClosure CurrentPointer

Instances

Read NodeMSG

Methods

readsPrec :: Int -> ReadS NodeMSG

readList :: ReadS [NodeMSG]

readPrec :: ReadPrec NodeMSG

readListPrec :: ReadPrec [NodeMSG]

Show NodeMSG

Methods

showsPrec :: Int -> NodeMSG -> ShowS

show :: NodeMSG -> String

showList :: [NodeMSG] -> ShowS

msend :: MonadIO m => Connection -> StreamData NodeMSG -> m ()

mread :: Loggable a => Connection -> TransIO (StreamData a)

getWebServerNode :: TransIO Node

read' :: (Typeable * t, Read t) => String -> t

mclose :: Connection -> IO ()

mconnect :: Node -> TransIO Connection

connectTo' :: Int -> HostName -> PortID -> IO Socket

type Blocked = MVar ()

type BuffSize = Int

data ConnectionData

Constructors

Node2Node

Fields

• port :: PortID
• socket :: Socket
• sockAddr :: SockAddr

TLSNode2Node

Fields

• tlscontext :: SData

Node2Web

Fields

• webSocket :: Connection

Self

Relay (EVar (StreamData NodeMSG))

data MailboxId

Constructors

(Typeable a, Ord a) => MailboxId a TypeRep

Instances

Eq MailboxId

Methods

(==) :: MailboxId -> MailboxId -> Bool

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

Ord MailboxId

Methods

compare :: MailboxId -> MailboxId -> Ordering

(<) :: MailboxId -> MailboxId -> Bool

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

(>) :: MailboxId -> MailboxId -> Bool

(>=) :: MailboxId -> MailboxId -> Bool

max :: MailboxId -> MailboxId -> MailboxId

min :: MailboxId -> MailboxId -> MailboxId

data Connection

Constructors

Connection

Fields

• myNode :: IORef Node
• remoteNode :: IORef (Maybe Node)
• connData :: Maybe ConnectionData
• bufferSize :: BuffSize
• comEvent :: IORef (Map MailboxId (EVar SData))
• blocked :: Blocked
• calling :: Bool
• closures :: MVar (Map IdClosure ([LogElem], EventF))
• closChildren :: IORef (Map Int EventF)

defConnection :: MonadIO m => m Connection

setBuffSize :: Int -> TransIO ()

getBuffSize :: TransIO BuffSize

listen :: Node -> Cloud ()

Setup the node to start listening for incoming connections.

listenNew :: PortNumber -> Connection -> TransIO (StreamData NodeMSG)

rsetHost :: IORef Bool

listenResponses :: Loggable a => TransIO (StreamData a)

relayService :: Cloud ()

a bridge that forward messages to a third node trough a relay node. Used by the Relay connections

type IdClosure = Int

newtype Closure

Constructors

Closure IdClosure

Instances

Show Closure

Methods

showsPrec :: Int -> Closure -> ShowS

show :: Closure -> String

showList :: [Closure] -> ShowS

execLog :: StreamData NodeMSG -> TransIO ()

type Pool = [Connection]

type Package = String

type Program = String

type Service = (Package, Program)

data ParseContext a

Constructors

IsString a => ParseContext (IO a) a

parallelReadHandler :: Loggable a => TransIO (StreamData a)

readFrom :: Connection -> IO ByteString

toStrict :: ByteString -> ByteString

makeWSStreamFromConn :: Connection -> IO Stream

makeWebsocketConnection :: MonadIO m => Connection -> ByteString -> Headers -> m Connection

servePages :: (t, ByteString, [(CI ByteString, b)]) -> TransIO ()

api :: TransIO ByteString -> Cloud ()

isWebSocketsReq :: [(CI ByteString, b)] -> Bool

data HTTPMethod

Constructors

GET

POST

Instances

Read HTTPMethod

Methods

readsPrec :: Int -> ReadS HTTPMethod

readList :: ReadS [HTTPMethod]

readPrec :: ReadPrec HTTPMethod

readListPrec :: ReadPrec [HTTPMethod]

Show HTTPMethod

Methods

showsPrec :: Int -> HTTPMethod -> ShowS

show :: HTTPMethod -> String

showList :: [HTTPMethod] -> ShowS

receiveHTTPHead :: TransIO (ByteString, ByteString, [(CI ByteString, ByteString)])

dropSpaces :: TransIO ()

dropChar :: TransIO ()

endline :: Char -> Bool

type PostParams = [(ByteString, String)]

parsePostUrlEncoded :: TransIO PostParams

getString :: TransIO ByteString

tTakeWhile :: (Char -> Bool) -> TransIO ByteString

tTakeWhile' :: (Char -> Bool) -> TransIO ByteString

parse :: (ByteString -> (b, ByteString)) -> TransIO b

withData :: (ByteString -> TransIO (a, ByteString)) -> TransIO a

bring the data of a parse context as a lazy byteString to a parser and actualize the parse context with the result

giveData :: TransIO ByteString

bring the data of the parse context as a lazy byteString

isBrowserInstance :: Bool

Returns True if we are running in the browser.

emptyPool :: MonadIO m => m (MVar Pool)

createNodeServ :: HostName -> Integer -> [Service] -> IO Node

Create a node from a hostname (or IP address), port number and a list of services.

createNode :: HostName -> Integer -> IO Node

Create a node from a hostname (or IP address) and port number. The node is created without any services.

createWebNode :: IO Node

nodeList :: TVar [Node]

errorMyNode :: [Char] -> a

getMyNode :: TransIO Node

Return the local node i.e. the node where this computation is running.

getNodes :: MonadIO m => m [Node]

Return the list of nodes in the cluster.

getServerNodes :: TransIO [Node]

addNodes :: [Node] -> TransIO ()

Add a list of nodes to the list of existing cluster nodes.

setNodes :: MonadIO m => [Node] -> m ()

set the list of nodes

shuffleNodes :: MonadIO m => m [Node]

Shuffle the list of cluster nodes and return the shuffled list.

connect :: Node -> Node -> Cloud ()

Add a node (first parameter) to the cluster using a node that is already part of the cluster (second parameter). The added node starts listening for incoming connections and the rest of the computation is executed on this newly added node.

connect' :: Node -> Cloud ()

Reconcile the list of nodes in the cluster using a remote node already part of the cluster. Reconciliation results in each node in the cluster having exactly the same list of nodes.

Orphan instances

Ord PortID

Methods

compare :: PortID -> PortID -> Ordering

(<) :: PortID -> PortID -> Bool

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

(>) :: PortID -> PortID -> Bool

(>=) :: PortID -> PortID -> Bool

max :: PortID -> PortID -> PortID

min :: PortID -> PortID -> PortID