Network.XMPP.Types

Synopsis

Documentation

type HostName = String Source

Readability type for host name Strings.

type Password = String Source

Readability type for password Strings.

type PortNumber = Integer Source

Readability type for port number Integers.

type Resource = String Source

Readability type for (JID) resource identifier Strings.

type UserName = String Source

Readability type for user name Strings.

data EnumeratorEvent Source

Constructors

EnumeratorDone
EnumeratorXML XMLEvent
EnumeratorException SomeException

Instances

Show EnumeratorEvent

data Challenge Source

Constructors

Chal String

Instances

Show Challenge

data Success Source

Constructors

Succ String

Instances

Show Success

data TLSState Source

Constructors

NoTLS
PreProceed
PreHandshake
PostHandshake TLSCtx

data JID Source

Constructors

JID
Fields jidNode :: Maybe String jidServer :: String jidResource :: Maybe String

Instances

Eq JID
Show JID

data StanzaID Source

Constructors

SID String

Instances

Eq StanzaID
Show StanzaID

type From = JID Source

type To = JID Source

type XMLLang = String Source

data Stanza Source

Constructors

Stanza
Fields stanzaID :: Maybe StanzaID stanzaFrom :: Maybe From stanzaTo :: Maybe To stanzaLang :: Maybe XMLLang

Instances

Eq Stanza
Show Stanza

data MessageType Source

Constructors

Chat
Error_
Groupchat
Headline
Normal
OtherMessageType String

Instances

Eq MessageType
Show MessageType

data Message Source

Constructors

Message
Fields messageStanza :: Stanza messageType :: MessageType messagePayload :: [Element]
MessageError
Fields messageErrorStanza :: Stanza messageErrorPayload :: Maybe [Element] messageErrorStanzaError :: StanzaError

Instances

Eq Message
Show Message

data PresenceType Source

Constructors

Subscribe	Sender wants to subscribe to presence
Subscribed	Sender has approved the subscription
Unsubscribe	Sender is unsubscribing from presence
Unsubscribed	Sender has denied or cancelled a subscription
Probe	Sender requests current presence; should only be used by servers PresenceError \| -- ^ Processing or delivery of previously sent presence stanza failed
Available
Unavailable

Instances

Eq PresenceType
Show PresenceType

data Presence Source

Presence stanzas are used to express an entity's network availability.

Constructors

Presence
Fields presenceStanza :: Stanza presenceType :: PresenceType presencePayload :: [Element]
PresenceError
Fields presenceErrorStanza :: Stanza presenceErrorPayload :: Maybe [Element] presenceErrorStanzaError :: StanzaError

Instances

Eq Presence
Show Presence

data IQ Source

Constructors

IQGet
Fields iqGetStanza :: Stanza iqGetPayload :: Element
IQSet
Fields iqSetStanza :: Stanza iqSetPayload :: Element
IQResult
Fields iqResultStanza :: Stanza iqResultPayload :: Maybe Element
IQError
Fields iqErrorStanza :: Stanza iqErrorPayload :: Maybe Element iqErrorStanzaError :: StanzaError

Instances

Eq IQ
Show IQ

data InternalEvent s m Source

Constructors

IEC (ClientEvent s m)
IEE EnumeratorEvent
IET (TimeoutEvent s m)

Instances

Show (InternalEvent s m)

data XMLEvent Source

Constructors

XEBeginStream String
XEFeatures String
XEChallenge Challenge
XESuccess Success
XEEndStream
XEIQ IQ
XEPresence Presence
XEMessage Message
XEProceed
XEOther String

Instances

Show XMLEvent

data ConnectionState Source

Constructors

Disconnected
Connected ServerAddress Handle

Instances

Eq ConnectionState

data ClientEvent s m Source

Constructors

