gnunet-service-messenger_list_handles.h File Reference

#include "gnunet_common.h"

Include dependency graph for gnunet-service-messenger_list_handles.h:

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

Go to the source code of this file.

Data Structures
struct	GNUNET_MESSENGER_ListHandle
struct	GNUNET_MESSENGER_ListHandles

Functions
void	init_list_handles (struct GNUNET_MESSENGER_ListHandles *handles)
	Initializes list of handles as empty list. More...
void	clear_list_handles (struct GNUNET_MESSENGER_ListHandles *handles)
	Destroys remaining handles and clears the list. More...
void	add_list_handle (struct GNUNET_MESSENGER_ListHandles *handles, struct GNUNET_MESSENGER_SrvHandle *handle)
	Adds a specific handle to the end of the list. More...
enum GNUNET_GenericReturnValue	remove_list_handle (struct GNUNET_MESSENGER_ListHandles *handles, struct GNUNET_MESSENGER_SrvHandle *handle)
	Removes the first entry matching with a specific handle from the list of handles and returns GNUNET_YES on success or GNUNET_NO on failure. More...
struct GNUNET_MESSENGER_SrvHandle *	find_list_handle_by_member (const struct GNUNET_MESSENGER_ListHandles *handles, const struct GNUNET_HashCode *key)
	Searches linearly through the list of handles for members of a specific room which is identified by a given key. More...

Function Documentation

init_list_handles()

void init_list_handles

(

struct GNUNET_MESSENGER_ListHandles *

handles

)

Initializes list of handles as empty list.

Parameters

[out]

handles

List of handles

Definition at line 31 of file gnunet-service-messenger_list_handles.c.

{
  GNUNET_assert (handles);
 
  handles->head = NULL;
  handles->tail = NULL;
}

References GNUNET_assert, GNUNET_MESSENGER_ListHandles::head, and GNUNET_MESSENGER_ListHandles::tail.

Referenced by create_service().

Here is the caller graph for this function:

clear_list_handles()

void clear_list_handles

(

struct GNUNET_MESSENGER_ListHandles *

handles

)

Destroys remaining handles and clears the list.

Parameters

[in,out]

handles

List of handles

Definition at line 41 of file gnunet-service-messenger_list_handles.c.

{
  GNUNET_assert (handles);
 
  while (handles->head)
  {
    struct GNUNET_MESSENGER_ListHandle *element = handles->head;
 
    GNUNET_CONTAINER_DLL_remove (handles->head, handles->tail, element);
    destroy_srv_handle (element->handle);
    GNUNET_free (element);
  }
 
  handles->head = NULL;
  handles->tail = NULL;
}

References destroy_srv_handle(), GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_MESSENGER_ListHandle::handle, GNUNET_MESSENGER_ListHandles::head, and GNUNET_MESSENGER_ListHandles::tail.

Referenced by destroy_service().

Here is the call graph for this function:

Here is the caller graph for this function:

add_list_handle()

void add_list_handle	(	struct GNUNET_MESSENGER_ListHandles *	handles,
		struct GNUNET_MESSENGER_SrvHandle *	handle
	)

Adds a specific handle to the end of the list.

Parameters

[in,out]	handles	List of handles
[in,out]	handle	Handle

Definition at line 60 of file gnunet-service-messenger_list_handles.c.

{
  struct GNUNET_MESSENGER_ListHandle *element;
 
  GNUNET_assert ((handles) && (handle));
 
  element = GNUNET_new (struct GNUNET_MESSENGER_ListHandle);
  element->handle = handle;
 
  GNUNET_CONTAINER_DLL_insert_tail (handles->head, handles->tail, element);
}

References GNUNET_assert, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_new, handle, GNUNET_MESSENGER_ListHandle::handle, GNUNET_MESSENGER_ListHandles::head, and GNUNET_MESSENGER_ListHandles::tail.

Referenced by add_service_handle().

Here is the caller graph for this function:

remove_list_handle()

enum GNUNET_GenericReturnValue remove_list_handle	(	struct GNUNET_MESSENGER_ListHandles *	handles,
		struct GNUNET_MESSENGER_SrvHandle *	handle
	)

Removes the first entry matching with a specific handle from the list of handles and returns GNUNET_YES on success or GNUNET_NO on failure.

Parameters

[in,out]	handles	List of handles
[in,out]	handle	Handle

Returns

GNUNET_YES on success, otherwise GNUNET_NO

Definition at line 75 of file gnunet-service-messenger_list_handles.c.

{
  struct GNUNET_MESSENGER_ListHandle *element;
 
  GNUNET_assert ((handles) && (handle));
 
  for (element = handles->head; element; element = element->next)
    if (element->handle == handle)
      break;
 
  if (! element)
    return GNUNET_NO;
 
  GNUNET_CONTAINER_DLL_remove (handles->head, handles->tail, element);
  GNUNET_free (element);
 
  return GNUNET_YES;
}

References GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_NO, GNUNET_YES, handle, GNUNET_MESSENGER_ListHandle::handle, GNUNET_MESSENGER_ListHandles::head, GNUNET_MESSENGER_ListHandle::next, and GNUNET_MESSENGER_ListHandles::tail.

Referenced by remove_service_handle().

Here is the caller graph for this function:

find_list_handle_by_member()

struct GNUNET_MESSENGER_SrvHandle * find_list_handle_by_member	(	const struct GNUNET_MESSENGER_ListHandles *	handles,
		const struct GNUNET_HashCode *	key
	)

Searches linearly through the list of handles for members of a specific room which is identified by a given key.

The handle returned will be one that has enabled routing for the room if possible.

If no handle is found which is a current member, NULL gets returned.

Parameters

[in]	handles	List of handles
[in]	key	Common key of a room

Returns

A handle which is a current member

Definition at line 97 of file gnunet-service-messenger_list_handles.c.

{
  struct GNUNET_MESSENGER_ListHandle *element;
  struct GNUNET_MESSENGER_SrvHandle *handle;
 
  GNUNET_assert ((handles) && (key));
 
  handle = NULL;
 
  for (element = handles->head; element; element = element->next)
  {
    if (get_srv_handle_member_id ((struct
                                   GNUNET_MESSENGER_SrvHandle *) element->handle,
                                  key))
      handle = (struct GNUNET_MESSENGER_SrvHandle *) element->handle;
 
    if ((handle) && (GNUNET_YES == is_srv_handle_routing (handle, key)))
      break;
  }
 
  return handle;
}

References get_srv_handle_member_id(), GNUNET_assert, GNUNET_YES, handle, GNUNET_MESSENGER_ListHandle::handle, GNUNET_MESSENGER_ListHandles::head, is_srv_handle_routing(), key, and GNUNET_MESSENGER_ListHandle::next.

Referenced by close_service_room().

Here is the call graph for this function:

Here is the caller graph for this function: