diff options
Diffstat (limited to 'src/Network/KRPC')
-rw-r--r-- | src/Network/KRPC/Manager.hs | 179 | ||||
-rw-r--r-- | src/Network/KRPC/Message.hs | 47 | ||||
-rw-r--r-- | src/Network/KRPC/Method.hs | 61 |
3 files changed, 284 insertions, 3 deletions
diff --git a/src/Network/KRPC/Manager.hs b/src/Network/KRPC/Manager.hs new file mode 100644 index 00000000..9aa1bea7 --- /dev/null +++ b/src/Network/KRPC/Manager.hs | |||
@@ -0,0 +1,179 @@ | |||
1 | {-# LANGUAGE FlexibleContexts #-} | ||
2 | {-# LANGUAGE ScopedTypeVariables #-} | ||
3 | module Network.KRPC.Manager | ||
4 | ( MonadKRPC (..) | ||
5 | , newManager | ||
6 | , query | ||
7 | , handler | ||
8 | ) where | ||
9 | |||
10 | import Control.Applicative | ||
11 | import Control.Arrow | ||
12 | import Control.Concurrent | ||
13 | --import Control.Exception hiding (Handler) | ||
14 | import Control.Exception.Lifted as Lifted hiding (Handler) | ||
15 | import Control.Monad | ||
16 | import Control.Monad.Trans.Control | ||
17 | import Control.Monad.IO.Class | ||
18 | import Data.BEncode as BE | ||
19 | import Data.ByteString.Char8 as BC | ||
20 | import Data.ByteString.Lazy as BL | ||
21 | import Data.IORef | ||
22 | import Data.List as L | ||
23 | import Data.Map as M | ||
24 | import Network.KRPC.Message | ||
25 | import Network.KRPC.Method | ||
26 | import Network.Socket | ||
27 | import Network.Socket.ByteString as BS | ||
28 | |||
29 | |||
30 | type KResult = Either KError KResponse | ||
31 | |||
32 | type TransactionCounter = IORef Int | ||
33 | type CallId = (TransactionId, SockAddr) | ||
34 | type CallRes = MVar KResult | ||
35 | type PendingCalls = IORef (Map CallId CallRes) | ||
36 | |||
37 | type HandlerBody m = SockAddr -> BValue -> m (BE.Result BValue) | ||
38 | type Handler m = (MethodName, HandlerBody m) | ||
39 | |||
40 | data Manager m = Manager | ||
41 | { sock :: !Socket | ||
42 | , transactionCounter :: {-# UNPACK #-} !TransactionCounter | ||
43 | , pendingCalls :: {-# UNPACK #-} !PendingCalls | ||
44 | , handlers :: [Handler m] | ||
45 | } | ||
46 | |||
47 | class (MonadBaseControl IO m, MonadIO m) => MonadKRPC m where | ||
48 | getManager :: m (Manager a) | ||
49 | |||
50 | sockAddrFamily :: SockAddr -> Family | ||
51 | sockAddrFamily (SockAddrInet _ _ ) = AF_INET | ||
52 | sockAddrFamily (SockAddrInet6 _ _ _ _) = AF_INET6 | ||
53 | sockAddrFamily (SockAddrUnix _ ) = AF_UNIX | ||
54 | |||
55 | seedTransaction :: Int | ||
56 | seedTransaction = 0 | ||
57 | |||
58 | newManager :: SockAddr -> IO (Manager a) | ||
59 | newManager servAddr = do | ||
60 | sock <- bindServ | ||
61 | tran <- newIORef seedTransaction | ||
62 | calls <- newIORef M.empty | ||
63 | return $ Manager sock tran calls [] | ||
64 | where | ||
65 | bindServ = do | ||
66 | let family = sockAddrFamily servAddr | ||
67 | sock <- socket family Datagram defaultProtocol | ||
68 | when (family == AF_INET6) $ do | ||
69 | setSocketOption sock IPv6Only 0 | ||
70 | bindSocket sock servAddr | ||
71 | return sock | ||
72 | |||
73 | sendMessage :: MonadIO m => BEncode a => Socket -> SockAddr -> a -> m () | ||
74 | sendMessage sock addr a = | ||
75 | liftIO $ sendManyTo sock (BL.toChunks (BE.encode a)) addr | ||
76 | |||
77 | {----------------------------------------------------------------------- | ||
78 | -- Client | ||
79 | -----------------------------------------------------------------------} | ||
80 | |||
81 | genTransactionId :: TransactionCounter -> IO TransactionId | ||
82 | genTransactionId ref = do | ||
83 | cur <- atomicModifyIORef' ref $ \ cur -> (succ cur, cur) | ||
84 | return $ BC.pack (show cur) | ||
85 | |||
86 | registerQuery :: CallId -> PendingCalls -> IO CallRes | ||
87 | registerQuery cid ref = do | ||
88 | ares <- newEmptyMVar | ||
89 | atomicModifyIORef' ref $ \ m -> (M.insert cid ares m, ()) | ||
90 | return ares | ||
91 | |||
92 | unregisterQuery :: CallId -> PendingCalls -> IO () | ||
93 | unregisterQuery cid ref = do | ||
94 | atomicModifyIORef' ref $ \ m -> (M.delete cid m, ()) | ||
95 | |||
96 | queryResponse :: BEncode a => CallRes -> IO a | ||
97 | queryResponse ares = do | ||
98 | res <- readMVar ares | ||
99 | case res of | ||
100 | Left e -> throwIO e | ||
101 | Right (KResponse {..}) -> | ||
102 | case fromBEncode respVals of | ||
103 | Left e -> throwIO (KError ProtocolError (BC.pack e) respId) | ||
104 | Right a -> return a | ||
105 | |||
106 | query :: forall m a b. (MonadKRPC m, KRPC a b) => SockAddr -> a -> m b | ||
107 | query addr params = do | ||
108 | Manager {..} <- getManager | ||
109 | liftIO $ do | ||
110 | tid <- genTransactionId transactionCounter | ||
111 | let Method name = method :: Method a b | ||
112 | let q = KQuery (toBEncode params) name tid | ||
113 | ares <- registerQuery (tid, addr) pendingCalls | ||
114 | sendMessage sock addr q | ||
115 | `onException` unregisterQuery (tid, addr) pendingCalls | ||
116 | queryResponse ares | ||
117 | |||
118 | {----------------------------------------------------------------------- | ||
119 | -- Handlers | ||
120 | -----------------------------------------------------------------------} | ||
121 | |||
122 | handler :: forall m a b. (KRPC a b, MonadKRPC m) | ||
123 | => (SockAddr -> a -> m b) -> Handler m | ||
124 | handler body = (name, wrapper) | ||
125 | where | ||
126 | Method name = method :: Method a b | ||
127 | wrapper addr args = | ||
128 | case fromBEncode args of | ||
129 | Left e -> return $ Left e | ||
130 | Right a -> (Right . toBEncode) <$> body addr a | ||
131 | |||
132 | runHandler :: MonadKRPC m => HandlerBody m -> SockAddr -> KQuery -> m KResult | ||
133 | runHandler handler addr KQuery {..} = wrapper `Lifted.catch` failback | ||
134 | where | ||
135 | wrapper = ((`decodeError` queryId) +++ (`KResponse` queryId)) | ||
136 | <$> handler addr queryArgs | ||
137 | failback e = return $ Left $ serverError e queryId | ||
138 | |||
139 | dispatchHandler :: MonadKRPC m => KQuery -> SockAddr -> m KResult | ||
140 | dispatchHandler q @ KQuery {..} addr = do | ||
141 | Manager {..} <- getManager | ||
142 | case L.lookup queryMethod handlers of | ||
143 | Nothing -> return $ Left $ unknownMethod queryMethod queryId | ||
144 | Just handler -> runHandler handler addr q | ||
145 | |||
146 | {----------------------------------------------------------------------- | ||
147 | -- Listener | ||
148 | -----------------------------------------------------------------------} | ||
149 | |||
150 | handleQuery :: MonadKRPC m => KQuery -> SockAddr -> m () | ||
151 | handleQuery q addr = do | ||
152 | Manager {..} <- getManager | ||
153 | res <- dispatchHandler q addr | ||
154 | sendMessage sock addr $ either toBEncode toBEncode res | ||
155 | |||
156 | handleResponse :: MonadKRPC m => KResult -> SockAddr -> m () | ||
157 | handleResponse result addr = do | ||
158 | Manager {..} <- getManager | ||
159 | mcall <- undefined (addr, respId) pendingCalls | ||
160 | case mcall of | ||
161 | Nothing -> return () | ||
162 | Just ares -> liftIO $ putMVar ares result | ||
163 | |||
164 | handleMessage :: MonadKRPC m => KMessage -> SockAddr -> m () | ||
165 | handleMessage (Q q) = handleQuery q | ||
166 | handleMessage (R r) = handleResponse (Right r) | ||
167 | handleMessage (E e) = handleResponse (Left e) | ||
168 | |||
169 | maxMsgSize :: Int | ||
170 | maxMsgSize = 64 * 1024 | ||
171 | |||
172 | listener :: MonadKRPC m => m () | ||
173 | listener = do | ||
174 | Manager {..} <- getManager | ||
175 | forever $ do | ||
176 | (bs, addr) <- liftIO $ BS.recvFrom sock maxMsgSize | ||
177 | case BE.decode bs of | ||
178 | Left e -> liftIO $ sendMessage sock addr $ unknownMessage e | ||
179 | Right m -> handleMessage m addr | ||
diff --git a/src/Network/KRPC/Message.hs b/src/Network/KRPC/Message.hs index a70c2ea9..3bbfb1db 100644 --- a/src/Network/KRPC/Message.hs +++ b/src/Network/KRPC/Message.hs | |||
@@ -19,10 +19,17 @@ | |||
19 | {-# LANGUAGE DefaultSignatures #-} | 19 | {-# LANGUAGE DefaultSignatures #-} |
20 | {-# LANGUAGE DeriveDataTypeable #-} | 20 | {-# LANGUAGE DeriveDataTypeable #-} |
21 | module Network.KRPC.Message | 21 | module Network.KRPC.Message |
22 | ( -- * Error | 22 | ( -- * Transaction |
23 | ErrorCode (..) | 23 | TransactionId |
24 | , unknownTransaction | ||
25 | |||
26 | -- * Error | ||
27 | , ErrorCode (..) | ||
24 | , KError(..) | 28 | , KError(..) |
25 | , serverError | 29 | , serverError |
30 | , decodeError | ||
31 | , unknownMethod | ||
32 | , unknownMessage | ||
26 | 33 | ||
27 | -- * Query | 34 | -- * Query |
28 | , KQuery(..) | 35 | , KQuery(..) |
@@ -30,6 +37,9 @@ module Network.KRPC.Message | |||
30 | 37 | ||
31 | -- * Response | 38 | -- * Response |
32 | , KResponse(..) | 39 | , KResponse(..) |
40 | |||
41 | -- * Message | ||
42 | , KMessage (..) | ||
33 | ) where | 43 | ) where |
34 | 44 | ||
35 | import Control.Applicative | 45 | import Control.Applicative |
@@ -47,6 +57,9 @@ import Data.Typeable | |||
47 | -- are enough as they cover 2^16 outstanding queries. | 57 | -- are enough as they cover 2^16 outstanding queries. |
48 | type TransactionId = ByteString | 58 | type TransactionId = ByteString |
49 | 59 | ||
60 | unknownTransaction :: TransactionId | ||
61 | unknownTransaction = "" | ||
62 | |||
50 | {----------------------------------------------------------------------- | 63 | {----------------------------------------------------------------------- |
51 | -- Error messages | 64 | -- Error messages |
52 | -----------------------------------------------------------------------} | 65 | -----------------------------------------------------------------------} |
@@ -120,6 +133,15 @@ instance Exception KError | |||
120 | serverError :: SomeException -> TransactionId -> KError | 133 | serverError :: SomeException -> TransactionId -> KError |
121 | serverError e = KError ServerError (BC.pack (show e)) | 134 | serverError e = KError ServerError (BC.pack (show e)) |
122 | 135 | ||
136 | decodeError :: String -> TransactionId -> KError | ||
137 | decodeError msg = KError ProtocolError (BC.pack msg) | ||
138 | |||
139 | unknownMethod :: MethodName -> TransactionId -> KError | ||
140 | unknownMethod = KError MethodUnknown | ||
141 | |||
142 | unknownMessage :: String -> KError | ||
143 | unknownMessage msg = KError ProtocolError (BC.pack msg) "" | ||
144 | |||
123 | {----------------------------------------------------------------------- | 145 | {----------------------------------------------------------------------- |
124 | -- Query messages | 146 | -- Query messages |
125 | -----------------------------------------------------------------------} | 147 | -----------------------------------------------------------------------} |
@@ -183,4 +205,23 @@ instance BEncode KResponse where | |||
183 | fromBEncode = fromDict $ do | 205 | fromBEncode = fromDict $ do |
184 | lookAhead $ match "y" (BString "r") | 206 | lookAhead $ match "y" (BString "r") |
185 | KResponse <$>! "r" <*>! "t" | 207 | KResponse <$>! "r" <*>! "t" |
186 | {-# INLINE fromBEncode #-} \ No newline at end of file | 208 | {-# INLINE fromBEncode #-} |
209 | |||
210 | {----------------------------------------------------------------------- | ||
211 | -- Summed messages | ||
212 | -----------------------------------------------------------------------} | ||
213 | |||
214 | data KMessage | ||
215 | = Q KQuery | ||
216 | | R KResponse | ||
217 | | E KError | ||
218 | |||
219 | instance BEncode KMessage where | ||
220 | toBEncode (Q q) = toBEncode q | ||
221 | toBEncode (R r) = toBEncode r | ||
222 | toBEncode (E e) = toBEncode e | ||
223 | |||
224 | fromBEncode b = | ||
225 | Q <$> fromBEncode b | ||
226 | <|> R <$> fromBEncode b | ||
227 | <|> E <$> fromBEncode b | ||
diff --git a/src/Network/KRPC/Method.hs b/src/Network/KRPC/Method.hs new file mode 100644 index 00000000..54aa8ef0 --- /dev/null +++ b/src/Network/KRPC/Method.hs | |||
@@ -0,0 +1,61 @@ | |||
1 | {-# LANGUAGE RankNTypes #-} | ||
2 | {-# LANGUAGE MultiParamTypeClasses #-} | ||
3 | {-# LANGUAGE FunctionalDependencies #-} | ||
4 | {-# LANGUAGE GeneralizedNewtypeDeriving #-} | ||
5 | {-# LANGUAGE ScopedTypeVariables #-} | ||
6 | module Network.KRPC.Method | ||
7 | ( Method (..) | ||
8 | , KRPC (..) | ||
9 | ) where | ||
10 | |||
11 | import Data.BEncode (BEncode) | ||
12 | import Data.Monoid | ||
13 | import Data.String | ||
14 | import Data.Typeable | ||
15 | import Network.KRPC.Message | ||
16 | |||
17 | |||
18 | -- | Method datatype used to describe name, parameters and return | ||
19 | -- values of procedure. Client use a method to /invoke/, server | ||
20 | -- /implements/ the method to make the actual work. | ||
21 | -- | ||
22 | -- We use the following fantom types to ensure type-safiety: | ||
23 | -- | ||
24 | -- * param: Type of method parameters. Ordinary Tuple type used | ||
25 | -- to specify more than one parameter, so for example @Method | ||
26 | -- (Int, Int) result@ will take two arguments. | ||
27 | -- | ||
28 | -- * result: Type of return value of the method. Similarly, | ||
29 | -- tuple used to specify more than one return value, so for | ||
30 | -- exsample @Method (Foo, Bar) (Bar, Foo)@ will take two arguments | ||
31 | -- and return two values. | ||
32 | -- | ||
33 | newtype Method param result = Method MethodName | ||
34 | deriving (Eq, Ord, IsString, BEncode) | ||
35 | |||
36 | instance (Typeable a, Typeable b) => Show (Method a b) where | ||
37 | showsPrec _ = showsMethod | ||
38 | |||
39 | showsMethod :: forall a. forall b. Typeable a => Typeable b | ||
40 | => Method a b -> ShowS | ||
41 | showsMethod (Method name) = | ||
42 | shows name <> | ||
43 | showString " :: " <> | ||
44 | shows paramsTy <> | ||
45 | showString " -> " <> | ||
46 | shows valuesTy | ||
47 | where | ||
48 | impossible = error "KRPC.showsMethod: impossible" | ||
49 | paramsTy = typeOf (impossible :: a) | ||
50 | valuesTy = typeOf (impossible :: b) | ||
51 | |||
52 | -- | Example: | ||
53 | -- @ | ||
54 | -- data Ping = Ping Text deriving BEncode | ||
55 | -- data Pong = Pong Text deriving BEncode | ||
56 | -- | ||
57 | -- instance KRPC Ping Pong where | ||
58 | -- method = "ping" | ||
59 | -- @ | ||
60 | class (BEncode req, BEncode resp) => KRPC req resp | req -> resp where | ||
61 | method :: Method req resp | ||