CEOpenStream HostName PortNumber (OpenStreamResult -> StateT s m ())
CESecureWithTLS Certificate (Certificate -> Bool) (SecureWithTLSResult -> StateT s m ())
CEAuthenticate UserName Password (Maybe Resource) (AuthenticateResult -> StateT s m ())
CEMessage Message (Maybe (Message -> StateT s m Bool)) (Maybe (Timeout, StateT s m ())) (Maybe (StreamError -> StateT s m ()))
CEPresence Presence (Maybe (Presence -> StateT s m Bool)) (Maybe (Timeout, StateT s m ())) (Maybe (StreamError -> StateT s m ()))
CEIQ IQ (Maybe (IQ -> StateT s m Bool)) (Maybe (Timeout, StateT s m ())) (Maybe (StreamError -> StateT s m ()))
CEAction (Maybe (StateT s m Bool)) (StateT s m ())

Instances

Show (ClientEvent s m)

data StreamState Source

Constructors

PreStream
PreFeatures StreamProperties
PostFeatures StreamProperties StreamFeatures

type Certificate = String Source

data ConnectResult Source

Constructors

ConnectSuccess StreamProperties StreamFeatures (Maybe Resource)
ConnectOpenStreamFailure
ConnectSecureWithTLSFailure
ConnectAuthenticateFailure

data OpenStreamResult Source

Constructors

OpenStreamSuccess StreamProperties StreamFeatures
OpenStreamFailure

data SecureWithTLSResult Source

Constructors

SecureWithTLSSuccess StreamProperties StreamFeatures
SecureWithTLSFailure

data AuthenticateResult Source

Constructors

AuthenticateSuccess StreamProperties StreamFeatures Resource
AuthenticateFailure

data ServerAddress Source

Constructors

ServerAddress HostName PortNumber

Instances

Eq ServerAddress

data XMPPError Source

Constructors

UncaughtEvent

Instances

Eq XMPPError
Show XMPPError
Error XMPPError

data StanzaError Source

Constructors

StanzaError
Fields stanzaErrorType :: StanzaErrorType stanzaErrorCondition :: StanzaErrorCondition stanzaErrorText :: Maybe String stanzaErrorApplicationSpecificCondition :: Maybe Element

Instances

Eq StanzaError
Show StanzaError

data StanzaErrorType Source

All stanzas (IQ, message, presence) can cause errors, which looks like stanza-kind to='sender' type='error'. These errors are of one of the types listed below.

Constructors

Cancel	Error is unrecoverable - do not retry
Continue	Conditition was a warning - proceed
Modify	Change the data and retry
Auth	Provide credentials and retry
Wait	Error is temporary - wait and retry

Instances

Eq StanzaErrorType
Show StanzaErrorType

data StanzaErrorCondition Source

The stanza errors are accommodated with one of the error conditions listed below. The ones that are not self-explainatory should be documented below.

Constructors

BadRequest	Malformed XML
Conflict	Resource or session with name already exists
FeatureNotImplemented
Forbidden	Insufficient permissions
Gone	Entity can no longer be contacted at this address
InternalServerError
ItemNotFound
JIDMalformed
NotAcceptable	Does not meet policy criteria
NotAllowed	No entity may perform this action
NotAuthorized	Must provide proper credentials
PaymentRequired
RecipientUnavailable	Temporarily unavailable
Redirect	Redirecting to other entity, usually temporarily
RegistrationRequired
RemoteServerNotFound
RemoteServerTimeout
ResourceConstraint	Entity lacks the necessary system resources
ServiceUnavailable
SubscriptionRequired
UndefinedCondition	Application-specific condition
UnexpectedRequest	Badly timed request

Instances

Eq StanzaErrorCondition
Show StanzaErrorCondition

type Timeout = Int Source

data TimeoutEvent s m Source

Constructors

TimeoutEvent StanzaID Timeout (StateT s m ())

Instances

Show (TimeoutEvent s m)

data StreamError Source

Constructors

StreamError

type XMLString = String Source

NoAuthentication
AuthenticatingPreChallenge1 String String (Maybe Resource)
AuthenticatingPreChallenge2 String String (Maybe Resource)
AuthenticatingPreSuccess String String (Maybe Resource)
AuthenticatedUnbound String (Maybe Resource)
AuthenticatedBound String Resource