messenger_api_list_tunnels.h File Reference

#include "gnunet_messenger_service.h"
#include "gnunet_util_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, const struct GNUNET_HashCode *hash)
	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...
struct GNUNET_MESSENGER_ListTunnel *	find_list_tunnels_alternate (struct GNUNET_MESSENGER_ListTunnels *tunnels, const struct GNUNET_PeerIdentity *peer)
	Searches linearly through the list of tunnels peer identities for matching against a specific peer identity and returns an element of the list which does not match it. More...
enum GNUNET_GenericReturnValue	verify_list_tunnels_flag_token (const struct GNUNET_MESSENGER_ListTunnels *tunnels, const struct GNUNET_PeerIdentity *peer, enum GNUNET_MESSENGER_ConnectionFlags flag)
	Verifies that a specific tunnel selected by its peer identity in a list of tunnels is the first in order with a given connection flag. More...
void	update_to_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_HashCode *hash)
	Updates a specific peer from a tunnel in the list. More...
enum GNUNET_GenericReturnValue	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...
void	load_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, const char *path)
	Loads the list of tunnels peer identities from a file under a given path. More...
void	save_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels, const char *path)
	Saves the list of tunnels peer identities to a file under a given path. More...

Function Documentation

init_list_tunnels()

void init_list_tunnels

(

struct GNUNET_MESSENGER_ListTunnels *

tunnels

)

Initializes list of tunnels peer identities as empty list.

Parameters

[out]

tunnels

List of tunnels

Definition at line 29 of file messenger_api_list_tunnels.c.

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

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

Referenced by create_room(), and create_srv_room().

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

[in,out]

tunnels

List of tunnels

Definition at line 39 of file messenger_api_list_tunnels.c.

{
  struct GNUNET_MESSENGER_ListTunnel *element;
 
  GNUNET_assert (tunnels);
 
  element = tunnels->head;
  while (element)
    element = remove_from_list_tunnels (tunnels, element);
 
  tunnels->head = NULL;
  tunnels->tail = NULL;
}

References GNUNET_assert, GNUNET_MESSENGER_ListTunnels::head, remove_from_list_tunnels(), and GNUNET_MESSENGER_ListTunnels::tail.

Referenced by callback_leave_message_sent(), destroy_room(), and destroy_srv_room().

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,
		const struct GNUNET_HashCode *	hash
	)

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

Optionally adds the hash of the peer message from the specific peer.

Parameters

[in,out]	tunnels	List of tunnels
[in]	peer	Peer identity of tunnel
[in]	hash	Hash of peer message or NULL

Definition at line 71 of file messenger_api_list_tunnels.c.

{
  struct GNUNET_MESSENGER_ListTunnel *element;
 
  GNUNET_assert ((tunnels) && (peer));
 
  element = GNUNET_new (struct GNUNET_MESSENGER_ListTunnel);
 
  element->peer = GNUNET_PEER_intern (peer);
  element->hash = hash ? GNUNET_memdup (hash, sizeof (struct GNUNET_HashCode)) :
                  NULL;
 
  memset (&(element->connection), 0, sizeof (element->connection));
 
  GNUNET_CONTAINER_DLL_insert_sorted (struct GNUNET_MESSENGER_ListTunnel,
                                      compare_list_tunnels, NULL, tunnels->head,
                                      tunnels->tail, element);
}

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

Referenced by entry_handle_room_at(), handle_message_peer(), and load_list_tunnels().

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 overridden 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

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

Returns

Element in the list with matching peer identity

Definition at line 94 of file messenger_api_list_tunnels.c.

{
  struct GNUNET_MESSENGER_ListTunnel *element;
  struct GNUNET_PeerIdentity pid;
 
  GNUNET_assert ((tunnels) && (peer));
 
  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;
}

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

Referenced by contains_list_tunnels(), handle_message_connection(), handle_message_miss(), handle_miss_message(), rebuild_srv_room_basement_structure(), and update_to_list_tunnels().

Here is the call graph for this function:

Here is the caller graph for this function:

find_list_tunnels_alternate()

struct GNUNET_MESSENGER_ListTunnel * find_list_tunnels_alternate	(	struct GNUNET_MESSENGER_ListTunnels *	tunnels,
		const struct GNUNET_PeerIdentity *	peer
	)

Searches linearly through the list of tunnels peer identities for matching against a specific peer identity and returns an element of the list which does not match it.

Parameters

[in,out]	tunnels	List of tunnels
[in]	peer	Peer identity of tunnel

Returns

Element in the list with unmatching peer identity

Definition at line 122 of file messenger_api_list_tunnels.c.

