oSIP SDP parser Handling
[The SDP modules]

Classes
struct	sdp_bandwidth
struct	sdp_time_descr
struct	sdp_key
struct	sdp_attribute
struct	sdp_connection
struct	sdp_media
struct	sdp_message
struct	sdp_bandwidth
struct	sdp_time_descr
struct	sdp_key
struct	sdp_attribute
struct	sdp_connection
struct	sdp_media
struct	sdp_message
Defines
#define	sdp_e_email_get   sdp_message_e_email_get
Typedefs
typedef struct sdp_bandwidth	sdp_bandwidth_t
typedef struct sdp_time_descr	sdp_time_descr_t
typedef struct sdp_key	sdp_key_t
typedef struct sdp_attribute	sdp_attribute_t
typedef struct sdp_connection	sdp_connection_t
typedef struct sdp_media	sdp_media_t
typedef struct sdp_message	sdp_message_t
Functions
int	sdp_bandwidth_init (sdp_bandwidth_t **elem)
void	sdp_bandwidth_free (sdp_bandwidth_t *elem)
int	sdp_time_descr_init (sdp_time_descr_t **elem)
void	sdp_time_descr_free (sdp_time_descr_t *elem)
int	sdp_key_init (sdp_key_t **elem)
void	sdp_key_free (sdp_key_t *elem)
int	sdp_attribute_init (sdp_attribute_t **elem)
void	sdp_attribute_free (sdp_attribute_t *elem)
int	sdp_connection_init (sdp_connection_t **elem)
void	sdp_connection_free (sdp_connection_t *elem)
int	sdp_media_init (sdp_media_t **elem)
void	sdp_media_free (sdp_media_t *elem)
int	sdp_message_init (sdp_message_t **sdp)
int	sdp_message_parse (sdp_message_t *sdp, const char *buf)
int	sdp_message_to_str (sdp_message_t *sdp, char **dest)
void	sdp_message_free (sdp_message_t *sdp)
int	sdp_message_clone (sdp_message_t *sdp, sdp_message_t **dest)
int	sdp_message_v_version_set (sdp_message_t *sdp, char *value)
char *	sdp_message_v_version_get (sdp_message_t *sdp)
int	sdp_message_o_origin_set (sdp_message_t *sdp, char *username, char *sess_id, char *sess_version, char *nettype, char *addrtype, char *addr)
char *	sdp_message_o_username_get (sdp_message_t *sdp)
char *	sdp_message_o_sess_id_get (sdp_message_t *sdp)
char *	sdp_message_o_sess_version_get (sdp_message_t *sdp)
char *	sdp_message_o_nettype_get (sdp_message_t *sdp)
char *	sdp_message_o_addrtype_get (sdp_message_t *sdp)
char *	sdp_message_o_addr_get (sdp_message_t *sdp)
int	sdp_message_s_name_set (sdp_message_t *sdp, char *value)
char *	sdp_message_s_name_get (sdp_message_t *sdp)
int	sdp_message_i_info_set (sdp_message_t *sdp, int pos_media, char *value)
char *	sdp_message_i_info_get (sdp_message_t *sdp, int pos_media)
int	sdp_message_u_uri_set (sdp_message_t *sdp, char *value)
char *	sdp_message_u_uri_get (sdp_message_t *sdp)
int	sdp_message_e_email_add (sdp_message_t *sdp, char *value)
char *	sdp_message_e_email_get (sdp_message_t *sdp, int pos)
int	sdp_message_p_phone_add (sdp_message_t *sdp, char *value)
char *	sdp_message_p_phone_get (sdp_message_t *sdp, int pos)
int	sdp_message_c_connection_add (sdp_message_t *sdp, int pos_media, char *nettype, char *addrtype, char *addr, char *addr_multicast_ttl, char *addr_multicast_int)
char *	sdp_message_c_nettype_get (sdp_message_t *sdp, int pos_media, int pos)
char *	sdp_message_c_addrtype_get (sdp_message_t *sdp, int pos_media, int pos)
char *	sdp_message_c_addr_get (sdp_message_t *sdp, int pos_media, int pos)
char *	sdp_message_c_addr_multicast_ttl_get (sdp_message_t *sdp, int pos_media, int pos)
char *	sdp_message_c_addr_multicast_int_get (sdp_message_t *sdp, int pos_media, int pos)
int	sdp_message_b_bandwidth_add (sdp_message_t *sdp, int pos_media, char *bwtype, char *bandwidth)
sdp_bandwidth_t *	sdp_message_bandwidth_get (sdp_message_t *sdp, int pos_media, int pos)
char *	sdp_message_b_bwtype_get (sdp_message_t *sdp, int pos_media, int pos)
char *	sdp_message_b_bandwidth_get (sdp_message_t *sdp, int pos_media, int pos)
int	sdp_message_t_time_descr_add (sdp_message_t *sdp, char *start, char *stop)
char *	sdp_message_t_start_time_get (sdp_message_t *sdp, int pos_td)
char *	sdp_message_t_stop_time_get (sdp_message_t *sdp, int pos_td)
int	sdp_message_r_repeat_add (sdp_message_t *sdp, int pos_time_descr, char *value)
char *	sdp_message_r_repeat_get (sdp_message_t *sdp, int pos_time_descr, int pos_repeat)
int	sdp_message_z_adjustments_set (sdp_message_t *sdp, char *value)
char *	sdp_message_z_adjustments_get (sdp_message_t *sdp)
int	sdp_message_k_key_set (sdp_message_t *sdp, int pos_media, char *keytype, char *keydata)
char *	sdp_message_k_keytype_get (sdp_message_t *sdp, int pos_media)
char *	sdp_message_k_keydata_get (sdp_message_t *sdp, int pos_media)
int	sdp_message_a_attribute_add (sdp_message_t *sdp, int pos_media, char *att_field, char *att_value)
int	sdp_message_a_attribute_del (sdp_message_t *sdp, int pos_media, char *att_field)
int	sdp_message_a_attribute_del_at_index (sdp_message_t *sdp, int pos_media, char *att_field, int pos_attr)
sdp_attribute_t *	sdp_message_attribute_get (sdp_message_t *sdp, int pos_media, int pos)
char *	sdp_message_a_att_field_get (sdp_message_t *sdp, int pos_media, int pos)
char *	sdp_message_a_att_value_get (sdp_message_t *sdp, int pos_media, int pos)
int	sdp_message_endof_media (sdp_message_t *sdp, int pos)
int	sdp_message_m_media_add (sdp_message_t *sdp, char *media, char *port, char *number_of_port, char *proto)
char *	sdp_message_m_media_get (sdp_message_t *sdp, int pos_media)
char *	sdp_message_m_port_get (sdp_message_t *sdp, int pos_media)
int	sdp_message_m_port_set (sdp_message_t *sdp, int pos_media, char *port)
char *	sdp_message_m_number_of_port_get (sdp_message_t *sdp, int pos_media)
char *	sdp_message_m_proto_get (sdp_message_t *sdp, int pos_media)
int	sdp_message_m_payload_add (sdp_message_t *sdp, int pos_media, char *payload)
char *	sdp_message_m_payload_get (sdp_message_t *sdp, int pos_media, int pos)
int	sdp_message_m_payload_del (sdp_message_t *sdp, int pos_media, int pos)

---

Define Documentation

#define sdp_e_email_get   sdp_message_e_email_get

OBSOLETE: see sdp_message_e_email_get

---

Typedef Documentation

sdp_attribute_t

Structure for referencing an attribute header.

sdp_bandwidth_t

Structure for referencing bandwidth header.

sdp_connection_t

Structure for referencing a connection header.

sdp_key_t

Structure for referencing key header.

sdp_media_t

Structure for referencing a media header.

sdp_message_t

Structure for referencing a SDP packet.

sdp_time_descr_t

Structure for referencing time description header.

---

Function Documentation

void sdp_attribute_free

(

sdp_attribute_t *

elem

)

Free a attribute element.

Parameters:

elem

The element to work on.

int sdp_attribute_init

(

sdp_attribute_t **

elem

)

Allocate an attribute element.

Parameters:

elem

The element to work on.

void sdp_bandwidth_free

(

sdp_bandwidth_t *

elem

)

Free a bandwidth element.

Parameters:

elem

The element to work on.

int sdp_bandwidth_init

(

sdp_bandwidth_t **

elem

)

Allocate a bandwidth element.

Parameters:

elem

The element to work on.

void sdp_connection_free

(

sdp_connection_t *

elem

)

Free a connection element.

Parameters:

elem

The element to work on.

