modules_k/usrloc/usrloc.h File Reference

USRLOC - module API exports interface. More...

#include <time.h>
#include "ul_callback.h"
#include "../../qvalue.h"
#include "../../str.h"
#include "ul_callback.h"

Include dependency graph for modules_k/usrloc/usrloc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

• struct ucontact

  Main structure for handling of registered Contact data. More...
  

• struct ucontact_info

  Informations related to a contact. More...
  

• struct urecord

  Basic hash table element. More...
  

• struct usrloc_api

  usrloc API export structure More...
  

Defines

• #define VALID_CONTACT(c, t)   ((c->expires>t) || (c->expires==0))

  Valid contact is a contact that either didn't expire yet or is permanent.
  

Typedefs

• typedef int(* bind_usrloc_t )(usrloc_api_t *api)

  usrloc API export bind function
  

• typedef enum cstate cstate_t

  States for in-memory contacts in regards to contact storage handler (db, in-memory, ldap etc).
  

• typedef enum flags flags_t

  Flags that can be associated with a Contact.
  

• typedef struct ucontact_info ucontact_info_t

  Informations related to a contact.
  

• typedef struct ucontact ucontact_t

  Main structure for handling of registered Contact data.
  

• typedef struct urecord urecord_t

  Basic hash table element.
  

• typedef struct usrloc_api usrloc_api_t

  usrloc API export structure
  

Enumerations

• enum cstate { CS_NEW, CS_SYNC, CS_DIRTY }

  States for in-memory contacts in regards to contact storage handler (db, in-memory, ldap etc).

  More...
  

• enum flags { FL_NONE = 0, FL_MEM = 1 << 0, FL_ALL = (int)0xFFFFFFFF }

  Flags that can be associated with a Contact.

  More...
  

---

Detailed Description

Definition in file modules_k/usrloc/usrloc.h.

---

Enumeration Type Documentation

enum cstate

Enumerator:

CS_NEW	New contact - not flushed yet.
CS_SYNC	Synchronized contact with the database.
CS_DIRTY	Update contact - not flushed yet.

Definition at line 49 of file modules_k/usrloc/usrloc.h.

enum flags

Enumerator:

FL_NONE	No flags set.
FL_MEM	Update memory only.
FL_ALL	All flags set.

Definition at line 57 of file modules_k/usrloc/usrloc.h.