api_nilorea/n__user_8h_source.html

#ifndef N_USER_MANAGEMENT


#define N_USER_MANAGEMENT


#ifdef __cplusplus

extern "C"

{

#endif


#include "nilorea/n_common.h"

#include "nilorea/n_log.h"

#include "nilorea/n_str.h"

#include "nilorea/n_network.h"

#include "nilorea/n_3d.h"


#define USERLIST_ALL 0

#define USERLIST_ALL_EXCEPT 1

#define USERLIST_ONE 2


typedef struct N_USER

{

    char name[ 1024 ];


    NETWORK *netw;


    int state,

        nb_rec_pos,

        only_last_pos,

        id;


    VECTOR3D *last_positions;

    VECTOR3D position;


    LIST *netw_waitlist;


} N_USER ;


typedef struct N_USERLIST

{

    N_USER *list;


    int max,

        highter;


    pthread_rwlock_t user_rwbolt;


} N_USERLIST ;


N_USERLIST *userlist_new( int max );

int userlist_set_position_behavior( N_USERLIST *ulist, int id, int nb_rec_pos, int only_last_pos );

int userlist_add_user( N_USERLIST *ulist, NETWORK *netw );

int userlist_del_user( N_USERLIST *ulist, int id );

int userlist_add_msg_to_ex( N_USERLIST *ulist, N_STR *msg, int mode, int id );

int userlist_add_msg_to( N_USERLIST *ulist, N_STR *msg, int id );

int userlist_add_msg_to_all( N_USERLIST *ulist, N_STR *msg );

int userlist_add_msg_to_all_except( N_USERLIST *ulist, N_STR *msg, int id );

int userlist_destroy( N_USERLIST **ulist );

int userlist_user_add_waiting_msg( N_USERLIST *ulist, int id, N_STR *netmsg );

int userlist_user_send_waiting_msgs( N_USERLIST *ulist, int id );

int userlist_send_waiting_msgs( N_USERLIST *ulist );


#ifdef __cplusplus

}

#endif


#endif // header guard


LIST
Structure of a generic LIST container.
Definition: n_list.h:45

N_STR
A box including a string and his lenght.
Definition: n_str.h:173

N_USER::name
char name[1024]
User Name.
Definition: n_user.h:39

N_USER::last_positions
VECTOR3D * last_positions
Last nb_rec_pos position messages, for a better dead reckoning / lag simulation.
Definition: n_user.h:54

N_USER::only_last_pos
int only_last_pos
1 => keep only_last_position in waitlist , 0 => send all the positions, default: 1
Definition: n_user.h:49

N_USERLIST::max
int max
Maximum of user inside the list.
Definition: n_user.h:72

N_USER::netw_waitlist
LIST * netw_waitlist
N_STR *messages waiting to be sent.
Definition: n_user.h:59

N_USERLIST::user_rwbolt
pthread_rwlock_t user_rwbolt
Mutex for thread safe user management.
Definition: n_user.h:77

N_USER::state
int state
State of the current user.
Definition: n_user.h:45

N_USER::position
VECTOR3D position
actual position
Definition: n_user.h:56

N_USER::netw
NETWORK * netw
Associated NETWORK.
Definition: n_user.h:42

N_USERLIST::highter
int highter
Position of the highter user inside the list.
Definition: n_user.h:74

N_USER::id
int id
Unique world ident.
Definition: n_user.h:51

N_USER::nb_rec_pos
int nb_rec_pos
Number of saved positions , default: 10.
Definition: n_user.h:47

N_USERLIST::list
N_USER * list
Pointer to the allocated list of user.
Definition: n_user.h:69

userlist_del_user
int userlist_del_user(N_USERLIST *ulist, int id)
delete an user from the list
Definition: n_user.c:134

userlist_add_msg_to
int userlist_add_msg_to(N_USERLIST *ulist, N_STR *msg, int id)
add a N_STR *message to user list (USERLIST_ONE)
Definition: n_user.c:240

userlist_add_msg_to_ex
int userlist_add_msg_to_ex(N_USERLIST *ulist, N_STR *msg, int mode, int id)
add a N_STR *message to user list
Definition: n_user.c:191

userlist_user_send_waiting_msgs
int userlist_user_send_waiting_msgs(N_USERLIST *ulist, int id)
send all waiting messages in user 'id' waiting list
Definition: n_user.c:334

userlist_new
N_USERLIST * userlist_new(int max)
create a new N_USERLIST user list with 'max' users
Definition: n_user.c:16

userlist_add_msg_to_all
int userlist_add_msg_to_all(N_USERLIST *ulist, N_STR *msg)
add a N_STR *message to user list (USERLIST_ALL)
Definition: n_user.c:252

userlist_send_waiting_msgs
int userlist_send_waiting_msgs(N_USERLIST *ulist)
send all waiting messages ofr each user of the lsit
Definition: n_user.c:362

userlist_set_position_behavior
int userlist_set_position_behavior(N_USERLIST *ulist, int id, int nb_rec_pos, int only_last_pos)
set the position parameters for trajectory processing for user 'id'
Definition: n_user.c:57

userlist_add_user
int userlist_add_user(N_USERLIST *ulist, NETWORK *netw)
add an user to the list
Definition: n_user.c:101

userlist_add_msg_to_all_except
int userlist_add_msg_to_all_except(N_USERLIST *ulist, N_STR *msg, int id)
add a N_STR *message to user list except user 'id' (USERLIST_ALL_EXCEPT)
Definition: n_user.c:266

userlist_destroy
int userlist_destroy(N_USERLIST **ulist)
destroy and free a N_USERLIST *userlist
Definition: n_user.c:278

userlist_user_add_waiting_msg
int userlist_user_add_waiting_msg(N_USERLIST *ulist, int id, N_STR *netmsg)
add a newtork message to specified user 'id'
Definition: n_user.c:306

N_USER
USER management cell.
Definition: n_user.h:37

N_USERLIST
USER list.
Definition: n_user.h:67

NETWORK
Structure of a NETWORK.
Definition: n_network.h:252

VECTOR3D
double VECTOR3D[3]
struct of a point
Definition: n_3d.h:39

n_3d.h
Simple 3D movement simulation.

n_common.h
Common headers and low-level hugly functions & define.

n_log.h
Generic log system.

n_network.h
Network Engine.

n_str.h
N_STR and string function declaration.