A Jabber ID. More...

#include <xmpputils.h>

Inheritance diagram for JabberID:

Public Member Functions
	JabberID ()

	JabberID (const char *jid)

	JabberID (const String &jid)

	JabberID (const String *jid)

	JabberID (const char node, const char domain, const char *resource=0)

	JabberID (const JabberID &src)

bool	valid () const

const String &	node () const

const String &	bare () const

const String &	domain () const

void	domain (const char *d)

const String &	resource () const

bool	isFull () const

void	clear ()

bool	match (const JabberID &src) const

JabberID &	operator= (const JabberID &src)

JabberID &	operator= (const String &src)

JabberID &	operator= (const String *src)

bool	operator== (const JabberID &src) const

bool	operator== (const String &src) const

bool	operator!= (const JabberID &src) const

bool	operator!= (const String &src) const

void	resource (const char *res)

void	set (const char *jid)

void	set (const char node, const char domain, const char *resource=0)

Public Member Functions inherited from String
	String ()

	String (const char *value, int len=-1)

	String (char value, unsigned int repeat=1)

	String (int32_t value)

	String (uint32_t value)

	String (int64_t value)

	String (uint64_t value)

	String (bool value)

	String (double value)

	String (const String &value)

	String (const String *value)

virtual	~String ()

virtual void *	getObject (const String &name) const

const char *	c_str () const

const char *	safe () const

const char *	safe (const char *defStr) const

unsigned int	length () const

bool	null () const

int	lenUtf8 (uint32_t maxChar=0x10ffff, bool overlong=false) const

int	fixUtf8 (const char *replace=0, uint32_t maxChar=0x10ffff, bool overlong=false)

unsigned int	encodeFlags (const TokenDict *tokens) const

uint64_t	encodeFlags (const TokenDict64 *tokens) const

const String &	decodeFlags (unsigned int flags, const TokenDict *tokens, bool unknownflag=true)

const String &	decodeFlags (uint64_t flags, const TokenDict64 *tokens, bool unknownflag=true)

bool	checkBOM () const

bool	stripBOM ()

unsigned int	hash () const

void	clear ()

char	at (int index) const

String	substr (int offs, int len=-1) const

String &	trimBlanks ()

String &	trimSpaces ()

virtual const String &	toString () const

int	toInteger (int defvalue=0, int base=0, int minvalue=INT_MIN, int maxvalue=INT_MAX, bool clamp=true) const

int	toInteger (const TokenDict *tokens, int defvalue=0, int base=0) const

long int	toLong (long int defvalue=0, int base=0, long int minvalue=LONG_MIN, long int maxvalue=LONG_MAX, bool clamp=true) const

int64_t	toInt64 (int64_t defvalue=0, int base=0, int64_t minvalue=LLONG_MIN, int64_t maxvalue=LLONG_MAX, bool clamp=true) const

uint64_t	toUInt64 (uint64_t defvalue=0, int base=0, uint64_t minvalue=0, uint64_t maxvalue=ULLONG_MAX, bool clamp=true) const

double	toDouble (double defvalue=0.0) const

bool	toBoolean (bool defvalue=false) const

bool	isBoolean () const

String &	toUpper ()

String &	toLower ()

char	operator[] (signed int index) const

char	operator[] (unsigned int index) const

	operator const char * () const

String &	assign (const char *value, int len=-1)

String &	assign (char value, unsigned int repeat=1)

String &	hexify (void *data, unsigned int len, char sep=0, bool upCase=false)

String &	operator= (const String &value)

String &	operator= (const String *value)

String &	operator= (const char *value)

String &	operator= (char value)

String &	operator= (int32_t value)

String &	operator= (uint32_t value)

String &	operator= (int64_t value)

String &	operator= (uint64_t value)

String &	operator= (bool value)

String &	operator= (double value)

String &	operator+= (const char *value)

String &	operator+= (char value)

String &	operator+= (int32_t value)

String &	operator+= (uint32_t value)

String &	operator+= (int64_t value)

String &	operator+= (uint64_t value)

String &	operator+= (bool value)

String &	operator+= (double value)

bool	operator== (const char *value) const

bool	operator!= (const char *value) const

bool	operator== (const String &value) const

bool	operator!= (const String &value) const

bool	operator&= (const char *value) const

bool	operator\|= (const char *value) const

String &	operator<< (const char *value)

String &	operator<< (char value)

String &	operator<< (int32_t value)

String &	operator<< (uint32_t value)

String &	operator<< (int64_t value)

String &	operator<< (uint64_t value)

String &	operator<< (bool value)

String &	operator<< (double value)

String &	operator>> (const char *skip)

String &	operator>> (char &store)

String &	operator>> (UChar &store)

String &	operator>> (int &store)

String &	operator>> (unsigned int &store)

String &	operator>> (bool &store)

String &	append (const char *value, int len)

String &	append (const char value, const char separator=0, bool force=false)

String &	append (const ObjList list, const char separator=0, bool force=false)

String &	append (const ObjList &list, const char *separator=0, bool force=false)

String &	append (double value, unsigned int decimals=3)

String &	printf (const char *format,...)

String &	printf (unsigned int length, const char *format,...)

String &	appendFixed (unsigned int fixedLength, const char *str, unsigned int len=-1, char fill=' ', int align=Left)

String &	appendFixed (unsigned int fixedLength, const String &str, char fill=' ', int align=Left)

int	find (char what, unsigned int offs=0) const

int	find (const char *what, unsigned int offs=0) const

int	rfind (char what) const

int	rfind (const char *what) const

bool	startsWith (const char *what, bool wordBreak=false, bool caseInsensitive=false) const

bool	endsWith (const char *what, bool wordBreak=false, bool caseInsensitive=false) const

bool	startSkip (const char *what, bool wordBreak=true, bool caseInsensitive=false)

String &	extractTo (const char *sep, String &store)

String &	extractTo (const char *sep, bool &store)

String &	extractTo (const char *sep, int &store, int base=0)

String &	extractTo (const char sep, int &store, const TokenDict tokens, int base=0)

String &	extractTo (const char *sep, double &store)

virtual bool	matches (const String &value) const

bool	matches (const Regexp &rexp)

int	matchOffset (int index=0) const

int	matchLength (int index=0) const

String	matchString (int index=0) const

String	replaceMatches (const String &templ) const

int	matchCount () const

ObjList *	split (char separator, bool emptyOK=true) const

ObjList *	split (const Regexp &reg, bool emptyOK=true) const

String	msgEscape (char extraEsc=0) const

String	msgUnescape (int *errptr=0, char extraEsc=0) const

String	sqlEscape (char extraEsc=0) const

String	uriEscape (char extraEsc=0, const char *noEsc=0) const

String	uriUnescape (int *errptr=0) const

Public Member Functions inherited from GenObject
	GenObject ()

virtual	~GenObject ()

virtual bool	alive () const

virtual void	destruct ()

virtual const String &	traceId () const

NamedCounter *	getObjCounter () const

NamedCounter *	setObjCounter (NamedCounter *counter)

Static Public Member Functions
static const JabberID &	empty ()

static bool	valid (const String &value)

Static Public Member Functions inherited from String
static const String &	empty ()

static const char *	boolText (bool value)

static int	lenUtf8 (const char *value, uint32_t maxChar=0x10ffff, bool overlong=false)

static bool	checkBOM (const char *str)

static bool	stripBOM (const char *&str)

static bool	stripBOM (char *&str)

static unsigned int	hash (const char *value, unsigned int h=0)

static String	msgEscape (const char *str, char extraEsc=0)

static String	msgUnescape (const char str, int errptr=0, char extraEsc=0)

static String	sqlEscape (const char *str, char extraEsc=0)

static String	uriEscape (const char str, char extraEsc=0, const char noEsc=0)

static String	uriEscape (const char str, const char extraEsc, const char *noEsc=0)

static String	uriUnescape (const char str, int errptr=0)

static const String *	atom (const String &str, const char val)

Static Public Member Functions inherited from GenObject
static void *	getObject (const String &name, const GenObject *obj)

static bool	getObjCounting ()

static void	setObjCounting (bool enable)

static NamedCounter *	getObjCounter (const String &name, bool create=true)

static ObjList &	getObjCounters ()

Static Public Attributes
static Regexp	s_regExpValid

Additional Inherited Members
Public Types inherited from String
enum	Align { Left = 0 , Center , Right }

Protected Member Functions inherited from String
virtual void	changed ()

Detailed Description

A Jabber ID.

This class holds a Jabber ID

Constructor & Destructor Documentation

◆ JabberID() [1/6]

JabberID ( )

inline

Constructor

Referenced by empty(), JabberID(), match(), operator!=(), operator=(), operator=(), operator=(), operator==(), and operator==().

◆ JabberID() [2/6]

JabberID ( const char * jid )

inline

Constructor. Constructs a JID from a given string

Parameters

jid	The JID string

References set().

◆ JabberID() [3/6]

JabberID ( const String & jid )

inline

Constructor. Constructs a JID from a given string

Parameters

jid	The JID string

References set(), and String::String().

◆ JabberID() [4/6]

JabberID ( const String * jid )

inline

Constructor. Constructs a JID from a given string

Parameters

jid	The JID string

References set(), and String::String().

◆ JabberID() [5/6]

JabberID	(	const char *	node,
		const char *	domain,
		const char *	resource = 0 )

inline

Constructor. Constructs a JID from user, domain, resource

Parameters

node	The node
domain	The domain
resource	The resource

References domain(), node(), resource(), and set().

◆ JabberID() [6/6]

JabberID ( const JabberID & src )

inline

Copy constructor

Parameters

src	Source Jabber ID

References JabberID().

Member Function Documentation

