gnunet-service-messenger_tunnel.h File Reference

GNUnet MESSENGER service. More...

#include "platform.h"
#include "gnunet_cadet_service.h"
#include "gnunet_peer_lib.h"
#include "gnunet_crypto_lib.h"
#include "gnunet-service-messenger_room.h"

Include dependency graph for gnunet-service-messenger_tunnel.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_SrvTunnel

Functions
struct GNUNET_MESSENGER_SrvTunnel *	create_tunnel (struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_PeerIdentity *door)
	Creates and allocates a tunnel of a room to a specific peer identity. More...
void	destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel)
	Destroys a tunnel and frees its memory fully. More...
int	bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel, struct GNUNET_CADET_Channel *channel)
	Binds a CADET channel to a tunnel on returns GNUNET_YES only if the bounds channel was replaced successfully, otherwise GNUNET_NO gets returned. More...
int	connect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel)
	Tries to connect a tunnel by creating a new CADET channel and binding it. More...
void	disconnect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel)
	Disconnects and unbinds a channel from a tunnel. More...
int	is_tunnel_connected (const struct GNUNET_MESSENGER_SrvTunnel *tunnel)
	Returns the status of a currently bound channel of a tunnel. More...
void	send_tunnel_envelope (struct GNUNET_MESSENGER_SrvTunnel *tunnel, void *handle, struct GNUNET_MQ_Envelope *env, struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
	Sends an envelope containing a message with a given hash through a tunnel by a given handle. More...
void	send_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel, void *handle, struct GNUNET_MESSENGER_Message *message, struct GNUNET_HashCode *hash)
	Sends a message by packing it automatically into an envelope and passing it through the tunnel. More...
void	forward_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel *tunnel, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
	Forwards a given message with a known hash through a tunnel. More...
const struct GNUNET_HashCode *	get_tunnel_peer_message (const struct GNUNET_MESSENGER_SrvTunnel *tunnel)
	Returns the hash of the latest peer message published through a given tunnel and matching the tunnels peer identity. More...

Detailed Description

GNUnet MESSENGER service.

Author

Tobias Frisch

Definition in file gnunet-service-messenger_tunnel.h.

Function Documentation

create_tunnel()

struct GNUNET_MESSENGER_SrvTunnel* create_tunnel	(	struct GNUNET_MESSENGER_SrvRoom *	room,
		const struct GNUNET_PeerIdentity *	door
	)

Creates and allocates a tunnel of a room to a specific peer identity.

Parameters

room	Room
door	Peer identity

Returns

New tunnel

Definition at line 32 of file gnunet-service-messenger_tunnel.c.

References GNUNET_MESSENGER_SrvTunnel::channel, GNUNET_MESSENGER_SrvTunnel::contact_id, GNUNET_assert, GNUNET_new, GNUNET_PEER_intern(), GNUNET_MESSENGER_SrvTunnel::last_message, GNUNET_MESSENGER_SrvTunnel::peer, GNUNET_MESSENGER_SrvTunnel::peer_message, and GNUNET_MESSENGER_SrvTunnel::room.

Referenced by callback_room_connect(), and entry_room_at().

{
  GNUNET_assert((room) && (door));

  struct GNUNET_MESSENGER_SrvTunnel *tunnel = GNUNET_new(struct GNUNET_MESSENGER_SrvTunnel);

  tunnel->room = room;
  tunnel->channel = NULL;

  tunnel->peer = GNUNET_PEER_intern (door);
  tunnel->contact_id = NULL;

  tunnel->peer_message = NULL;
  tunnel->last_message = NULL;

  return tunnel;
}

Here is the call graph for this function:

Here is the caller graph for this function:

destroy_tunnel()

void destroy_tunnel

(

struct GNUNET_MESSENGER_SrvTunnel *

tunnel

)

Destroys a tunnel and frees its memory fully.

Parameters

tunnel

Definition at line 51 of file gnunet-service-messenger_tunnel.c.

References GNUNET_MESSENGER_SrvTunnel::channel, GNUNET_MESSENGER_SrvTunnel::contact_id, GNUNET_assert, GNUNET_CADET_channel_destroy(), GNUNET_free, GNUNET_PEER_change_rc(), GNUNET_MESSENGER_SrvTunnel::last_message, GNUNET_MESSENGER_SrvTunnel::peer, and GNUNET_MESSENGER_SrvTunnel::peer_message.

{
  GNUNET_assert(tunnel);

  if (tunnel->channel)
    GNUNET_CADET_channel_destroy (tunnel->channel);

  GNUNET_PEER_change_rc (tunnel->peer, -1);

  if (tunnel->contact_id)
    GNUNET_free(tunnel->contact_id);

  if (tunnel->peer_message)
    GNUNET_free(tunnel->peer_message);

  if (tunnel->last_message)
    GNUNET_free(tunnel->last_message);

  GNUNET_free(tunnel);
}

