libmpd-0.4.2: An MPD client library.Source codeContentsIndex
Network.MPD.Core
Stabilityalpha
MaintainerJoachim Fasting <joachim.fasting@gmail.com>
Contents
Classes
Data types
Running
Interacting
Description
The core datatypes and operations are defined here, including the primary instance of the MonadMPD class, MPD.
Synopsis
class (Monad m, MonadError MPDError m) => MonadMPD m where
open :: m ()
close :: m ()
send :: String -> m String
getPassword :: m Password
data MPD a
data MPDError
= NoMPD
| TimedOut
| Unexpected String
| Custom String
| ACK ACKType String
data ACKType
= InvalidArgument
| InvalidPassword
| Auth
| UnknownCommand
| FileNotFound
| PlaylistMax
| System
| PlaylistLoad
| Busy
| NotPlaying
| FileExists
| UnknownACK
type Response = Either MPDError
type Host = String
type Port = Integer
type Password = String
withMPDEx :: Host -> Port -> Password -> MPD a -> IO (Response a)
getResponse :: MonadMPD m => String -> m [String]
kill :: MonadMPD m => m ()
Classes
class (Monad m, MonadError MPDError m) => MonadMPD m whereSource
A typeclass to allow for multiple implementations of a connection to an MPD server.
Methods
open :: m ()Source
Open (or re-open) a connection to the MPD server.
close :: m ()Source
Close the connection.
send :: String -> m StringSource
Send a string to the server and return its response.
getPassword :: m PasswordSource
Produce a password to send to the server should it ask for one.
show/hide Instances
Data types
data MPD a Source

The main implementation of an MPD client. It actually connects to a server and interacts with it.

To use the error throwing/catching capabilities: 

 import Control.Monad.Error (throwError, catchError)

To run IO actions within the MPD monad: 

 import Control.Monad.Trans (liftIO)
show/hide Instances
data MPDError Source
The MPDError type is used to signal errors, both from the MPD and otherwise.
Constructors
NoMPDMPD not responding
TimedOutThe connection timed out
Unexpected StringMPD returned an unexpected response. This is a bug, either in the library or in MPD itself.
Custom StringUsed for misc. errors
ACK ACKType StringACK type and a message from the server
show/hide Instances
data ACKType Source
Represents various MPD errors (aka. ACKs).
Constructors
InvalidArgumentInvalid argument passed (ACK 2)
InvalidPasswordInvalid password supplied (ACK 3)
AuthAuthentication required (ACK 4)
UnknownCommandUnknown command (ACK 5)
FileNotFoundFile or directory not found ACK 50)
PlaylistMaxPlaylist at maximum size (ACK 51)
SystemA system error (ACK 52)
PlaylistLoadPlaylist loading failed (ACK 53)
BusyUpdate already running (ACK 54)
NotPlayingAn operation requiring playback got interrupted (ACK 55)
FileExistsFile already exists (ACK 56)
UnknownACKAn unknown ACK (aka. bug)
show/hide Instances
type Response = Either MPDErrorSource
A response is either an MPDError or some result.
type Host = StringSource
type Port = IntegerSource
type Password = StringSource
Running
withMPDEx :: Host -> Port -> Password -> MPD a -> IO (Response a)Source
The most configurable API for running an MPD action.
Interacting
getResponse :: MonadMPD m => String -> m [String]Source
Send a command to the MPD server and return the result.
kill :: MonadMPD m => m ()Source
Kill the server. Obviously, the connection is then invalid.
Produced by Haddock version 2.6.1