typedef axl_bool(* VortexProfileMaskFunc)(VortexConnection *connection, int channel_num, const char *uri, const char *profile_content, const char *serverName, axlPointer user_data)

Profile mask handler to perform profile filtering functions.

This handler definition is used by:

The handler (a mask) is executed for each profile to be filtered. The function based on the data received must return axl_true (to filter a profile) or axl_false (to not filter it).

The function receives the connection where the filtering is taking place, the profile uri and a user defined pointer configured at the function used to install the mask, along with some data which is optional according to the place that the mask is executed.

Because the profile mask is used by the vortex engine to filter profiles at the greeting process and filter profiles at the channel creation process, data available on such stages differs.

At the greetings process, only uri is available. The value provided for the channel_num is -1 and NULL for profile_content and serverName.

At the channel creation process all values are defined (with the exception of profile_content and serverName which are optional).

Parameters:
connection The connection that where the filter process will take place.
channel_num The channel number that is requested in the channel creation stage.
uri A uri reference to the profile check if it should be filtered.
profile_content The piggyback provided at the start channel request along with the profile.
serverName A request for the connection to act as serverName.
user_data User defined pointer passed to the function.
Returns:
axl_true to filter the uri, axl_false if not.