Here is the call graph for this function:

bind_tunnel()

int bind_tunnel	(	struct GNUNET_MESSENGER_SrvTunnel *	tunnel,
		struct GNUNET_CADET_Channel *	channel
	)

Binds a CADET channel to a tunnel on returns GNUNET_YES only if the bounds channel was replaced successfully, otherwise GNUNET_NO gets returned.

Parameters

tunnel	Tunnel
channel	CADET channel

Returns

GNUNET_YES on success, otherwise GNUNET_NO

Definition at line 73 of file gnunet-service-messenger_tunnel.c.

References callback_room_disconnect(), GNUNET_MESSENGER_SrvTunnel::channel, GNUNET_MESSENGER_SrvTunnel::contact_id, delayed_disconnect_channel(), GNUNET_assert, GNUNET_NO, GNUNET_YES, and GNUNET_MESSENGER_SrvTunnel::room.

Referenced by callback_room_connect().

{
  GNUNET_assert(tunnel);

  if (tunnel->channel)
  {
    if (tunnel->contact_id)
      return GNUNET_NO;

    delayed_disconnect_channel (tunnel->channel);
  }

  tunnel->channel = channel;

  return GNUNET_YES;
}

Here is the call graph for this function:

Here is the caller graph for this function:

connect_tunnel()

int connect_tunnel

(

struct GNUNET_MESSENGER_SrvTunnel *

tunnel

)

Tries to connect a tunnel by creating a new CADET channel and binding it.

The function returns GNUNET_YES on success, otherwise GNUNET_NO.

Parameters

tunnel

Tunnel

Returns

GNUNET_YES on success, otherwise GNUNET_NO

Definition at line 191 of file gnunet-service-messenger_tunnel.c.

References cadet, callback_tunnel_disconnect(), GNUNET_MESSENGER_SrvTunnel::channel, get_room_cadet(), get_room_key(), GNUNET_assert, GNUNET_CADET_channel_create(), GNUNET_MESSAGE_TYPE_CADET_CLI, GNUNET_MQ_handler_end, GNUNET_MQ_hd_var_size, GNUNET_NO, GNUNET_PEER_resolve2(), GNUNET_YES, key, GNUNET_MESSENGER_SrvTunnel::peer, and GNUNET_MESSENGER_SrvTunnel::room.

Referenced by entry_room_at(), and rebuild_room_basement_structure().

{
  GNUNET_assert(tunnel);

  if (tunnel->channel)
    return GNUNET_NO;

  const struct GNUNET_PeerIdentity *door = GNUNET_PEER_resolve2 (tunnel->peer);

  struct GNUNET_CADET_Handle *cadet = get_room_cadet (tunnel->room);
  struct GNUNET_HashCode *key = get_room_key (tunnel->room);

  struct GNUNET_MQ_MessageHandler handlers[] = { GNUNET_MQ_hd_var_size(tunnel_message, GNUNET_MESSAGE_TYPE_CADET_CLI,
                                                                       struct GNUNET_MessageHeader, NULL),
                                                 GNUNET_MQ_handler_end() };

  tunnel->channel = GNUNET_CADET_channel_create (cadet, tunnel, door, key, NULL, callback_tunnel_disconnect, handlers);

  return GNUNET_YES;
}

Here is the call graph for this function:

Here is the caller graph for this function:

disconnect_tunnel()

void disconnect_tunnel

(

struct GNUNET_MESSENGER_SrvTunnel *

tunnel

)

Disconnects and unbinds a channel from a tunnel.

The actual disconnection will be asynchronous.

Parameters

tunnel

Tunnel

Definition at line 213 of file gnunet-service-messenger_tunnel.c.

References GNUNET_MESSENGER_SrvTunnel::channel, and delayed_disconnect_channel().

Referenced by callback_room_connect(), rebuild_room_basement_structure(), and send_message_info().