{
  struct GNUNET_MESSENGER_ListTunnel *element;
  struct GNUNET_PeerIdentity pid;
 
  GNUNET_assert ((tunnels) && (peer));
 
  for (element = tunnels->head; element; element = element->next)
  {
    GNUNET_PEER_resolve (element->peer, &pid);
 
    if (0 != GNUNET_memcmp (&pid, peer))
      return element;
  }
 
  return NULL;
}

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

Referenced by callback_tunnel_disconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

verify_list_tunnels_flag_token()

enum GNUNET_GenericReturnValue verify_list_tunnels_flag_token	(	const struct GNUNET_MESSENGER_ListTunnels *	tunnels,
		const struct GNUNET_PeerIdentity *	peer,
		enum GNUNET_MESSENGER_ConnectionFlags	flag
	)

Verifies that a specific tunnel selected by its peer identity in a list of tunnels is the first in order with a given connection flag.

Parameters

[in]	tunnels	List of tunnels
[in]	peer	Peer identity of tunnel
[in]	flag	Connection flag mask

Returns

GNUNET_OK on success, otherwise GNUNET_SYSERR

Definition at line 143 of file messenger_api_list_tunnels.c.

{
  struct GNUNET_MESSENGER_ListTunnel *element;
  struct GNUNET_PeerIdentity pid;
 
  GNUNET_assert ((tunnels) && (peer) && (flag));
 
  for (element = tunnels->head; element; element = element->next)
  {
    if ((element->connection.flags & flag) != flag)
      continue;
 
    GNUNET_PEER_resolve (element->peer, &pid);
 
    if (0 == GNUNET_memcmp (&pid, peer))
      return GNUNET_OK;
  }
 
  return GNUNET_SYSERR;
}

References GNUNET_MESSENGER_ListTunnel::connection, GNUNET_MESSENGER_MessageConnection::flags, GNUNET_assert, GNUNET_memcmp, GNUNET_OK, GNUNET_PEER_resolve(), GNUNET_SYSERR, GNUNET_MESSENGER_ListTunnels::head, GNUNET_MESSENGER_ListTunnel::next, GNUNET_MESSENGER_ListTunnel::peer, and pid.

Referenced by rebuild_srv_room_basement_structure().

Here is the call graph for this function:

Here is the caller graph for this function:

update_to_list_tunnels()

void update_to_list_tunnels	(	struct GNUNET_MESSENGER_ListTunnels *	tunnels,
		const struct GNUNET_PeerIdentity *	peer,
		const struct GNUNET_HashCode *	hash
	)

Updates a specific peer from a tunnel in the list.

This function exists to add the hash of a newer peer message from the specific peer to the list element. It can also remove the hash when NULL is provided as new hash value.

Parameters

[in,out]	tunnels	List of tunnels
[in]	peer	Peer identity of tunnel
[in]	hash	Hash of peer message or NULL

Definition at line 169 of file messenger_api_list_tunnels.c.

{
  struct GNUNET_MESSENGER_ListTunnel *element;
 
  GNUNET_assert ((tunnels) && (peer));
 
  element = find_list_tunnels (tunnels, peer, NULL);
  if (! element)
    return;
 
  if (element->hash)
  {
    if (hash)
      GNUNET_memcpy (element->hash, hash, sizeof(struct GNUNET_HashCode));
    else
    {
      GNUNET_free (element->hash);
      element->hash = NULL;
    }
  }
  else if (hash)
    element->hash = GNUNET_memdup (hash, sizeof(struct GNUNET_HashCode));
}

References find_list_tunnels(), GNUNET_assert, GNUNET_free, GNUNET_memcpy, GNUNET_memdup, GNUNET_MESSENGER_ListTunnel::hash, and GNUNET_MESSENGER_ListTunnel::peer.

Referenced by recv_message_peer().

Here is the call graph for this function:

Here is the caller graph for this function:

contains_list_tunnels()

enum GNUNET_GenericReturnValue 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

[in,out]	tunnels	List of tunnels
[in]	peer	Peer identity of tunnel

Returns

GNUNET_YES on success, otherwise GNUNET_NO

Definition at line 197 of file messenger_api_list_tunnels.c.

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

References find_list_tunnels(), GNUNET_assert, GNUNET_NO, GNUNET_YES, and GNUNET_MESSENGER_ListTunnel::peer.

Referenced by callback_tunnel_disconnect(), handle_message_peer(), and recv_message_info().

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

[in,out]	tunnels	List of tunnels
[in,out]	element	Element of the list

Returns

Next element in the list

Definition at line 208 of file messenger_api_list_tunnels.c.