int sdp_connection_init

(

sdp_connection_t **

elem

)

Allocate a connection element.

Parameters:

elem

The element to work on.

void sdp_key_free

(

sdp_key_t *

elem

)

Free a key element.

Parameters:

elem

The element to work on.

int sdp_key_init

(

sdp_key_t **

elem

)

Allocate a key element.

Parameters:

elem

The element to work on.

void sdp_media_free

(

sdp_media_t *

elem

)

Free a media element.

Parameters:

elem

The element to work on.

int sdp_media_init

(

sdp_media_t **

elem

)

Allocate a media element.

Parameters:

elem

The element to work on.

char* sdp_message_a_att_field_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get the attribute name ('a' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	pos	The attribute line number.

char* sdp_message_a_att_value_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get the attribute value ('a' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	pos	The attribute line number.

int sdp_message_a_attribute_add	(	sdp_message_t *	sdp,
		int	pos_media,
		char *	att_field,
		char *	att_value
	)

Set the version in a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The line number.
	att_field	The token value.
	att_value	The token value.

int sdp_message_a_attribute_del	(	sdp_message_t *	sdp,
		int	pos_media,
		char *	att_field
	)

delete all attribute fields specified by att_field.

Parameters:

	sdp	The element to work on.
	pos_media	The line number.
	att_field	The value to remove.

int sdp_message_a_attribute_del_at_index	(	sdp_message_t *	sdp,
		int	pos_media,
		char *	att_field,
		int	pos_attr
	)

delete one specific attribute fields specified by att_field.

Parameters:

	sdp	The element to work on.
	pos_media	The line number.
	att_field	The value to remove.
	pos_attr	The index of attribute to remove.

sdp_attribute_t* sdp_message_attribute_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get one of the attribute ('a' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	pos	The attribute line number.

int sdp_message_b_bandwidth_add	(	sdp_message_t *	sdp,
		int	pos_media,
		char *	bwtype,
		char *	bandwidth
	)

Set the version in a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	bwtype	The token value.
	bandwidth	The token value.

char* sdp_message_b_bandwidth_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get the bandwidth value ('b' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	pos	The index in the bandwidth element list..

char* sdp_message_b_bwtype_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get the bandwidth type ('b' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	pos	The index in the bandwidth element list..

sdp_bandwidth_t* sdp_message_bandwidth_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get the bandwidth ('b' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	pos	The index in the bandwidth element list..

char* sdp_message_c_addr_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get the address ('c' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	pos	The index in the connection element list..

char* sdp_message_c_addr_multicast_int_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get the multicast int info ('c' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	pos	The index in the connection element list..

char* sdp_message_c_addr_multicast_ttl_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get the multicast ttl ('c' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	pos	The index in the connection element list..

char* sdp_message_c_addrtype_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get the address type ('c' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	pos	The index in the connection element list..

int sdp_message_c_connection_add	(	sdp_message_t *	sdp,
		int	pos_media,
		char *	nettype,
		char *	addrtype,
		char *	addr,
		char *	addr_multicast_ttl,
		char *	addr_multicast_int
	)

Set the version in a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	nettype	The token value.
	addrtype	The token value.
	addr	The token value.
	addr_multicast_ttl	The token value.
	addr_multicast_int	The token value.

char* sdp_message_c_nettype_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get the network type ('c' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	pos	The index in the connection element list..

int sdp_message_clone	(	sdp_message_t *	sdp,
		sdp_message_t **	dest
	)

Clone a SDP packet.

Parameters:

	sdp	The element to work on.
	dest	The cloned element.

int sdp_message_e_email_add	(	sdp_message_t *	sdp,
		char *	value
	)

Set the version in a SDP packet.

Parameters:

	sdp	The element to work on.
	value	The token value.

char* sdp_message_e_email_get	(	sdp_message_t *	sdp,
		int	pos
	)

Get one of the email ('e' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos	the index of the email line.

int sdp_message_endof_media	(	sdp_message_t *	sdp,
		int	pos
	)

Check if there is more media lines a SDP packet.

Parameters:

	sdp	The element to work on.
	pos	The attribute line number.

void sdp_message_free

(

sdp_message_t *

sdp

)

Free a SDP packet.

Parameters:

sdp

The element to work on.

char* sdp_message_i_info_get	(	sdp_message_t *	sdp,
		int	pos_media
	)

Get the session info ('i' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.

int sdp_message_i_info_set	(	sdp_message_t *	sdp,
		int	pos_media,
		char *	value
	)

Set the version in a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.
	value	The token value.

int sdp_message_init

(

sdp_message_t **

sdp

)

Allocate a SDP packet.

Parameters:

sdp

The element to work on.

int sdp_message_k_key_set	(	sdp_message_t *	sdp,
		int	pos_media,
		char *	keytype,
		char *	keydata
	)

Add a key in a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	index of m field.
	keytype	The token value.
	keydata	The token value.

char* sdp_message_k_keydata_get	(	sdp_message_t *	sdp,
		int	pos_media
	)

Get the key value ('k' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.

char* sdp_message_k_keytype_get	(	sdp_message_t *	sdp,
		int	pos_media
	)

Get the key type ('k' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The media line number.

int sdp_message_m_media_add	(	sdp_message_t *	sdp,
		char *	media,
		char *	port,
		char *	number_of_port,
		char *	proto
	)

Add a media line in a SDP packet.

Parameters:

	sdp	The element to work on.
	media	The token value.
	port	The token value.
	number_of_port	The token value.
	proto	The token value.

char* sdp_message_m_media_get	(	sdp_message_t *	sdp,
		int	pos_media
	)

Get the media type ('m' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The line number.

char* sdp_message_m_number_of_port_get	(	sdp_message_t *	sdp,
		int	pos_media
	)

Get the number of port ('m' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The line number.

int sdp_message_m_payload_add	(	sdp_message_t *	sdp,
		int	pos_media,
		char *	payload
	)

Set the payload in a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The line number.
	payload	The token value.

int sdp_message_m_payload_del	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Remove a payload in a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The line number.
	pos	The position of the payload in the media line.

char* sdp_message_m_payload_get	(	sdp_message_t *	sdp,
		int	pos_media,
		int	pos
	)

Get one of the payload number ('m' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The line number.
	pos	The i th payload element.

char* sdp_message_m_port_get	(	sdp_message_t *	sdp,
		int	pos_media
	)

Get the port number ('m' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The line number.

int sdp_message_m_port_set	(	sdp_message_t *	sdp,
		int	pos_media,
		char *	port
	)

Set the port number ('m' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The line number.
	port	The new port to set (must be allocated with osip_malloc)

char* sdp_message_m_proto_get	(	sdp_message_t *	sdp,
		int	pos_media
	)

Get the protocol ('m' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_media	The line number.

char* sdp_message_o_addr_get

(

sdp_message_t *

sdp

)

Get the addr ('o' field) of a SDP packet.

Parameters:

sdp

The element to work on.

char* sdp_message_o_addrtype_get

(

sdp_message_t *

sdp

)

Get the addrtype ('o' field) of a SDP packet.

Parameters:

sdp

The element to work on.

char* sdp_message_o_nettype_get

(

sdp_message_t *

sdp

)

Get the nettype ('o' field) of a SDP packet.

Parameters:

sdp

The element to work on.

int sdp_message_o_origin_set	(	sdp_message_t *	sdp,
		char *	username,
		char *	sess_id,
		char *	sess_version,
		char *	nettype,
		char *	addrtype,
		char *	addr
	)

Set the origin field in a SDP packet.

Parameters:

	sdp	The element to work on.
	username	The token value.
	sess_id	The token value.
	sess_version	The token value.
	nettype	The token value.
	addrtype	The token value.
	addr	The token value.

char* sdp_message_o_sess_id_get

(

sdp_message_t *

sdp

)

Get the session id ('o' field) of a SDP packet.

Parameters:

sdp

The element to work on.

char* sdp_message_o_sess_version_get

(

sdp_message_t *

sdp

)

Get the session version ('o' field) of a SDP packet.

Parameters:

sdp

The element to work on.

char* sdp_message_o_username_get

(

sdp_message_t *

sdp

)

Get the username ('o' field) of a SDP packet.

Parameters:

sdp

The element to work on.

int sdp_message_p_phone_add	(	sdp_message_t *	sdp,
		char *	value
	)

Set the version in a SDP packet.

Parameters:

	sdp	The element to work on.
	value	The token value.

char* sdp_message_p_phone_get	(	sdp_message_t *	sdp,
		int	pos
	)

Get one of the phone ('p' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos	the index of the phone line.

int sdp_message_parse	(	sdp_message_t *	sdp,
		const char *	buf
	)

Parse a SDP packet.

Parameters:

	sdp	The element to work on.
	buf	The buffer to parse.

int sdp_message_r_repeat_add	(	sdp_message_t *	sdp,
		int	pos_time_descr,
		char *	value
	)

Set the repeat information ('r' field) in a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_time_descr	index of t field.
	value	The token value.

char* sdp_message_r_repeat_get	(	sdp_message_t *	sdp,
		int	pos_time_descr,
		int	pos_repeat
	)

Get the repeat information ('r' field) in a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_time_descr	index of t field.
	pos_repeat	index of element in the 'r' field.

char* sdp_message_s_name_get

(

sdp_message_t *

sdp

)

Get the session name ('s' field) of a SDP packet.

Parameters:

sdp

The element to work on.

int sdp_message_s_name_set	(	sdp_message_t *	sdp,
		char *	value
	)

Set the session name in a SDP packet.

Parameters:

	sdp	The element to work on.
	value	The token value.

char* sdp_message_t_start_time_get	(	sdp_message_t *	sdp,
		int	pos_td
	)

Get the start time value ('t' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_td	The time description line number.

char* sdp_message_t_stop_time_get	(	sdp_message_t *	sdp,
		int	pos_td
	)

Get the stop time value ('t' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	pos_td	The time description line number.

int sdp_message_t_time_descr_add	(	sdp_message_t *	sdp,
		char *	start,
		char *	stop
	)

Set the version in a SDP packet.

Parameters:

	sdp	The element to work on.
	start	The token value.
	stop	The token value.

int sdp_message_to_str	(	sdp_message_t *	sdp,
		char **	dest
	)

Get a string representation of a SDP packet.

Parameters:

	sdp	The element to work on.
	dest	The resulting new allocated buffer.

char* sdp_message_u_uri_get

(

sdp_message_t *

sdp

)

Get the uri ('u' field) of a SDP packet.

Parameters:

sdp

The element to work on.

int sdp_message_u_uri_set	(	sdp_message_t *	sdp,
		char *	value
	)

Set the session info in a SDP packet.

Parameters:

	sdp	The element to work on.
	value	The token value.

char* sdp_message_v_version_get

(

sdp_message_t *

sdp

)

Get the version ('v' field) of a SDP packet.

Parameters:

sdp

The element to work on.

int sdp_message_v_version_set	(	sdp_message_t *	sdp,
		char *	value
	)

Set the version in a SDP packet.

Parameters:

	sdp	The element to work on.
	value	The token value.

char* sdp_message_z_adjustments_get

(

sdp_message_t *

sdp

)

Get the adjustments ('z' field) of a SDP packet.

Parameters:

sdp

The element to work on.

int sdp_message_z_adjustments_set	(	sdp_message_t *	sdp,
		char *	value
	)

Set the adjustments ('z' field) of a SDP packet.

Parameters:

	sdp	The element to work on.
	value	The token value.

void sdp_time_descr_free

(

sdp_time_descr_t *

elem

)

Free a time description element.

Parameters:

elem

The element to work on.

int sdp_time_descr_init

(

sdp_time_descr_t **

elem

)

Allocate a time description element.

Parameters:

elem

The element to work on.

---