{
  if (tunnel->channel)
  {
    delayed_disconnect_channel (tunnel->channel);

    tunnel->channel = NULL;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

is_tunnel_connected()

int is_tunnel_connected

(

const struct GNUNET_MESSENGER_SrvTunnel *

tunnel

)

Returns the status of a currently bound channel of a tunnel.

Parameters

tunnel

Tunnel

Returns

GNUNET_YES or GNUNET_NO

Definition at line 224 of file gnunet-service-messenger_tunnel.c.

References GNUNET_MESSENGER_SrvTunnel::channel, GNUNET_NO, and GNUNET_YES.

Referenced by iterate_send_room_message(), and send_room_info().

{
  return (tunnel->channel ? GNUNET_YES : GNUNET_NO);
}

Here is the caller graph for this function:

send_tunnel_envelope()

void send_tunnel_envelope	(	struct GNUNET_MESSENGER_SrvTunnel *	tunnel,
		void *	handle,
		struct GNUNET_MQ_Envelope *	env,
		struct GNUNET_MESSENGER_Message *	message,
		const struct GNUNET_HashCode *	hash
	)

Sends an envelope containing a message with a given hash through a tunnel by a given handle.

Parameters

tunnel	Tunnel
handle	Handle
env	Envelope
message	Message
hash	Hash of message

Definition at line 256 of file gnunet-service-messenger_tunnel.c.

References callback_room_sent(), callback_tunnel_sent(), GNUNET_MESSENGER_SrvTunnel::channel, GNUNET_CADET_get_mq(), GNUNET_memcpy, GNUNET_MQ_notify_sent(), GNUNET_MQ_send(), GNUNET_new, GNUNET_MESSENGER_MessageSent::hash, mq, GNUNET_MESSENGER_SrvTunnel::room, and GNUNET_MESSENGER_MessageSent::tunnel.

Referenced by forward_tunnel_message(), iterate_send_room_message(), and send_tunnel_message().

{
  struct GNUNET_MQ_Handle *mq = GNUNET_CADET_get_mq (tunnel->channel);

  struct GNUNET_MESSENGER_MessageSent *sent = GNUNET_new(struct GNUNET_MESSENGER_MessageSent);

  GNUNET_memcpy(&(sent->hash), hash, sizeof(struct GNUNET_HashCode));

  sent->tunnel = tunnel;

  GNUNET_MQ_notify_sent (env, callback_tunnel_sent, sent);
  GNUNET_MQ_send (mq, env);

  callback_room_sent (tunnel->room, (struct GNUNET_MESSENGER_SrvHandle*) handle, tunnel, message, hash);
}

Here is the call graph for this function:

Here is the caller graph for this function:

send_tunnel_message()

void send_tunnel_message	(	struct GNUNET_MESSENGER_SrvTunnel *	tunnel,
		void *	handle,
		struct GNUNET_MESSENGER_Message *	message,
		struct GNUNET_HashCode *	hash
	)

Sends a message by packing it automatically into an envelope and passing it through the tunnel.

The used handle will sign the message and the hash will be calculated and stored.

Parameters

	tunnel	Tunnel
	handle	Handle
[out]	message	Message
[out]	hash	Hash of message

Definition at line 274 of file gnunet-service-messenger_tunnel.c.

References copy_message(), env, GNUNET_MESSENGER_PACK_MODE_ENVELOPE, pack_room_message(), GNUNET_MESSENGER_SrvTunnel::room, and send_tunnel_envelope().

Referenced by recv_message_info(), and send_room_info().

{
  struct GNUNET_MQ_Envelope *env = pack_room_message (tunnel->room, (struct GNUNET_MESSENGER_SrvHandle*) handle,
                                                      message, hash,
                                                      GNUNET_MESSENGER_PACK_MODE_ENVELOPE);

  if (env)
    send_tunnel_envelope (tunnel, handle, env, copy_message (message), hash);
}

Here is the call graph for this function:

Here is the caller graph for this function:

forward_tunnel_message()

void forward_tunnel_message	(	struct GNUNET_MESSENGER_SrvTunnel *	tunnel,
		const struct GNUNET_MESSENGER_Message *	message,
		const struct GNUNET_HashCode *	hash
	)

Forwards a given message with a known hash through a tunnel.

Parameters

tunnel	Tunnel
message	Message
hash	Hash of message

Definition at line 286 of file gnunet-service-messenger_tunnel.c.

References copy_message(), env, GNUNET_MESSENGER_PACK_MODE_ENVELOPE, pack_message(), and send_tunnel_envelope().

Referenced by iterate_send_member_infos(), recv_message_request(), and send_message_join().

{
  struct GNUNET_MESSENGER_Message *clone = copy_message (message);
  struct GNUNET_MQ_Envelope *env = pack_message (clone, NULL, NULL, GNUNET_MESSENGER_PACK_MODE_ENVELOPE);

  if (env)
    send_tunnel_envelope (tunnel, NULL, env, clone, hash);
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_tunnel_peer_message()

const struct GNUNET_HashCode* get_tunnel_peer_message

(

const struct GNUNET_MESSENGER_SrvTunnel *

tunnel

)

Returns the hash of the latest peer message published through a given tunnel and matching the tunnels peer identity.

If no peer message has been linked to the tunnel yet, NULL gets returned.

Parameters

tunnel

Tunnel

Returns

Hash of peer message or NULL

Definition at line 297 of file gnunet-service-messenger_tunnel.c.

References GNUNET_MESSENGER_SrvTunnel::peer_message.

{
  return tunnel->peer_message;
}