libdingaling.h File Reference

Main Header File. More...

Data Structures
struct	ldl_candidate
	A structure to store a jingle candidate. More...
struct	ldl_payload
	A structure to store a jingle payload. More...
Defines
#define	ldl_test_flag(obj, flag)   ((obj)->flags & flag)
	Test for the existance of a flag on an arbitary object.
#define	ldl_set_flag(obj, flag)   (obj)->flags |= (flag)
	Set a flag on an arbitrary object.
#define	ldl_clear_flag(obj, flag)   (obj)->flags &= ~(flag)
	Clear a flag on an arbitrary object.
#define	ldl_set_flag_locked(obj, flag)
	Set a flag on an arbitrary object while locked.
#define	ldl_clear_flag_locked(obj, flag)   apr_thread_mutex_lock(obj->flag_mutex); (obj)->flags &= ~(flag); apr_thread_mutex_unlock(obj->flag_mutex);
	Clear a flag on an arbitrary object.
#define	ldl_copy_flags(dest, src, flags)   (dest)->flags &= ~(flags); (dest)->flags |= ((src)->flags & (flags))
	Copy flags from one arbitrary object to another.
#define	ldl_strlen_zero(s)   (s && *s != '\0') ? 0 : 1
	Test for NULL or zero length string.
Functions
ldl_status	ldl_session_destroy (ldl_session_t **session_p)
	Destroy a Jingle Session.
char *	ldl_session_get_value (ldl_session_t *session, char *key)
	Get a value from a session.
void	ldl_session_set_value (ldl_session_t *session, char *key, char *val)
	Set a value on a session.
ldl_status	ldl_session_create (ldl_session_t **session_p, ldl_handle_t *handle, char *id, char *them, char *me)
	Create a Jingle Session.
char *	ldl_session_get_id (ldl_session_t *session)
	get the id of a session
char *	ldl_session_get_caller (ldl_session_t *session)
	Get the caller name of a session.
char *	ldl_session_get_callee (ldl_session_t *session)
	Get the callee name of a session.
void	ldl_session_set_ip (ldl_session_t *session, char *ip)
	Set the ip of a session.
char *	ldl_session_get_ip (ldl_session_t *session)
	Get the ip of a session.
void	ldl_session_set_private (ldl_session_t *session, void *private_data)
	Set a private pointer to associate with the session.
void *	ldl_session_get_private (ldl_session_t *session)
	Get a private pointer from a session.
void	ldl_session_accept_candidate (ldl_session_t *session, ldl_candidate_t *candidate)
	Accept a candidate.
void	ldl_global_set_logger (ldl_logger_t logger)
	Set a custom logger.
char *	ldl_handle_probe (ldl_handle_t *handle, char *id, char *from, char *buf, unsigned int len)
	Perform a probe on a given id to resolve the proper Jingle Resource.
char *	ldl_handle_disco (ldl_handle_t *handle, char *id, char *from, char *buf, unsigned int len)
	Perform a discovery on a given id to resolve the proper Jingle Resource.
unsigned int	ldl_session_terminate (ldl_session_t *session)
	Signal a termination request on a given session.
void *	ldl_handle_get_private (ldl_handle_t *handle)
	Get the private data of a connection handle.
void	ldl_session_send_msg (ldl_session_t *session, char *subject, char *body)
	Send a message to a session.
void	ldl_handle_send_presence (ldl_handle_t *handle, char *from, char *to, char *type, char *rpid, char *message)
	Send a presence notification to a target.
void	ldl_handle_send_vcard (ldl_handle_t *handle, char *from, char *to, char *id, char *vcard)
	Send a vcard.
void	ldl_handle_send_msg (ldl_handle_t *handle, char *from, char *to, char *subject, char *body)
	Send a message.
unsigned int	ldl_session_candidates (ldl_session_t *session, ldl_candidate_t *candidates, unsigned int clen)
	Offer candidates to a potential session.
unsigned int	ldl_session_describe (ldl_session_t *session, ldl_payload_t *payloads, unsigned int plen, ldl_description_t description)
	Initiate or Accept a new session and provide transport options.
ldl_state_t	ldl_session_get_state (ldl_session_t *session)
	get a session's state
ldl_status	ldl_session_get_candidates (ldl_session_t *session, ldl_candidate_t **candidates, unsigned int *len)
	get the candidates
ldl_status	ldl_session_get_payloads (ldl_session_t *session, ldl_payload_t **payloads, unsigned int *len)
	get the payloads
ldl_status	ldl_global_init (int debug)
	Initilize libDingaLing.
ldl_status	ldl_global_destroy (void)
	Destroy libDingaLing.
void	ldl_global_set_log_stream (FILE *log_stream)
	Set the log stream.
ldl_status	ldl_handle_init (ldl_handle_t **handle, char *login, char *password, char *server, ldl_user_flag_t flags, char *status_msg, ldl_loop_callback_t loop_callback, ldl_session_callback_t session_callback, ldl_response_callback_t response_callback, void *private_info)
	Initilize a new libDingaLing handle.
void	ldl_handle_run (ldl_handle_t *handle)
	Run a libDingaLing handle.
void	ldl_handle_stop (ldl_handle_t *handle)
	Stop a libDingaLing handle.
ldl_status	ldl_handle_destroy (ldl_handle_t **handle)
	Destroy a libDingaLing handle.
void	ldl_handle_set_log_stream (ldl_handle_t *handle, FILE *log_stream)
	Set the log stream on a handle.

---

Detailed Description

Main Header File.

---