gloox::prep Namespace Reference

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

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@camaya.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 of LibIDN is not available.
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 of LibIDN is not available.
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 of LibIDN is not available.
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 of LibIDN is not available.
Generated on Tue Jun 8 23:37:57 2010 for gloox by  doxygen 1.6.3