uspace/srv/locsrv/category.h

   1 /*
   2  * Copyright (c) 2011 Jiri Svoboda
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup loc
  30  * @{
  31  */
  32 /** @file Categories for location service.
  33  */
  34
  35 #ifndef CATEGORY_H_
  36 #define CATEGORY_H_
  37
  38 #include <adt/list.h>
  39 #include "locsrv.h"
  40
  41 typedef sysarg_t catid_t;
  42
  43 /** Service category */
  44 typedef struct {
  45         /** Protects this structure, list of services */
  46         fibril_mutex_t mutex;
  47
  48         /** Identifier */
  49         catid_t id;
  50
  51         /** Category name */
  52         const char *name;
  53
  54         /** Link to list of categories (categ_dir_t.categories) */
  55         link_t cat_list;
  56
  57         /** List of service memberships in this category (svc_categ_t) */
  58         list_t svc_memb;
  59 } category_t;
  60
  61 /** Service directory ogranized by categories (yellow pages) */
  62 typedef struct {
  63         /** Protects this structure, list of categories */
  64         fibril_mutex_t mutex;
  65         /** List of all categories (category_t) */
  66         list_t categories;
  67 } categ_dir_t;
  68
  69 /** Service in category membership. */
  70 typedef struct {
  71         /** Link to category_t.svc_memb list */
  72         link_t cat_link;
  73         /** Link to loc_service_t.cat_memb list */
  74         link_t svc_link;
  75
  76         /** Category */
  77         category_t *cat;
  78         /** Service */
  79         loc_service_t *svc;
  80 } svc_categ_t;
  81
  82 extern void categ_dir_init(categ_dir_t *);
  83 extern void categ_dir_add_cat(categ_dir_t *, category_t *);
  84 extern int categ_dir_get_categories(categ_dir_t *, service_id_t *, size_t,
  85     size_t *);
  86 extern category_t *category_new(const char *);
  87 extern int category_add_service(category_t *, loc_service_t *);
  88 extern void category_remove_service(svc_categ_t *);
  89 extern category_t *category_get(categ_dir_t *, catid_t);
  90 extern category_t *category_find_by_name(categ_dir_t *, const char *);
  91 extern int category_get_services(category_t *, service_id_t *, size_t,
  92     size_t *);
  93
  94
  95 #endif
  96
  97 /** @}
  98  */