{
  struct GNUNET_MESSENGER_ListTunnel *next;
 
  GNUNET_assert ((tunnels) && (element));
 
  next = element->next;
 
  if ((tunnels->head) && (tunnels->tail))
    GNUNET_CONTAINER_DLL_remove (tunnels->head, tunnels->tail, element);
 
  if (element->hash)
    GNUNET_free (element->hash);
 
  GNUNET_PEER_change_rc (element->peer, -1);
  GNUNET_free (element);
  return next;
}

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

Referenced by clear_list_tunnels(), handle_message_miss(), handle_miss_message(), and rebuild_srv_room_basement_structure().

Here is the call graph for this function:

Here is the caller graph for this function:

load_list_tunnels()

void load_list_tunnels	(	struct GNUNET_MESSENGER_ListTunnels *	tunnels,
		const char *	path
	)

Loads the list of tunnels peer identities from a file under a given path.

Parameters

[out]	tunnels	List of tunnels
[in]	path	Path of file

Definition at line 230 of file messenger_api_list_tunnels.c.

{
  struct GNUNET_DISK_FileHandle *handle;
 
  GNUNET_assert ((tunnels) && (path));
 
  if (GNUNET_YES != GNUNET_DISK_file_test (path))
    return;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Load list of tunnels from path: %s\n",
              path);
 
  {
    enum GNUNET_DISK_AccessPermissions permission;
    
    permission = (GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE);
    handle = GNUNET_DISK_file_open (path, GNUNET_DISK_OPEN_READ, permission);
  }
 
  if (! handle)
    return;
 
  GNUNET_DISK_file_seek (handle, 0, GNUNET_DISK_SEEK_SET);
 
  {
    struct GNUNET_PeerIdentity peer;
    ssize_t len;
 
    do {
      len = GNUNET_DISK_file_read (handle, &peer, sizeof(peer));
 
      if (len != sizeof(peer))
        break;
 
      add_to_list_tunnels (tunnels, &peer, NULL);
    } while (len == sizeof(peer));
  }
 
  GNUNET_DISK_file_close (handle);
}

References add_to_list_tunnels(), GNUNET_assert, GNUNET_DISK_file_close(), GNUNET_DISK_file_open(), GNUNET_DISK_file_read(), GNUNET_DISK_file_seek(), GNUNET_DISK_file_test(), GNUNET_DISK_OPEN_READ, GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, GNUNET_DISK_SEEK_SET, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_YES, and handle.

Referenced by load_srv_room().

Here is the call graph for this function:

Here is the caller graph for this function:

save_list_tunnels()

void save_list_tunnels	(	struct GNUNET_MESSENGER_ListTunnels *	tunnels,
		const char *	path
	)

Saves the list of tunnels peer identities to a file under a given path.

Parameters

[in]	tunnels	List of tunnels
[in]	path	Path of file

Definition at line 274 of file messenger_api_list_tunnels.c.

{
  struct GNUNET_DISK_FileHandle *handle;
 
  GNUNET_assert ((tunnels) && (path));
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Save list of tunnels to path: %s\n",
              path);
 
  {
    enum GNUNET_DISK_AccessPermissions permission;
    
    permission = (GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE);
    handle = GNUNET_DISK_file_open (
      path, GNUNET_DISK_OPEN_CREATE | GNUNET_DISK_OPEN_WRITE, permission);
  }
 
  if (! handle)
    return;
 
  GNUNET_DISK_file_seek (handle, 0, GNUNET_DISK_SEEK_SET);
 
  {
    struct GNUNET_MESSENGER_ListTunnel *element;
    struct GNUNET_PeerIdentity pid;
 
    for (element = tunnels->head; element; element = element->next)
    {
      GNUNET_PEER_resolve (element->peer, &pid);
 
      GNUNET_DISK_file_write (handle, &pid, sizeof(pid));
    }
  }
 
  GNUNET_DISK_file_sync (handle);
  GNUNET_DISK_file_close (handle);
}

References GNUNET_assert, GNUNET_DISK_file_close(), GNUNET_DISK_file_open(), GNUNET_DISK_file_seek(), GNUNET_DISK_file_sync(), GNUNET_DISK_file_write(), GNUNET_DISK_OPEN_CREATE, GNUNET_DISK_OPEN_WRITE, GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, GNUNET_DISK_SEEK_SET, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_PEER_resolve(), handle, GNUNET_MESSENGER_ListTunnels::head, GNUNET_MESSENGER_ListTunnel::next, GNUNET_MESSENGER_ListTunnel::peer, and pid.

Referenced by save_srv_room().

Here is the call graph for this function:

Here is the caller graph for this function: