gloox::prep Namespace Reference

Functions
bool	nodeprep (const std::string &node, std::string &out)
bool	nameprep (const std::string &domain, std::string &out)
bool	resourceprep (const std::string &resource, std::string &out)
bool	idna (const std::string &domain, std::string &out)

Detailed Description

This namespace offers functions to stringprep the individual parts of a JID.

You should not need to use these functions directly. All the necessary prepping is done for you if you stick to the interfaces provided. If you write your own enhancements, check with the spec.

Note

These functions depend on an installed LibIDN at compile time of gloox. If LibIDN is not installed these functions return the string they are given without any modification.

Author

Jakob Schroeter js@ca.nosp@m.maya.nosp@m..net

Since

0.2

Function Documentation

bool idna	(	const std::string &	domain,
		std::string &	out
	)

This function applies the idna() function to a string. I.e. it transforms internationalized domain names into plain ASCII.

Parameters

domain	The string to convert.
out	The converted string. In case of an error this string is not touched. If LibIDN is not available the string is returned unchanged.

Returns

True if prepping was successful, false otherwise or if LibIDN is not available.

Definition at line 95 of file prep.cpp.

bool nameprep	(	const std::string &	domain,
		std::string &	out
	)

This function applies the Nameprep profile of Stringprep to a string.

Parameters

domain	The string to apply the profile to.
out	The prepped string. In case of an error this string is not touched. If LibIDN is not available the string is returned unchanged.

Returns

True if prepping was successful, false otherwise or if LibIDN is not available.

Definition at line 71 of file prep.cpp.

bool nodeprep	(	const std::string &	node,
		std::string &	out
	)

This function applies the Nodeprep profile of Stringprep to a string.

Parameters

node	The string to apply the profile to.
out	The prepped string. In case of an error this string is not touched. If LibIDN is not available the string is returned unchanged.

Returns

True if prepping was successful, false otherwise or if LibIDN is not available.

Definition at line 59 of file prep.cpp.

bool resourceprep	(	const std::string &	resource,
		std::string &	out
	)

This function applies the Resourceprep profile of Stringprep to a std::string.

Parameters

resource	The string to apply the profile to.
out	The prepped string. In case of an error this string is not touched. If LibIDN is not available the string is returned unchanged.

Returns

True if prepping was successful, false otherwise or if LibIDN is not available.

Definition at line 83 of file prep.cpp.