property.c File Reference

#include "internal.h"

Go to the source code of this file.

Functions
void	gsasl_property_set (Gsasl_session *sctx, Gsasl_property prop, const char *data)
void	gsasl_property_set_raw (Gsasl_session *sctx, Gsasl_property prop, const char *data, size_t len)
const char *	gsasl_property_fast (Gsasl_session *sctx, Gsasl_property prop)
const char *	gsasl_property_get (Gsasl_session *sctx, Gsasl_property prop)

---

Function Documentation

const char* gsasl_property_fast	(	Gsasl_session *	sctx,
		Gsasl_property	prop
	)

gsasl_property_fast:

Parameters:

sctx	session handle.
prop	enumerated value of Gsasl_property type, indicating the type of data in .

Retrieve the data stored in the session handle for given property .

The pointer is to live data, and must not be deallocated or modified in any way.

This function will not invoke the application callback.

Return value: Return property value, if known, or NULL if no value known.

Since: 0.2.0

Definition at line 218 of file property.c.

const char* gsasl_property_get	(	Gsasl_session *	sctx,
		Gsasl_property	prop
	)

gsasl_property_get:

Parameters:

sctx	session handle.
prop	enumerated value of Gsasl_property type, indicating the type of data in .

Retrieve the data stored in the session handle for given property , possibly invoking the application callback to get the value.

The pointer is to live data, and must not be deallocated or modified in any way.

This function will invoke the application callback, using gsasl_callback(), when a property value is not known.

If no value is known, and no callback is specified or if the callback fail to return data, and if any obsolete callback functions has been set by the application, this function will try to call these obsolete callbacks, and store the returned data as the corresponding property. This behaviour of this function will be removed when the obsolete callback interfaces are removed.

Return value: Return data for property, or NULL if no value known.

Since: 0.2.0

Definition at line 255 of file property.c.

void gsasl_property_set	(	Gsasl_session *	sctx,
		Gsasl_property	prop,
		const char *	data
	)

gsasl_property_set:

Parameters:

sctx	session handle.
prop	enumerated value of Gsasl_property type, indicating the type of data in .
data	zero terminated character string to store.

Make a copy of and store it in the session handle for the indicated property .

You can immediately deallocate after calling this function, without affecting the data stored in the session handle.

Since: 0.2.0

Definition at line 150 of file property.c.

void gsasl_property_set_raw	(	Gsasl_session *	sctx,
		Gsasl_property	prop,
		const char *	data,
		size_t	len
	)

gsasl_property_set_raw:

Parameters:

sctx	session handle.
prop	enumerated value of Gsasl_property type, indicating the type of data in .
data	character string to store.
len	length of character string to store.

Make a copy of sized and store a zero terminated version of it in the session handle for the indicated property .

You can immediately deallocate after calling this function, without affecting the data stored in the session handle.

Except for the length indicator, this function is identical to gsasl_property_set.

Since: 0.2.0

Definition at line 176 of file property.c.