haxr-3000.10.4: XML-RPC client and server library.

Copyright(c) Bjorn Bringert 2003
LicenseBSD-style
Maintainerbjorn@bringert.net
Stabilityexperimental
Portabilitynon-portable (requires extensions and non-portable libraries)
Safe HaskellNone
LanguageHaskell2010

Network.XmlRpc.Internals

Contents

Description

This module contains the core functionality of the XML-RPC library. Most applications should not need to use this module. Client applications should use Network.XmlRpc.Client and server applications should use Network.XmlRpc.Server.

The XML-RPC specifcation is available at http://www.xmlrpc.com/spec.

Synopsis

Method calls and repsonses

data MethodCall Source

An XML-RPC method call. Consists of a method name and a list of parameters.

Constructors

MethodCall String [Value] 

data MethodResponse Source

An XML-RPC response.

Constructors

Return Value

A method response returning a value

Fault Int String

A fault response

XML-RPC types

data Value Source

An XML-RPC value.

Constructors

ValueInt Int

int, i4, or i8

ValueBool Bool

bool

ValueString String

string

ValueUnwrapped String

no inner element

ValueDouble Double

double

ValueDateTime LocalTime

dateTime.iso8601

ValueBase64 ByteString

base 64. NOTE that you should provide the raw data; the haxr library takes care of doing the base-64 encoding.

ValueStruct [(String, Value)]

struct

ValueArray [Value]

array

Instances

Eq Value 
Show Value 
XmlRpcType Value

Exists to allow explicit type conversions.

data Type Source

An XML-RPC value. Use for error messages and introspection.

Instances

class XmlRpcType a where Source

A class for mapping Haskell types to XML-RPC types.

Methods

toValue :: a -> Value Source

Convert from this type to a Value

fromValue :: Monad m => Value -> Err m a Source

Convert from a Value to this type. May fail if if there is a type error.

getType :: a -> Type Source

Converting from XML

parseResponse :: (Show e, MonadError e m) => String -> Err m MethodResponse Source

Parses a method response from XML.

parseCall :: (Show e, MonadError e m) => String -> Err m MethodCall Source

Parses a method call from XML.

getField Source

Arguments

:: (Monad m, XmlRpcType a) 
=> String

Field name

-> [(String, Value)]

Struct

-> Err m a 

Get a field value from a (possibly heterogeneous) struct.

getFieldMaybe Source

Arguments

:: (Monad m, XmlRpcType a) 
=> String

Field name

-> [(String, Value)]

Struct

-> Err m (Maybe a) 

Get a field value from a (possibly heterogeneous) struct.

Converting to XML

renderCall :: MethodCall -> ByteString Source

Makes an XML-representation of a method call. FIXME: pretty prints ugly XML

renderResponse :: MethodResponse -> ByteString Source

Makes an XML-representation of a method response. FIXME: pretty prints ugly XML

Converting to and from DTD types

Error monad

type Err m a = ExceptT String m a Source

maybeToM Source

Arguments

:: Monad m 
=> String

Error message to fail with for Nothing

-> Maybe a

The Maybe value.

-> m a

The resulting value in the monad.

Convert a Maybe value to a value in any monad

handleError :: Monad m => (String -> m a) -> Err m a -> m a Source

Handle errors from the error monad.

ioErrorToErr :: IO a -> Err IO a Source

Catch IO errors in the error monad.