← Back to branch summary

~ubuntu-branches/ubuntu/wily/sflphone/wily

« back to all changes in this revision

Viewing changes to sflphone-common/libs/pjproject/pjlib/include/pj/guid.h

  • Committer: Package Import Robot
  • Author(s): Francois Marier
  • Date: 2011-11-25 13:24:12 UTC
  • mfrom: (4.1.10 sid)
  • Revision ID: package-import@ubuntu.com-20111125132412-dc4qvhyosk74cd42
Tags: 1.0.1-4
http://bugs.debian.org/649726
Don't assume that arch:all packages will get built (closes: #649726)

Show diffs side-by-side

added added

removed removed

Lines of Context:
sflphone-common/libs/pjproject/pjlib/include/pj/guid.h
1
 
/* $Id: guid.h 2394 2008-12-23 17:27:53Z bennylp $ */
2
 
/* 
3
 
 * Copyright (C) 2008-2009 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
 
 *  Additional permission under GNU GPL version 3 section 7:
21
 
 *
22
 
 *  If you modify this program, or any covered work, by linking or
23
 
 *  combining it with the OpenSSL project's OpenSSL library (or a
24
 
 *  modified version of that library), containing parts covered by the
25
 
 *  terms of the OpenSSL or SSLeay licenses, Teluu Inc. (http://www.teluu.com)
26
 
 *  grants you additional permission to convey the resulting work.
27
 
 *  Corresponding Source for a non-source form of such a combination
28
 
 *  shall include the source code for the parts of OpenSSL used as well
29
 
 *  as that of the covered work.
30
 
 */
31
 
#ifndef __PJ_GUID_H__
32
 
#define __PJ_GUID_H__
33
 
 
34
 
 
35
 
/**
36
 
 * @file guid.h
37
 
 * @brief GUID Globally Unique Identifier.
38
 
 */
39
 
#include <pj/types.h>
40
 
 
41
 
 
42
 
PJ_BEGIN_DECL
43
 
 
44
 
 
45
 
/**
46
 
 * @defgroup PJ_DS Data Structure.
47
 
 */
48
 
/**
49
 
 * @defgroup PJ_GUID Globally Unique Identifier
50
 
 * @ingroup PJ_DS
51
 
 * @{
52
 
 *
53
 
 * This module provides API to create string that is globally unique.
54
 
 * If application doesn't require that strong requirement, it can just
55
 
 * use #pj_create_random_string() instead.
56
 
 */
57
 
 
58
 
 
59
 
/**
60
 
 * PJ_GUID_STRING_LENGTH specifies length of GUID string. The value is
61
 
 * dependent on the algorithm used internally to generate the GUID string.
62
 
 * If real GUID generator is used, then the length will be between 32 and
63
 
 * 36 bytes. Application should not assume which algorithm will
64
 
 * be used by GUID generator.
65
 
 *
66
 
 * Regardless of the actual length of the GUID, it will not exceed
67
 
 * PJ_GUID_MAX_LENGTH characters.
68
 
 *
69
 
 * @see pj_GUID_STRING_LENGTH()
70
 
 * @see PJ_GUID_MAX_LENGTH
71
 
 */
72
 
PJ_DECL_DATA(const unsigned) PJ_GUID_STRING_LENGTH;
73
 
 
74
 
/**
75
 
 * Get #PJ_GUID_STRING_LENGTH constant.
76
 
 */
77
 
PJ_DECL(unsigned) pj_GUID_STRING_LENGTH(void);
78
 
 
79
 
/**
80
 
 * PJ_GUID_MAX_LENGTH specifies the maximum length of GUID string,
81
 
 * regardless of which algorithm to use.
82
 
 */
83
 
#define PJ_GUID_MAX_LENGTH  36
84
 
 
85
 
/**
86
 
 * Create a globally unique string, which length is PJ_GUID_STRING_LENGTH
87
 
 * characters. Caller is responsible for preallocating the storage used
88
 
 * in the string.
89
 
 *
90
 
 * @param str       The string to store the result.
91
 
 *
92
 
 * @return          The string.
93
 
 */
94
 
PJ_DECL(pj_str_t*) pj_generate_unique_string(pj_str_t *str);
95
 
 
96
 
/**
97
 
 * Generate a unique string.
98
 
 *
99
 
 * @param pool      Pool to allocate memory from.
100
 
 * @param str       The string.
101
 
 */
102
 
PJ_DECL(void) pj_create_unique_string(pj_pool_t *pool, pj_str_t *str);
103
 
 
104
 
 
105
 
/**
106
 
 * @}
107
 
 */
108
 
 
109
 
PJ_END_DECL
110
 
 
111
 
#endif/* __PJ_GUID_H__ */
112