103 lines
3.2 KiB
C
103 lines
3.2 KiB
C
/*
|
|
* uhub - A tiny ADC p2p connection hub
|
|
* Copyright (C) 2007-2009, Jan Vidar Krey
|
|
*
|
|
* This program 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 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
#ifndef HAVE_UHUB_USER_MANAGER_H
|
|
#define HAVE_UHUB_USER_MANAGER_H
|
|
|
|
struct user_manager
|
|
{
|
|
size_t count; /**<< "Number of all fully connected and logged in users" */
|
|
size_t count_peak; /**<< "Peak number of users" */
|
|
sid_t free_sid; /**<< "The next available SID." */
|
|
uint64_t shared_size; /**<< "The total number of shared bytes among fully connected users." */
|
|
uint64_t shared_files; /**<< "The total number of shared files among fully connected users." */
|
|
struct linked_list* list; /**<< "Contains all users" */
|
|
};
|
|
|
|
/**
|
|
* Initializes the user manager.
|
|
* @return 0 on success, or -1 if error (out of memory).
|
|
*/
|
|
extern int user_manager_init(struct hub_info* hub);
|
|
|
|
/**
|
|
* Shuts down the user manager.
|
|
* All users will be disconnected and deleted as part of this.
|
|
*/
|
|
extern void user_manager_shutdown(struct hub_info* hub);
|
|
|
|
/**
|
|
* Generate statistics for logfiles.
|
|
*/
|
|
extern void user_manager_update_stats(struct hub_info* hub);
|
|
extern void user_manager_print_stats(struct hub_info* hub);
|
|
|
|
/**
|
|
* Add a new user to the user manager.
|
|
*/
|
|
extern void user_manager_add(struct user* user);
|
|
|
|
/**
|
|
* Remove a user from the user manager.
|
|
* This user is connected, and will be moved to the leaving queue, pending
|
|
* all messages in the message queue, and resource cleanup.
|
|
*/
|
|
extern void user_manager_remove(struct user* user);
|
|
|
|
/**
|
|
* Returns a free sid for a new user.
|
|
*/
|
|
extern sid_t user_manager_get_free_sid(struct hub_info* hub);
|
|
|
|
/**
|
|
* Lookup a user based on the session ID (sid).
|
|
* NOTE: This will only search connected users.
|
|
* @return a user if found, or NULL if not found
|
|
*/
|
|
extern struct user* get_user_by_sid(struct hub_info* hub, sid_t sid);
|
|
|
|
/**
|
|
* Lookup a user based on the client ID (cid).
|
|
* @return a user if found, or NULL if not found
|
|
*/
|
|
extern struct user* get_user_by_cid(struct hub_info* hub, const char* cid);
|
|
|
|
/**
|
|
* Lookup a user based on the nick name.
|
|
* @return a user if found, or NULL if not found
|
|
*/
|
|
extern struct user* get_user_by_nick(struct hub_info* hub, const char* nick);
|
|
|
|
/**
|
|
* Send the user list of connected clients to 'user'.
|
|
* Usually part of the login process.
|
|
*
|
|
* @return 1 if sending the user list succeeded, 0 otherwise.
|
|
*/
|
|
extern int send_user_list(struct user* user);
|
|
|
|
/**
|
|
* Send a quit message to all connected users when 'user' is
|
|
* leaving the hub (for whatever reason).
|
|
*/
|
|
extern void send_quit_message(struct user* user);
|
|
|
|
|
|
#endif /* HAVE_UHUB_USER_MANAGER_H */
|