blob: 15766e83a590fab5709b9e7f6b238b0ee17675c2 [file] [log] [blame]
Tristan Matthews0a329cc2013-07-17 13:20:14 -04001/* $Id$ */
2/*
3 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
4 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20#ifndef __PJSIP_TEL_URI_H__
21#define __PJSIP_TEL_URI_H__
22
23/**
24 * @file sip_tel_uri.h
25 * @brief Tel: URI
26 */
27
28#include <pjsip/sip_uri.h>
29
30/**
31 * @addtogroup PJSIP_TEL_URI tel URI Scheme
32 * @ingroup PJSIP_URI
33 * @brief Support for "tel:" URI scheme.
34 * @{
35 */
36
37
38PJ_BEGIN_DECL
39
40/**
41 * tel: URI.
42 */
43typedef struct pjsip_tel_uri
44{
45 pjsip_uri_vptr *vptr; /**< Pointer to virtual function table. */
46 pj_str_t number; /**< Global or local phone number */
47 pj_str_t context; /**< Phone context (for local number). */
48 pj_str_t ext_param; /**< Extension param. */
49 pj_str_t isub_param; /**< ISDN sub-address param. */
50 pjsip_param other_param;/**< Other parameter. */
51} pjsip_tel_uri;
52
53
54/**
55 * Create a new tel: URI.
56 *
57 * @param pool The pool.
58 *
59 * @return New instance of tel: URI.
60 */
61PJ_DECL(pjsip_tel_uri*) pjsip_tel_uri_create(pj_pool_t *pool);
62
63/**
64 * This function compares two numbers for equality, according to rules as
65 * specified in RFC 3966.
66 *
67 * @param nb1 The first number.
68 * @param nb2 The second number.
69 *
70 * @return Zero if equal, -1 if nb1 is less than nb2, or +1 if
71 * nb1 is greater than nb2.
72 */
73PJ_DECL(int) pjsip_tel_nb_cmp(const pj_str_t *nb1, const pj_str_t *nb2);
74
75
76PJ_END_DECL
77
78
79/**
80 * @}
81 */
82
83
84#endif /* __PJSIP_TEL_URI_H__ */