modules_k/p_usrloc/dlist.h File Reference

USRLOC - List of registered domains. More...

#include <stdio.h>
#include "udomain.h"
#include "../../str.h"
#include "../usrloc/usrloc.h"
#include "udomain.h"

Include dependency graph for modules_k/p_usrloc/dlist.h:

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

Go to the source code of this file.

Data Structures

• struct domain_list_item

  List of all domains registered with usrloc. More...
  

Functions

• int find_domain (str *_d, udomain_t **_p)

  Find a particular domain, small wrapper around find_dlist.
  

• void free_all_udomains (void)

  Free all allocated memory for domains.
  

• int get_all_ucontacts (void *, int, unsigned int, unsigned int part_idx, unsigned int part_max)

  Get all contacts from the usrloc, in partitions if wanted.
  

• unsigned long get_number_of_users (void)

  Loops through all domains summing up the number of users.
  

• int register_udomain (const char *_n, udomain_t **_d)

  Registers a new domain with usrloc.
  

• int synchronize_all_udomains (void)

  Run timer handler of all domains.
  

---

Detailed Description

Definition in file modules_k/p_usrloc/dlist.h.

---

Function Documentation

int find_domain	(	str *	_d,
		udomain_t **	_p
	)

Parameters:

	_d	domain name
	_p	pointer to domain if found

Returns:

1 if domain was found, 0 otherwise

Definition at line 633 of file modules_k/usrloc/dlist.c.

int get_all_ucontacts	(	void *	buf,
		int	len,
		unsigned int	flags,
		unsigned int	part_idx,
		unsigned int	part_max
	)

Return list of all contacts for all currently registered users in all domains. The caller must provide buffer of sufficient length for fitting all those contacts. In the case when buffer was exhausted, the function returns estimated amount of additional space needed, in this case the caller is expected to repeat the call using this value as the hint.

Information is packed into the buffer as follows:

+------------+----------+-----+------+-----+ |contact1.len|contact1.s|sock1|flags1|path1| +------------+----------+-----+------+-----+ |contact2.len|contact2.s|sock2|flags2|path1| +------------+----------+-----+------+-----+ |..........................................| +------------+----------+-----+------+-----+ |contactN.len|contactN.s|sockN|flagsN|pathN| +------------+----------+-----+------+-----+ |000000000000| +------------+

Parameters:

	buf	target buffer
	len	length of buffer
	flags	contact flags
	part_idx	part index
	part_max	maximal part

Returns:

0 on success, positive if buffer size was not sufficient, negative on failure

Definition at line 162 of file modules_k/p_usrloc/dlist.c.

unsigned long get_number_of_users

(

void

)

Returns:

the number of users, could be zero

Definition at line 154 of file modules_k/p_usrloc/dlist.c.

int register_udomain	(	const char *	_n,
		udomain_t **	_d
	)

Registers a new domain with usrloc. If the domain exists, a pointer to existing structure will be returned, otherwise a new domain will be created

Parameters:

	_n	domain name
	_d	new created domain

Returns:

0 on success, -1 on failure

Definition at line 124 of file modules_k/p_usrloc/dlist.c.

int synchronize_all_udomains

(

void

)

Returns:

0 if all timer return 0, != 0 otherwise

Definition at line 172 of file modules_k/p_usrloc/dlist.c.