Network.XMPP.Types

Documentation

type Server = Text

type Username = Text

type Password = Text

type Resource = Text

data Stream

XMPP stream, used as a state in XmppMonad state transformer

Constructors

Stream

Fields

• handle :: Handle

  IO handle to the underlying file or socket

• idx :: !Int

  id of the next message (if needed)

• lexemes :: [Token]

  Stream of the lexemes coming from server

Instances

Monad m => MonadState Stream (XmppMonad m)

Defined in Network.XMPP.Types

Methods

get :: XmppMonad m Stream

put :: Stream -> XmppMonad m ()

state :: (Stream -> (a, Stream)) -> XmppMonad m a

newtype XmppMonad m a

Constructors

XmppMonad

Fields

• unXmppMonad :: StateT Stream m a

Instances

MonadTrans XmppMonad

Defined in Network.XMPP.Types

Methods

lift :: Monad m => m a -> XmppMonad m a

Monad m => MonadState Stream (XmppMonad m)

Defined in Network.XMPP.Types

Methods

get :: XmppMonad m Stream

put :: Stream -> XmppMonad m ()

state :: (Stream -> (a, Stream)) -> XmppMonad m a

Monad m => Monad (XmppMonad m)

Defined in Network.XMPP.Types

Methods

(>>=) :: XmppMonad m a -> (a -> XmppMonad m b) -> XmppMonad m b

(>>) :: XmppMonad m a -> XmppMonad m b -> XmppMonad m b

return :: a -> XmppMonad m a

Functor m => Functor (XmppMonad m)

Defined in Network.XMPP.Types

Methods

fmap :: (a -> b) -> XmppMonad m a -> XmppMonad m b

(<$) :: a -> XmppMonad m b -> XmppMonad m a

Monad m => Applicative (XmppMonad m)

Defined in Network.XMPP.Types

Methods

pure :: a -> XmppMonad m a

(<*>) :: XmppMonad m (a -> b) -> XmppMonad m a -> XmppMonad m b

liftA2 :: (a -> b -> c) -> XmppMonad m a -> XmppMonad m b -> XmppMonad m c

(*>) :: XmppMonad m a -> XmppMonad m b -> XmppMonad m b

(<*) :: XmppMonad m a -> XmppMonad m b -> XmppMonad m a

MonadIO m => MonadIO (XmppMonad m)

Defined in Network.XMPP.Types

Methods

liftIO :: IO a -> XmppMonad m a

MonadIO m => XmppSendable (XmppMonad m) Node

Defined in Network.XMPP.Stream

Methods

xmppSend :: Node -> XmppMonad m ()

MonadIO m => XmppSendable (XmppMonad m) (Content Posn)

Defined in Network.XMPP.Stream

Methods

xmppSend :: Content Posn -> XmppMonad m ()