◆ bare()

const String & bare ( ) const

inline

Get the bare JID: "node@domain"

Returns: The bare JID

References String::String().

Referenced by match(), and operator==().

◆ clear()

void clear ( )

inline

Clear content

References String::clear().

◆ domain() [1/2]

const String & domain ( ) const

inline

Get the domain part of the JID

Returns: The domain part of the JID

References String::String().

Referenced by JabberID(), and set().

◆ domain() [2/2]

void domain ( const char * d )

inline

Set the domain part of the JID.

Parameters

d	The new domain part of the JID.

References set().

◆ empty()

static const JabberID & empty ( )

static

Get an empty JabberID

Returns: A global empty JabberID

References JabberID().

Referenced by JBEngine::dropAll(), JBStreamSet::dropAll(), and JBEngine::setExiting().

◆ isFull()

bool isFull ( ) const

inline

Check if this is a full JID

Returns: True if this is a full JID

◆ match()

bool match ( const JabberID & src ) const

inline

Try to match another JID to this one. If src has a resource compare it too (case sensitive). Otherwise compare just the bare JID (case insensitive)

Parameters

src	The JID to match

Returns: True if matched

References bare(), JabberID(), String::null(), and resource().

◆ node()

const String & node ( ) const

inline

Get the node part of the JID

Returns: The node part of the JID

References String::String().

Referenced by JabberID(), and set().

◆ operator!=() [1/2]

bool operator!= ( const JabberID & src ) const

inline

Inequality operator

Parameters

src	The JID to compare with

Returns: True if not equal

References JabberID(), and operator==().

◆ operator!=() [2/2]

bool operator!= ( const String & src ) const

inline

Inequality operator

Parameters

src	The string to compare with

Returns: True if not equal

References operator==(), and String::String().

◆ operator=() [1/3]

JabberID & operator= ( const JabberID & src )

Assignement operator from JabberID

Parameters

src	The JID to copy from

Returns: This object

References JabberID().

◆ operator=() [2/3]

JabberID & operator= ( const String & src )

inline

Assignement operator from String

Parameters

src	The string

Returns: This object

References JabberID(), set(), and String::String().

◆ operator=() [3/3]

JabberID & operator= ( const String * src )

inline

Assignement operator from String pointer

Parameters

src	The string

Returns: This object

References JabberID(), set(), and String::String().

◆ operator==() [1/2]

bool operator== ( const JabberID & src ) const

inline

Equality operator. Do a case senitive resource comparison and a case insensitive bare jid comparison

Parameters

src	The JID to compare with

Returns: True if equal

References bare(), JabberID(), and resource().

Referenced by operator!=(), operator!=(), and operator==().

◆ operator==() [2/2]

bool operator== ( const String & src ) const

inline

Equality operator. Build a temporary JID and compare with it

Parameters

src	The string to compare with

Returns: True if equal

References JabberID(), operator==(), and String::String().

◆ resource() [1/2]

const String & resource ( ) const

inline

Get the resource part of the JID

Returns: The resource part of the JID

References String::String().

Referenced by XMPPUtils::getJIDFrom(), XMPPUtils::getJIDTo(), JabberID(), match(), operator==(), and set().

◆ resource() [2/2]

void resource ( const char * res )

inline

Set the resource part of the JID

Parameters

res	The new resource part of the JID

References set().

◆ set() [1/2]

void set ( const char * jid )

Set the data

Parameters

jid	The JID string to assign

Referenced by domain(), JabberID(), JabberID(), JabberID(), JabberID(), operator=(), operator=(), and resource().

◆ set() [2/2]

void set	(	const char *	node,
		const char *	domain,
		const char *	resource = 0 )

Set the data

Parameters

node	The node
domain	The domain
resource	The resource

References domain(), node(), and resource().

◆ valid() [1/2]

bool valid ( ) const

inline

Check if this is a valid JID

Returns: True if this JID is a valid one

References String::null().

◆ valid() [2/2]

static bool valid ( const String & value )

static

Check if the given string contains valid characters

Parameters

value The string to check

Returns: True if value is valid or 0. False if value is a non empty invalid string

References String::String().

Member Data Documentation

◆ s_regExpValid

Regexp s_regExpValid

static

Keep the regexp used to check the validity of a string

The documentation for this class was generated from the following file:

xmpputils.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JabberID() [1/6]

◆ JabberID() [2/6]

◆ JabberID() [3/6]

◆ JabberID() [4/6]

◆ JabberID() [5/6]

◆ JabberID() [6/6]

Member Function Documentation

◆ bare()

◆ clear()

◆ domain() [1/2]

◆ domain() [2/2]

◆ empty()

◆ isFull()

◆ match()

◆ node()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ resource() [1/2]

◆ resource() [2/2]

◆ set() [1/2]

◆ set() [2/2]

◆ valid() [1/2]

◆ valid() [2/2]

Member Data Documentation

◆ s_regExpValid