modules: several small doxygen bug fixes
[sip-router] / modules_k / usrloc / dlist.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2001-2003 FhG Fokus
5  *
6  * This file is part of Kamailio, a free SIP server.
7  *
8  * Kamailio is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * Kamailio is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License 
19  * along with this program; if not, write to the Free Software 
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  * History:
23  * ========
24  * 2006-11-28 Added get_number_of_users() (Jeffrey Magder - SOMA Networks)
25  * 2007-09-12 added partitioning support for fetching all ul contacts
26  *            (bogdan)
27  */
28
29 /*! \file
30  *  \brief USRLOC - List of registered domains
31  *  \ingroup usrloc
32  */
33
34
35 #ifndef DLIST_H
36 #define DLIST_H
37
38 #include <stdio.h>
39 #include "../../str.h"
40 #include "usrloc.h"
41 #include "udomain.h"
42
43 /*!
44  * List of all domains registered with usrloc
45  */
46 typedef struct dlist {
47         str name;            /*!< Name of the domain (null terminated) */
48         udomain_t* d;        /*!< Payload */
49         struct dlist* next;  /*!< Next element in the list */
50 } dlist_t;
51
52 /*! \brief Global list of all registered domains */
53 extern dlist_t* root;
54
55
56 /*!
57  * \brief Registers a new domain with usrloc
58  *
59  * Registers a new domain with usrloc. If the domain exists,
60  * a pointer to existing structure will be returned, otherwise
61  * a new domain will be created
62  * \param _n domain name
63  * \param _d new created domain
64  * \return 0 on success, -1 on failure
65  */
66 int register_udomain(const char* _n, udomain_t** _d);
67
68
69 /*!
70  * \brief Free all allocated memory for domains
71  */
72 void free_all_udomains(void);
73
74
75 /*!
76  * \brief Print all domains, just for debugging
77  * \param _f output file
78  */
79 void print_all_udomains(FILE* _f);
80
81
82 /*!
83  * \brief Run timer handler of all domains
84  * \return 0 if all timer return 0, != 0 otherwise
85  */
86 int synchronize_all_udomains(void);
87
88
89 /*!
90  * \brief Get all contacts from the usrloc, in partitions if wanted
91  *
92  * Return list of all contacts for all currently registered
93  * users in all domains. The caller must provide buffer of
94  * sufficient length for fitting all those contacts. In the
95  * case when buffer was exhausted, the function returns
96  * estimated amount of additional space needed, in this
97  * case the caller is expected to repeat the call using
98  * this value as the hint.
99  *
100  * Information is packed into the buffer as follows:
101  *
102  * +------------+----------+-----+------+-----+
103  * |contact1.len|contact1.s|sock1|flags1|path1|
104  * +------------+----------+-----+------+-----+
105  * |contact2.len|contact2.s|sock2|flags2|path1|
106  * +------------+----------+-----+------+-----+
107  * |..........................................|
108  * +------------+----------+-----+------+-----+
109  * |contactN.len|contactN.s|sockN|flagsN|pathN|
110  * +------------+----------+-----+------+-----+
111  * |000000000000|
112  * +------------+
113  *
114  * \param buf target buffer
115  * \param len length of buffer
116  * \param flags contact flags
117  * \param part_idx part index
118  * \param part_max maximal part
119  * \return 0 on success, positive if buffer size was not sufficient, negative on failure
120  */
121 int get_all_ucontacts(void *buf, int len, unsigned int flags,
122                 unsigned int part_idx, unsigned int part_max);
123
124
125 /*!
126  * \brief Find and return usrloc domain
127  *
128  * \param _n domain name
129  * \param _d usrloc domain (location table)
130  * \return 0 on success, -1 on failure
131  */
132  int get_udomain(const char* _n, udomain_t** _d);
133
134 /*!
135  * \brief Loops through all domains summing up the number of users
136  * \return the number of users, could be zero
137  */
138 unsigned long get_number_of_users(void);
139
140
141 /*!
142  * \brief Find a particular domain, small wrapper around find_dlist
143  * \param _d domain name
144  * \param _p pointer to domain if found
145  * \return 1 if domain was found, 0 otherwise
146  */
147 int find_domain(str* _d, udomain_t** _p);
148
149
150 #endif