Network.KRPC.Method

Normally, you don't need to import this module.

Documentation

newtype Method param result

Method datatype used to describe method name, parameters and return values of procedure. Client use a method to invoke, server implements the method to make the actual work.

We use the following fantom types to ensure type-safiety:

• param: Type of method parameters.
• result: Type of return value of the method.

Constructors

Method

Fields

methodName :: MethodName

Instances

Eq (Method param result)

Ord (Method param result)

(Typeable a, Typeable b) => Show (Method a b)

Example:

show (Method "concat" :: [Int] Int) == "concat :: [Int] -> Int"

IsString (Method param result)

BEncode (Method param result)

class (Typeable req, BEncode req, Typeable resp, BEncode resp) => KRPC req resp | req -> resp where

In order to perform or handle KRPC query you need to provide corresponding KRPC class.

Example:

   data Ping = Ping Text deriving BEncode
   data Pong = Pong Text deriving BEncode

instance KRPC Ping Pong where
     method = "ping"

Methods

method :: Method req resp

Method name. Default implementation uses lowercased req datatype name.