Network.NNTP.Internal

This module contains internalities of NNTP library

Types

newtype NntpT m a

NntpT represents a connection. Since some servers have short timeouts it is recommended to keep the connections short.

Constructors

NntpT

Fields

runNntpT :: NntpState m -> m (NntpState m, Either NntpError a)

Instances

MonadTrans NntpT

Monad m => Monad (NntpT m)

Functor m => Functor (NntpT m)

(Functor m, Monad m) => Applicative (NntpT m)

data NntpState m

NntpState represents a state at given moment. Please note that this type is not a part of stable API (when we will have one).

Constructors

NntpState

Fields

connection :: NntpConnection m

data NntpConnection m

NntpConnection represents a connection in a NntpT monad.

Please note that for runNntpWithConnection you need to supply both input and output functions.

Constructors

NntpConnection

Fields

input :: ByteString

Input is an stream which is from a server.

output :: ByteString -> m ()

Output is a function which sends the data to a server.

data NntpError

Indicates an error of handling NNTP connection. Please note that this should indicate client errors only (with the exception of ServiceDiscontinued, in some cases PostingFailed and NoSuchCommand. The last one if propagated outside NNTP module indicates a bug in library or server.).

Constructors

NoSuchGroup

Indicates that operation was performed on group that does not exists.

NoSuchArticle

Indicates that operation was performed on article that does not exists.

PostingFailed

Indicates that posting operation failed for some reason.

PostingNotAllowed

Indicates that posting is not allowed.

ServiceDiscontinued

Indicates that service was discontinued.

NoSuchCommand

Indicates that command does not exists.

Instances

Eq NntpError

Read NntpError

Show NntpError

type NntpParser m a = ParsecT ByteString () (NntpT m) a

Functions

runNntpParser :: Monad m => NntpParser m a -> NntpT m a

Transforms NntpParser into NntpT monad taking care about input position

nntpPutStr :: Monad m => ByteString -> NntpT m ()

Puts an argument to output.

nntpPutStrLn :: Monad m => ByteString -> NntpT m ()

Puts an argument to output followed by end-of-line.

nntpSendCommand

Arguments

:: Monad m

=> String

Command.

-> ByteString

Arguments.

-> [(Int, NntpParser m a)]

Parser of output.

-> NntpT m a

Returned value from parser.

Sends a command.

nntpSendText

Arguments

:: Monad m

=> ByteString

Text

-> [(Int, NntpParser m a)]

Parser of output.

-> NntpT m a

Returned value from parser.

Sends text

nntpPSendCommand

Arguments

:: Monad m

=> String

Command.

-> ByteString

Arguments.

-> [(Int, NntpParser m a)]

Parser of output.

-> NntpParser m a

Returned value from parser.

Sends a command.

nntpPSendText

Arguments

:: Monad m

=> ByteString

Text

-> [(Int, NntpParser m a)]

Parser of output.

-> NntpParser m a

Returned value from parser.

Sends text

tryCommands

Arguments

:: Monad m

=> [NntpT m a]

Possible command.

-> NntpT m a

Result

Try commands one by one to check for existing command.

postize :: ByteString -> ByteString

Converts into postable form.

depostize :: ByteString -> ByteString

Converts from postable form