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

Portabilityportable
Stabilityunstable
Maintainerinfo@pontarius.org

Network.XMPP.JID

Description

JIDs are written in the format of `node@server/resource'. An example of a JID is `jonkri@jabber.org'.

The node identifier is the part before the `@' character in Jabber IDs. Node names are optional. The server identifier is the part after the `@' character in Jabber IDs (and before the / character). The server identifier is the only required field of a JID. The server identifier MAY be an IP address but SHOULD be a fully qualified domain name. The resource identifier is the part after the / character in Jabber IDs. Like with node names, the resource identifier is optional.

A JID without a resource identifier (i.e. a JID in the form of `node@server') is called `bare JID'. A JID with a resource identifier is called `full JID'.

Synopsis

Documentation

jid :: Maybe String -> String -> Maybe String -> JIDSource

Simple function to construct a JID. We will add validation to this function in a later release.

jidIsFull :: JID -> BoolSource

JIDs are written in the format of `node@server/resource'. A JID without a resource identifier (i.e. a JID in the form of server or `node@server') is called a `bare JID'. A JID with a resource identifier is called `full JID'. This function returns True if the JID is full and False otherwise.

jidIsBare :: JID -> BoolSource

JIDs are written in the format of `node@server/resource'. A JID without a resource identifier (i.e. a JID in the form of server or `node@server') is called a `bare JID'. A JID with a resource identifier is called `full JID'. This function returns True if the JID is bare and False otherwise.

stringToJID :: String -> Maybe JIDSource

Converts a (JID) String to a JID record.

jidToString :: JID -> StringSource

Converts a JID to a String.