messenger_api_list_tunnels.h File Reference

messenger api: client and service implementation of GNUnet MESSENGER service More...

#include "platform.h"
#include "gnunet_peer_lib.h"
#include "gnunet_container_lib.h"

Include dependency graph for messenger_api_list_tunnels.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_ListTunnel
struct	GNUNET_MESSENGER_ListTunnels

Functions
void	init_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels)
	Initializes list of tunnels peer identities as empty list. More...
void	clear_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels)
	Clears the list of tunnels peer identities. More...
void	add_to_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, const struct GNUNET_PeerIdentity *peer)
	Adds a specific peer from a tunnel to the end of the list. More...
struct GNUNET_MESSENGER_ListTunnel *	find_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, const struct GNUNET_PeerIdentity *peer, size_t *index)
	Searches linearly through the list of tunnels peer identities for matching a specific peer identity and returns the matching element of the list. More...
int	contains_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, const struct GNUNET_PeerIdentity *peer)
	Tests linearly if the list of tunnels peer identities contains a specific peer identity and returns GNUNET_YES on success, otherwise GNUNET_NO. More...
struct GNUNET_MESSENGER_ListTunnel *	remove_from_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, struct GNUNET_MESSENGER_ListTunnel *element)
	Removes a specific element from the list of tunnels peer identities and returns the next element in the list. More...

Detailed Description

messenger api: client and service implementation of GNUnet MESSENGER service

Author

Tobias Frisch

Definition in file messenger_api_list_tunnels.h.

Function Documentation

init_list_tunnels()

void init_list_tunnels

(

struct GNUNET_MESSENGER_ListTunnels *

tunnels

)

Initializes list of tunnels peer identities as empty list.

Parameters

tunnels

List of peer identities

Definition at line 29 of file messenger_api_list_tunnels.c.

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

Referenced by create_room().

{
  GNUNET_assert(tunnels);

  tunnels->head = NULL;
  tunnels->tail = NULL;
}

Here is the caller graph for this function:

clear_list_tunnels()

void clear_list_tunnels

(

struct GNUNET_MESSENGER_ListTunnels *

tunnels

)

Clears the list of tunnels peer identities.

Parameters

tunnels

List of peer identities

Definition at line 38 of file messenger_api_list_tunnels.c.

References GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_PEER_change_rc(), GNUNET_MESSENGER_ListTunnels::head, GNUNET_MESSENGER_ListTunnel::peer, and GNUNET_MESSENGER_ListTunnels::tail.

Referenced by destroy_room().

{
  GNUNET_assert(tunnels);

  struct GNUNET_MESSENGER_ListTunnel *element;

  for (element = tunnels->head; element; element = tunnels->head)
  {
    GNUNET_CONTAINER_DLL_remove(tunnels->head, tunnels->tail, element);
    GNUNET_PEER_change_rc (element->peer, -1);
    GNUNET_free(element);
  }

  tunnels->head = NULL;
  tunnels->tail = NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

add_to_list_tunnels()

void add_to_list_tunnels	(	struct GNUNET_MESSENGER_ListTunnels *	tunnels,
		const struct GNUNET_PeerIdentity *	peer
	)

Adds a specific peer from a tunnel to the end of the list.

Parameters

tunnels	List of peer identities
peer	Peer identity of tunnel

Definition at line 63 of file messenger_api_list_tunnels.c.

References compare_list_tunnels(), GNUNET_CONTAINER_DLL_insert_sorted, GNUNET_new, GNUNET_PEER_intern(), GNUNET_MESSENGER_ListTunnels::head, GNUNET_MESSENGER_ListTunnel::peer, and GNUNET_MESSENGER_ListTunnels::tail.

Referenced by entry_handle_room_at(), and handle_message_peer().

{
  struct GNUNET_MESSENGER_ListTunnel *element = GNUNET_new(struct GNUNET_MESSENGER_ListTunnel);

  element->peer = GNUNET_PEER_intern (peer);

  GNUNET_CONTAINER_DLL_insert_sorted(struct GNUNET_MESSENGER_ListTunnel, compare_list_tunnels, NULL, tunnels->head,
                                     tunnels->tail, element);
}

Here is the call graph for this function:

Here is the caller graph for this function:

find_list_tunnels()

struct GNUNET_MESSENGER_ListTunnel* find_list_tunnels	(	struct GNUNET_MESSENGER_ListTunnels *	tunnels,
		const struct GNUNET_PeerIdentity *	peer,
		size_t *	index
	)

Searches linearly through the list of tunnels peer identities for matching a specific peer identity and returns the matching element of the list.

If no matching element is found, NULL gets returned.

If index is not NULL, index will be overriden with the numeric index of the found element in the list. If no matching element is found, index will contain the total amount of elements in the list.

Parameters

	tunnels	List of peer identities
	peer	Peer identity of tunnel
[out]	index	Index of found element (optional)

Returns

Element in the list with matching peer identity

Definition at line 74 of file messenger_api_list_tunnels.c.

References GNUNET_memcmp, GNUNET_PEER_resolve(), GNUNET_MESSENGER_ListTunnels::head, GNUNET_MESSENGER_ListTunnel::next, and GNUNET_MESSENGER_ListTunnel::peer.

Referenced by contains_list_tunnels(), handle_message_miss(), handle_miss_message(), and rebuild_room_basement_structure().

{
  struct GNUNET_MESSENGER_ListTunnel *element;
  struct GNUNET_PeerIdentity pid;

  if (index)
    *index = 0;

  for (element = tunnels->head; element; element = element->next)
  {
    GNUNET_PEER_resolve (element->peer, &pid);

    if (0 == GNUNET_memcmp(&pid, peer))
      return element;

    if (index)
      (*index) = (*index) + 1;
  }

  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

contains_list_tunnels()

int contains_list_tunnels	(	struct GNUNET_MESSENGER_ListTunnels *	tunnels,
		const struct GNUNET_PeerIdentity *	peer
	)

Tests linearly if the list of tunnels peer identities contains a specific peer identity and returns GNUNET_YES on success, otherwise GNUNET_NO.

Parameters

tunnels	List of peer identities
peer	Peer identity of tunnel

Returns

GNUNET_YES on success, otherwise GNUNET_NO

Definition at line 97 of file messenger_api_list_tunnels.c.

References find_list_tunnels(), GNUNET_NO, and GNUNET_YES.

Referenced by callback_room_disconnect(), and handle_message_peer().

{
  return find_list_tunnels (tunnels, peer, NULL) != NULL ? GNUNET_YES : GNUNET_NO;
}

Here is the call graph for this function:

Here is the caller graph for this function:

remove_from_list_tunnels()

struct GNUNET_MESSENGER_ListTunnel* remove_from_list_tunnels	(	struct GNUNET_MESSENGER_ListTunnels *	tunnels,
		struct GNUNET_MESSENGER_ListTunnel *	element
	)

Removes a specific element from the list of tunnels peer identities and returns the next element in the list.

Parameters

tunnels	List of peer identities
element	Element of the list

Returns

Next element in the list

Definition at line 103 of file messenger_api_list_tunnels.c.

References GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_PEER_change_rc(), GNUNET_MESSENGER_ListTunnels::head, GNUNET_MESSENGER_ListTunnel::next, GNUNET_MESSENGER_ListTunnel::peer, and GNUNET_MESSENGER_ListTunnels::tail.

Referenced by handle_message_miss(), handle_miss_message(), and rebuild_room_basement_structure().

{
  struct GNUNET_MESSENGER_ListTunnel *next = element->next;

  GNUNET_CONTAINER_DLL_remove(tunnels->head, tunnels->tail, element);
  GNUNET_PEER_change_rc (element->peer, -1);
  GNUNET_free(element);

  return next;
}

Here is the call graph for this function:

Here is the caller graph for this function: