pontarius-xmpp-0.0.5.0: A (prototyped) secure and easy to use XMPP library

Network.XMPP.Types

Synopsis

Documentation

type HostName = StringSource

Readability type for host name Strings.

type Password = StringSource

Readability type for password Strings.

type PortNumber = IntegerSource

Readability type for port number Integers.

type Resource = StringSource

Readability type for (JID) resource identifier Strings.

type UserName = StringSource

Readability type for user name Strings.

data Challenge Source

Constructors

Chal String 

Instances

data Success Source

Constructors

Succ String 

Instances

data JID Source

Constructors

JID 

Instances

data StanzaID Source

Constructors

SID String 

Instances

type To = JIDSource

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 

data Presence Source

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

Instances

data InternalEvent s m Source

Constructors

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

Instances

data StreamState Source

Constructors

PreStream 
PreFeatures StreamProperties 
PostFeatures StreamProperties StreamFeatures 

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

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

data TimeoutEvent s m Source

Constructors

TimeoutEvent StanzaID Timeout (StateT s m ()) 

Instances

data StreamError Source

Constructors

StreamError