Network.NNTP.Internal

This module contains internalities of NNTP library

Types

data Article

Represents a single article. Please note that except the splitting into header and body no parsing is done.

Constructors

Article

Fields

articleID :: String

Returns the article ID

articleHeader :: Maybe ByteString

Returns the article header. Data.Maybe.Nothing indicates not fetched header.

articleBody :: Maybe ByteString

Returns the article body. Data.Maybe.Nothing indicates not fetched body.

Instances

Eq Article

Show Article

data Group

Represents a single group.

Constructors

Group

Fields

groupName :: String

Returns the group name.

groupArticleFirst :: Integer

Returns the number of first article avaible.

groupArticleLast :: Integer

Returns the number of last article avaible.

Instances

Eq Group

Show Group

data Monad m => 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 :: StateT (NntpState m) (ErrorT NntpError m) a

Instances

MonadTrans NntpT

Monad m => Monad (NntpT m)

Monad m => Functor (NntpT m)

Monad m => Applicative (NntpT m)

MonadIO m => MonadIO (NntpT m)

data Monad m => 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 Monad m => 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

Error 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.

-> NntpParser m a

Parser of output.

-> NntpT m a

Returned value from parser.

Sends a commad.

tryCommands

Arguments

:: Monad m

=> [NntpT m a]

Possible command.

-> NntpT m a

Result

Try commands one by one to check for existing command.