Group PJSIP_URI_PARAM

group PJSIP_URI_PARAM

Generic parameter elements container.

Functions

pjsip_param *pjsip_param_find(const pjsip_param *param_list, const pj_str_t *name)

Find the specified parameter name in the list. The name will be compared in case-insensitive comparison.

Parameters:
  • param_list – List of parameters to find.

  • name – Parameter/header name to find.

Returns:

The parameter if found, or NULL.

pjsip_param *pjsip_param_cfind(const pjsip_param *param_list, const pj_str_t *name)

Alias for pjsip_param_find()

int pjsip_param_cmp(const pjsip_param *param_list1, const pjsip_param *param_list2, pj_bool_t ig_nf)

Compare two parameter lists.

Parameters:
  • param_list1 – First parameter list.

  • param_list2 – Second parameter list.

  • ig_nf – If set to 1, do not compare parameters that only appear in one of the list.

Returns:

Zero if the parameter list are equal, non-zero otherwise.

void pjsip_param_clone(pj_pool_t *pool, pjsip_param *dst_list, const pjsip_param *src_list)

Duplicate the parameters.

Parameters:
  • pool – Pool to allocate memory from.

  • dst_list – Destination list.

  • src_list – Source list.

void pjsip_param_shallow_clone(pj_pool_t *pool, pjsip_param *dst_list, const pjsip_param *src_list)

Duplicate the parameters.

Parameters:
  • pool – Pool to allocate memory from.

  • dst_list – Destination list.

  • src_list – Source list.

pj_ssize_t pjsip_param_print_on(const pjsip_param *param_list, char *buf, pj_size_t size, const pj_cis_t *pname_unres, const pj_cis_t *pvalue_unres, int sep)

Print parameters.

Parameters:
  • param_list – The parameter list.

  • buf – Buffer.

  • size – Size of buffer.

  • pname_unres – Specification of allowed characters in pname.

  • pvalue_unres – Specification of allowed characters in pvalue.

  • sep – Separator character (either ‘;’, ‘,’, or ‘?’). When separator is set to ‘?’, this function will automatically adjust the separator character to ‘&’ after the first parameter is printed.

Returns:

The number of bytes printed, or -1 on errr.

struct pjsip_param
#include <sip_uri.h>

Generic parameter, normally used in other_param or header_param.

Public Functions

PJ_DECL_LIST_MEMBER(struct pjsip_param)

Generic list member.

Public Members

pj_str_t name

Param/header name.

pj_str_t value

Param/header value.