modules_k/usrloc/usrloc.h

Go to the documentation of this file.

/*
 * $Id$
 *
 * Copyright (C) 2001-2003 FhG Fokus
 *
 * This file is part of Kamailio, a free SIP server.
 *
 * Kamailio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version
 *
 * Kamailio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef USRLOC_H
#define USRLOC_H

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

#define NO_DB         0
#define WRITE_THROUGH 1
#define WRITE_BACK    2
#define DB_ONLY       3

/*forward declaration necessary for udomain*/

struct udomain;
typedef struct udomain udomain_t;

typedef enum cstate {
        CS_NEW,        
        CS_SYNC,       
        CS_DIRTY       
} cstate_t;


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

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

struct hslot; 
struct socket_info;
typedef struct ucontact {
        str* domain;            
        str ruid;               
        str* aor;               
        str c;                  
        str received;           
        str path;               
        time_t expires;         
        qvalue_t q;             
        str callid;             
        int cseq;               
        cstate_t state;         
        unsigned int flags;     
        unsigned int cflags;    
        str user_agent;         
        struct socket_info *sock; 
        time_t last_modified;   
        unsigned int methods;   
        str instance;           
        unsigned int reg_id;    
        struct ucontact* next;  
        struct ucontact* prev;  
} ucontact_t;


typedef struct ucontact_info {
        str ruid;                 
        str received;             
        str* path;                
        time_t expires;           
        qvalue_t q;               
        str* callid;              
        int cseq;                 
        unsigned int flags;       
        unsigned int cflags;      
        str *user_agent;          
        struct socket_info *sock; 
        unsigned int methods;     
        str instance;             
        unsigned int reg_id;      
        time_t last_modified;     
} ucontact_info_t;

typedef struct udomain_head{
    str* name;
} udomain_head_t;

typedef struct urecord {
        str* domain;                   
        str aor;                       
        unsigned int aorhash;          
        ucontact_t* contacts;          
        struct hslot* slot;            
        struct urecord* prev;          
        struct urecord* next;          
} urecord_t;

typedef int (*insert_urecord_t)(struct udomain* _d, str* _aor, struct urecord** _r);

typedef int (*get_urecord_t)(struct udomain* _d, str* _aor, struct urecord** _r);

typedef int (*get_urecord_by_ruid_t)(udomain_t* _d, unsigned int _aorhash,
                str *_ruid, struct urecord** _r, struct ucontact** _c);

typedef int  (*delete_urecord_t)(struct udomain* _d, str* _aor, struct urecord* _r);

typedef int (*update_ucontact_t)(struct urecord* _r, struct ucontact* _c,
                struct ucontact_info* _ci);
typedef void (*release_urecord_t)(struct urecord* _r);

typedef int (*insert_ucontact_t)(struct urecord* _r, str* _contact,
                struct ucontact_info* _ci, struct ucontact** _c);

typedef int (*delete_ucontact_t)(struct urecord* _r, struct ucontact* _c);

typedef int (*get_ucontact_t)(struct urecord* _r, str* _c, str* _callid,
                str* _path, int _cseq,
                struct ucontact** _co);

typedef int (*get_ucontact_by_instance_t)(struct urecord* _r, str* _c,
                ucontact_info_t* _ci, ucontact_t** _co);

typedef void (*lock_udomain_t)(struct udomain* _d, str *_aor);

typedef void (*unlock_udomain_t)(struct udomain* _d, str *_aor);

typedef int (*register_udomain_t)(const char* _n, struct udomain** _d);

typedef int  (*get_all_ucontacts_t) (void* buf, int len, unsigned int flags,
                unsigned int part_idx, unsigned int part_max);

typedef int (*get_udomain_t)(const char* _n, udomain_t** _d);

typedef unsigned int (*ul_get_aorhash_t)(str *_aor);
unsigned int ul_get_aorhash(str *_aor);

typedef struct usrloc_api {
        int           use_domain; 
        int           db_mode;    
        unsigned int  nat_flag;   
        register_udomain_t   register_udomain;
        get_udomain_t        get_udomain;
        get_all_ucontacts_t  get_all_ucontacts;

        insert_urecord_t     insert_urecord;
        delete_urecord_t     delete_urecord;
        get_urecord_t        get_urecord;
        lock_udomain_t       lock_udomain;
        unlock_udomain_t     unlock_udomain;

        release_urecord_t    release_urecord;
        insert_ucontact_t    insert_ucontact;
        delete_ucontact_t    delete_ucontact;
        get_ucontact_t       get_ucontact;

        get_urecord_by_ruid_t       get_urecord_by_ruid;
        get_ucontact_by_instance_t  get_ucontact_by_instance;

        update_ucontact_t    update_ucontact;

        register_ulcb_t      register_ulcb;
        ul_get_aorhash_t     get_aorhash;
} usrloc_api_t;


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

#endif