MonadIO m => XmppSendable (XmppMonad m) (Stanza t 'Outgoing e)

Defined in Network.XMPP.Stream

Methods

xmppSend :: Stanza t 'Outgoing e -> XmppMonad m ()

runXmppMonad :: MonadIO m => XmppMonad m a -> m (a, Stream)

runXmppMonad' :: MonadIO m => Stream -> XmppMonad m a -> m (a, Stream)

newtype DomainID

Jabber ID (JID) datatype

https://xmpp.org/extensions/xep-0029.html#sect-idm45723967532368 JID - [node"@"]domain["/"resource] node - conforming-char[conforming-char]* - The node identifier (optional) domain - hname["."hname]* - The domain identifier (required) resource - any-char[any-char]* - The resource identifier (optional)

Constructors

DomainID

Fields

• unDomainID :: Text

Instances

Eq DomainID

Defined in Network.XMPP.Types

Methods

(==) :: DomainID -> DomainID -> Bool

(/=) :: DomainID -> DomainID -> Bool

Show DomainID

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> DomainID -> ShowS

show :: DomainID -> String

showList :: [DomainID] -> ShowS

newtype NodeID

Constructors

NodeID

Fields

• unNodeID :: Text

Instances

Eq NodeID

Defined in Network.XMPP.Types

Methods

(==) :: NodeID -> NodeID -> Bool

(/=) :: NodeID -> NodeID -> Bool

Show NodeID

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> NodeID -> ShowS

show :: NodeID -> String

showList :: [NodeID] -> ShowS

newtype ResourceID

Constructors

ResourceID

Fields

• unResourceID :: Text

Instances

Eq ResourceID

Defined in Network.XMPP.Types

Methods

(==) :: ResourceID -> ResourceID -> Bool

(/=) :: ResourceID -> ResourceID -> Bool

Show ResourceID

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> ResourceID -> ShowS

show :: ResourceID -> String

showList :: [ResourceID] -> ShowS

data JIDQualification

Constructors

Resource

NodeResource

Node

Domain

data SomeJID

Constructors

forall (a :: JIDQualification). SomeJID (JID a)

Instances

Read SomeJID

Defined in Network.XMPP.Types

Methods

readsPrec :: Int -> ReadS SomeJID

readList :: ReadS [SomeJID]

readPrec :: ReadPrec SomeJID

readListPrec :: ReadPrec [SomeJID]

Show SomeJID

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> SomeJID -> ShowS

show :: SomeJID -> String

showList :: [SomeJID] -> ShowS

data JID :: JIDQualification -> * where

Constructors

ResourceJID

Fields

• :: { jrDomain :: DomainID
•    , jrResource :: ResourceID
•    } -> JID 'Resource

NodeResourceJID

Fields

• :: { jnrNode :: NodeID

  Account name

•    , jnrDomain :: DomainID

  Server adress

•    , jnrResource :: ResourceID

  Resource name

•    } -> JID 'NodeResource

NodeJID

Fields

• :: { nNode :: NodeID
•    , nDomain :: DomainID
•    } -> JID 'Node

DomainJID

Fields

• :: { jdDomain :: DomainID
•    } -> JID 'Domain

Instances

Eq (JID a)

Defined in Network.XMPP.Types

Methods

(==) :: JID a -> JID a -> Bool

(/=) :: JID a -> JID a -> Bool

Read (JID 'Resource)

Defined in Network.XMPP.Types

Methods

readsPrec :: Int -> ReadS (JID 'Resource)

readList :: ReadS [JID 'Resource]

readPrec :: ReadPrec (JID 'Resource)

readListPrec :: ReadPrec [JID 'Resource]

Read (JID 'NodeResource)

Defined in Network.XMPP.Types

Methods

readsPrec :: Int -> ReadS (JID 'NodeResource)

readList :: ReadS [JID 'NodeResource]

readPrec :: ReadPrec (JID 'NodeResource)

readListPrec :: ReadPrec [JID 'NodeResource]

Read (JID 'Node)

Defined in Network.XMPP.Types

Methods

readsPrec :: Int -> ReadS (JID 'Node)

readList :: ReadS [JID 'Node]

readPrec :: ReadPrec (JID 'Node)

readListPrec :: ReadPrec [JID 'Node]

Read (JID 'Domain)

Defined in Network.XMPP.Types

Methods

readsPrec :: Int -> ReadS (JID 'Domain)

readList :: ReadS [JID 'Domain]

readPrec :: ReadPrec (JID 'Domain)

readListPrec :: ReadPrec [JID 'Domain]

Show (JID a)

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> JID a -> ShowS

show :: JID a -> String

showList :: [JID a] -> ShowS

ToMarkup (JID a)

Defined in Network.XMPP.Types

Methods

toMarkup :: JID a -> Markup

preEscapedToMarkup :: JID a -> Markup

toBareJID :: JID 'NodeResource -> JID 'Node

data StreamType

XMPP Stream type, used in stream pretty-printing combinator and the likes

Constructors

Client

Client-to-server

ComponentAccept

FIXME

ComponentConnect

FIXME

Instances

Show StreamType

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> StreamType -> ShowS

show :: StreamType -> String

showList :: [StreamType] -> ShowS

data RosterItem

Roster item type (7.1)

Constructors

RosterItem

Fields

• jid :: JID 'NodeResource

  Entry's JID

• subscribtion :: SubscribtionType

  Subscribtion type

• nickname :: Maybe String

  Entry's nickname

• groups :: [String]

  group elements

data SubscribtionType

Constructors

None

To

From

Both

Instances

Eq SubscribtionType

Defined in Network.XMPP.Types

Methods

(==) :: SubscribtionType -> SubscribtionType -> Bool

(/=) :: SubscribtionType -> SubscribtionType -> Bool

Read SubscribtionType

Defined in Network.XMPP.Types

Methods

readsPrec :: Int -> ReadS SubscribtionType

readList :: ReadS [SubscribtionType]

readPrec :: ReadPrec SubscribtionType

readListPrec :: ReadPrec [SubscribtionType]

Show SubscribtionType

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> SubscribtionType -> ShowS

show :: SubscribtionType -> String

showList :: [SubscribtionType] -> ShowS

data MessageType

Constructors

Chat

GroupChat

Headline

Normal

MessageError

Instances

Eq MessageType

Defined in Network.XMPP.Types

Methods

(==) :: MessageType -> MessageType -> Bool

(/=) :: MessageType -> MessageType -> Bool

Read MessageType

Defined in Network.XMPP.Types

Methods

readsPrec :: Int -> ReadS MessageType

readList :: ReadS [MessageType]

readPrec :: ReadPrec MessageType

readListPrec :: ReadPrec [MessageType]

Show MessageType

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> MessageType -> ShowS

show :: MessageType -> String

showList :: [MessageType] -> ShowS

data PresenceType

Constructors

Default

Unavailable

Subscribe

Subscribed

Unsubscribe

Unsubscribed

Probe

PresenceError

Instances

Eq PresenceType

Defined in Network.XMPP.Types

Methods

(==) :: PresenceType -> PresenceType -> Bool

(/=) :: PresenceType -> PresenceType -> Bool

Read PresenceType

Defined in Network.XMPP.Types

Methods

readsPrec :: Int -> ReadS PresenceType

readList :: ReadS [PresenceType]

readPrec :: ReadPrec PresenceType

readListPrec :: ReadPrec [PresenceType]

Show PresenceType

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> PresenceType -> ShowS

show :: PresenceType -> String

showList :: [PresenceType] -> ShowS

data IQType

Constructors

Get

Result

Set

IQError

Instances

Eq IQType

Defined in Network.XMPP.Types

Methods

(==) :: IQType -> IQType -> Bool

(/=) :: IQType -> IQType -> Bool

Read IQType

Defined in Network.XMPP.Types

Methods

readsPrec :: Int -> ReadS IQType

readList :: ReadS [IQType]

readPrec :: ReadPrec IQType

readListPrec :: ReadPrec [IQType]

Show IQType

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> IQType -> ShowS

show :: IQType -> String

showList :: [IQType] -> ShowS

data ShowType

Constructors

Available

Away

FreeChat

DND

XAway

Instances

Eq ShowType

Defined in Network.XMPP.Types

Methods

(==) :: ShowType -> ShowType -> Bool

(/=) :: ShowType -> ShowType -> Bool

Read ShowType

Defined in Network.XMPP.Types

Methods

readsPrec :: Int -> ReadS ShowType

readList :: ReadS [ShowType]

readPrec :: ReadPrec ShowType

readListPrec :: ReadPrec [ShowType]

Show ShowType

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> ShowType -> ShowS

show :: ShowType -> String

showList :: [ShowType] -> ShowS

data StanzaPurpose

Generic XMPP stream atom

Constructors

Incoming

Outgoing

Instances

Eq StanzaPurpose

Defined in Network.XMPP.Types

Methods

(==) :: StanzaPurpose -> StanzaPurpose -> Bool

(/=) :: StanzaPurpose -> StanzaPurpose -> Bool

Show StanzaPurpose

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> StanzaPurpose -> ShowS

show :: StanzaPurpose -> String

showList :: [StanzaPurpose] -> ShowS

SingKind StanzaPurpose

Defined in Network.XMPP.Types

Associated Types

type Demote StanzaPurpose

Methods

fromSing :: forall (a :: StanzaPurpose). Sing a -> Demote StanzaPurpose

toSing :: Demote StanzaPurpose -> SomeSing StanzaPurpose

SingI 'Incoming

Defined in Network.XMPP.Types

Methods

sing :: Sing 'Incoming

SingI 'Outgoing

Defined in Network.XMPP.Types

Methods

sing :: Sing 'Outgoing

TestEquality (Sing :: StanzaPurpose -> Type)

Defined in Network.XMPP.Types

Methods

testEquality :: forall (a :: k) (b :: k). Sing a -> Sing b -> Maybe (a :~: b)

Show (Sing 'Incoming)

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> Sing 'Incoming -> ShowS

show :: Sing 'Incoming -> String

showList :: [Sing 'Incoming] -> ShowS

Show (Sing 'Outgoing)

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> Sing 'Outgoing -> ShowS

show :: Sing 'Outgoing -> String

showList :: [Sing 'Outgoing] -> ShowS

data Sing (x :: StanzaPurpose)

Defined in Network.XMPP.Types

data Sing (x :: StanzaPurpose) where

• SIncoming :: Sing 'Incoming
• SOutgoing :: Sing 'Outgoing

type Demote StanzaPurpose

Defined in Network.XMPP.Types

type Demote StanzaPurpose = StanzaPurpose

data SomeStanza e

Constructors

forall (a :: StanzaType) (p :: StanzaPurpose). SomeStanza (Stanza a p e)

Instances

Show e => Show (SomeStanza e)

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> SomeStanza e -> ShowS

show :: SomeStanza e -> String

showList :: [SomeStanza e] -> ShowS

data StanzaType

Constructors

Message

Presence

IQ

type family DataByPurpose (p :: StanzaPurpose) body where ...

Equations

DataByPurpose 'Incoming body = Either [Content Posn] body

DataByPurpose 'Outgoing body = [Node]

data Stanza :: StanzaType -> StanzaPurpose -> * -> * where

Constructors

MkMessage

Fields

• :: { mFrom :: Maybe SomeJID
•    , mTo :: Maybe SomeJID
•    , mId :: Text

  Message from, to, id attributes

•    , mType :: MessageType

  Message type (2.1.1)

•    , mSubject :: Text

  Subject element (2.1.2.1)

•    , mBody :: Text

  Body element (2.1.2.2)

•    , mThread :: Text

  Thread element (2.1.2.3)

•    , mExt :: DataByPurpose p ext

  Additional contents, used for extensions

•    , mPurpose :: Sing p
•    } -> Stanza 'Message p ext

MkPresence

Fields

• :: { pFrom :: Maybe SomeJID
•    , pTo :: Maybe SomeJID
•    , pId :: Text

  Presence from, to, id attributes

•    , pType :: PresenceType

  Presence type (2.2.1)

•    , pShowType :: ShowType

  Show element (2.2.2.1)

•    , pStatus :: Text

  Status element (2.2.2.2)

•    , pPriority :: Maybe Integer

  Presence priority (2.2.2.3)

•    , pExt :: DataByPurpose p ext

  Additional contents, used for extensions

•    , pPurpose :: Sing p
•    } -> Stanza 'Presence p ext

MkIQ

Fields

• :: { iqFrom :: Maybe SomeJID
•    , iqTo :: Maybe SomeJID
•    , iqId :: Text

  IQ id (Core-9.2.3)

•    , iqType :: IQType

  IQ type (Core-9.2.3)

•    , iqBody :: DataByPurpose p ext

  Child element (Core-9.2.3)

•    , iqPurpose :: Sing p
•    } -> Stanza 'IQ p ext

Instances

MonadIO m => XmppSendable (XmppMonad m) (Stanza t 'Outgoing e)

Defined in Network.XMPP.Stream

Methods

xmppSend :: Stanza t 'Outgoing e -> XmppMonad m ()

MonadIO m => XmppSendable (ReaderT (Thread e) m) (Stanza t 'Outgoing ())

Defined in Network.XMPP.Concurrent

Methods

xmppSend :: Stanza t 'Outgoing () -> ReaderT (Thread e) m ()

(Show (Sing dir), Show (DataByPurpose dir ext), Show ext) => Show (Stanza t dir ext)

Defined in Network.XMPP.Types

Methods

showsPrec :: Int -> Stanza t dir ext -> ShowS

show :: Stanza t dir ext -> String

showList :: [Stanza t dir ext] -> ShowS