gnunet-service-core_sessions.h File Reference

#include "gnunet-service-core.h"
#include "gnunet-service-core_kx.h"

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

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

Go to the source code of this file.

Functions
void	GSC_SESSIONS_create (const struct GNUNET_PeerIdentity *peer, struct GSC_KeyExchangeInfo *kx, enum GNUNET_CORE_PeerClass class)
	Create a session, a key exchange was just completed.
void	GSC_SESSIONS_reinit (const struct GNUNET_PeerIdentity *peer)
	The other peer has indicated that it 'lost' the session (KX down), reinitialize the session on our end, in particular this means to restart the typemap transmission.
void	GSC_SESSIONS_end (const struct GNUNET_PeerIdentity *pid)
	End the session with the given peer (we are no longer connected).
void	GSC_SESSIONS_solicit (const struct GNUNET_PeerIdentity *pid)
	Traffic is being solicited for the given peer.
void	GSC_SESSIONS_queue_request (struct GSC_ClientActiveRequest *car)
	Queue a request from a client for transmission to a particular peer.
void	GSC_SESSIONS_dequeue_request (struct GSC_ClientActiveRequest *car)
	Dequeue a request from a client from transmission to a particular peer.
void	GSC_SESSIONS_transmit (struct GSC_ClientActiveRequest *car, const struct GNUNET_MessageHeader *msg, enum GNUNET_MQ_PriorityPreferences priority)
	Transmit a message to a particular peer.
void	GSC_SESSIONS_notify_client_about_sessions (struct GSC_Client *client)
	We have a new client, notify it about all current sessions.
void	GSC_SESSIONS_init (void)
	Initialize sessions subsystem.
void	GSC_SESSIONS_done (void)
	Shutdown sessions subsystem.

Function Documentation

GSC_SESSIONS_create()

void GSC_SESSIONS_create	(	const struct GNUNET_PeerIdentity *	peer,
		struct GSC_KeyExchangeInfo *	kx,
		enum GNUNET_CORE_PeerClass	class
	)

Create a session, a key exchange was just completed.

Parameters

peer	peer that is now connected
kx	key exchange that completed
peer	peer that is now connected
kx	key exchange that completed
class	the class of the now connected peer

Definition at line 219 of file gnunet-service-core_sessions.c.

{
  struct Session *session;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Creating session for peer `%s'\n",
              GNUNET_i2s (peer));
  session = GNUNET_new (struct Session);
  // TODO
  //session->services = GSC_SVCI_init ();
  session->peer = peer;
  session->kx = kx;
  session->class = class;
  GNUNET_assert (GNUNET_OK ==
                 GNUNET_CONTAINER_multipeermap_put (
                   sessions,
                   session->peer,
                   session,
                   GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
  GNUNET_STATISTICS_set (GSC_stats,
                         gettext_noop ("# peers connected"),
                         GNUNET_CONTAINER_multipeermap_size (sessions),
                         GNUNET_NO);
  // TODO
  GSC_CLIENTS_notify_clients_about_neighbour (peer,
                                              session->class);
}

References Session::class, gettext_noop, GNUNET_assert, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY, GNUNET_CONTAINER_multipeermap_put(), GNUNET_CONTAINER_multipeermap_size(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_log, GNUNET_new, GNUNET_NO, GNUNET_OK, GNUNET_STATISTICS_set(), GSC_CLIENTS_notify_clients_about_neighbour(), GSC_stats, Session::kx, Session::peer, and sessions.

Referenced by check_if_ack_or_heartbeat(), and handle_initiator_done().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_SESSIONS_reinit()

void GSC_SESSIONS_reinit

(

const struct GNUNET_PeerIdentity *

peer

)

The other peer has indicated that it 'lost' the session (KX down), reinitialize the session on our end, in particular this means to restart the typemap transmission.

XXX the typemap does not exist anymore

Parameters

peer	peer that is now connected

XXX typemap does not exist anymore

Parameters

peer	peer that is now connected

Definition at line 259 of file gnunet-service-core_sessions.c.

{
  struct Session *session;
 
  session = find_session (peer);
  if (NULL == session)
  {
    /* KX/session is new for both sides; thus no need to restart what
       has not yet begun */
    return;
  }
}

References find_session(), and Session::peer.

Here is the call graph for this function:

GSC_SESSIONS_end()

void GSC_SESSIONS_end

(

const struct GNUNET_PeerIdentity *

pid

)

End the session with the given peer (we are no longer connected).

Parameters

pid	identity of peer to kill session with

Definition at line 159 of file gnunet-service-core_sessions.c.

{
  struct Session *session;
  struct GSC_ClientActiveRequest *car;
  struct SessionMessageEntry *sme;
 
  if (NULL == pid)
  {
    /* We might not know the peer_id yet. */
    return;
  }
  session = find_session (pid);
  if (NULL == session)
    return;
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Destroying session for peer `%s'\n",
              GNUNET_i2s (session->peer));
  if (NULL != session->cork_task)
  {
    GNUNET_SCHEDULER_cancel (session->cork_task);
    session->cork_task = NULL;
  }
  while (NULL != (car = session->active_client_request_head))
  {
    GNUNET_CONTAINER_DLL_remove (session->active_client_request_head,
                                 session->active_client_request_tail,
                                 car);
    GSC_CLIENTS_reject_request (car, GNUNET_NO);
  }
  while (NULL != (sme = session->sme_head))
  {
    GNUNET_CONTAINER_DLL_remove (session->sme_head, session->sme_tail, sme);
    GNUNET_free (sme);
  }
  // TODO
  GSC_CLIENTS_notify_clients_about_neighbour (session->peer,
                                              session->class);
  GNUNET_assert (
    GNUNET_YES ==
    GNUNET_CONTAINER_multipeermap_remove (sessions, session->peer, session));
  GNUNET_STATISTICS_set (GSC_stats,
                         gettext_noop ("# peers connected"),
                         GNUNET_CONTAINER_multipeermap_size (sessions),
                         GNUNET_NO);
  // TODO
  // GSC_SVCI_destroy (session->services);
  GNUNET_free (session);
}

References Session::active_client_request_head, Session::active_client_request_tail, Session::class, Session::cork_task, find_session(), gettext_noop, GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GNUNET_CONTAINER_multipeermap_remove(), GNUNET_CONTAINER_multipeermap_size(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_i2s(), GNUNET_log, GNUNET_NO, GNUNET_SCHEDULER_cancel(), GNUNET_STATISTICS_set(), GNUNET_YES, GSC_CLIENTS_notify_clients_about_neighbour(), GSC_CLIENTS_reject_request(), GSC_stats, Session::peer, pid, sessions, Session::sme_head, and Session::sme_tail.

Referenced by free_session_helper(), handle_encrypted_message(), handle_transport_notify_disconnect(), and send_heartbeat().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_SESSIONS_solicit()

void GSC_SESSIONS_solicit

(

const struct GNUNET_PeerIdentity *

pid

)

Traffic is being solicited for the given peer.

This means that the message queue on the transport-level (NEIGHBOURS subsystem) is now empty and it is now OK to transmit another (non-control) message.

Parameters

pid	identity of peer ready to receive data

Definition at line 632 of file gnunet-service-core_sessions.c.

{
  struct Session *session;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Transport solicits for %s\n",
              GNUNET_i2s (pid));
  session = find_session (pid);
  if (NULL == session)
    return;
  try_transmission (session);
}

References find_session(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_i2s(), GNUNET_log, pid, and try_transmission().

Here is the call graph for this function:

GSC_SESSIONS_queue_request()

void GSC_SESSIONS_queue_request

(

struct GSC_ClientActiveRequest *

car

)

Queue a request from a client for transmission to a particular peer.

Parameters

car	request to queue; this handle is then shared between the caller (CLIENTS subsystem) and SESSIONS and must not be released by either until either 'GNUNET_SESSIONS_dequeue', or 'GNUNET_CLIENTS_failed' have been invoked on it
car	request to queue; this handle is then shared between the caller (CLIENTS subsystem) and SESSIONS and must not be released by either until either #GSC_SESSIONS_dequeue(), GSC_SESSIONS_transmit() or #GSC_CLIENTS_failed() have been invoked on it

Definition at line 334 of file gnunet-service-core_sessions.c.

{
  struct Session *session;
 
  session = find_session (&car->target);
  if (NULL == session)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Dropped client request for transmission (am disconnected)\n");
    GNUNET_break (0);  /* should have been rejected earlier */
    GSC_CLIENTS_reject_request (car, GNUNET_NO);
    return;
  }
  if (car->msize > GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE)
  {
    GNUNET_break (0);
    GSC_CLIENTS_reject_request (car, GNUNET_YES);
    return;
  }
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Received client transmission request. queueing\n");
  GNUNET_CONTAINER_DLL_insert_tail (session->active_client_request_head,
                                    session->active_client_request_tail,
                                    car);
  try_transmission (session);
}

References Session::active_client_request_head, Session::active_client_request_tail, find_session(), GNUNET_break, GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_NO, GNUNET_YES, GSC_CLIENTS_reject_request(), GSC_ClientActiveRequest::msize, GSC_ClientActiveRequest::target, and try_transmission().

Referenced by handle_client_send_request().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_SESSIONS_dequeue_request()

void GSC_SESSIONS_dequeue_request

(

struct GSC_ClientActiveRequest *

car

)

Dequeue a request from a client from transmission to a particular peer.

Parameters

car	request to dequeue; this handle will then be 'owned' by the caller (CLIENTS sysbsystem)

Definition at line 369 of file gnunet-service-core_sessions.c.

{
  struct Session *session;
 
  if (0 == memcmp (&car->target,
                   &GSC_my_identity,
                   sizeof(struct GNUNET_PeerIdentity)))
    return;
  session = find_session (&car->target);
  GNUNET_assert (NULL != session);
  GNUNET_CONTAINER_DLL_remove (session->active_client_request_head,
                               session->active_client_request_tail,
                               car);
  /* dequeueing of 'high' priority messages may unblock
     transmission for lower-priority messages, so we also
     need to try in this case. */
  try_transmission (session);
}

References Session::active_client_request_head, Session::active_client_request_tail, find_session(), GNUNET_assert, GNUNET_CONTAINER_DLL_remove, GSC_my_identity, GSC_ClientActiveRequest::target, and try_transmission().

Referenced by destroy_active_client_request(), GSC_CLIENTS_solicit_request(), handle_client_send(), and handle_client_send_request().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_SESSIONS_transmit()

void GSC_SESSIONS_transmit	(	struct GSC_ClientActiveRequest *	car,
		const struct GNUNET_MessageHeader *	msg,
		enum GNUNET_MQ_PriorityPreferences	priority
	)

Transmit a message to a particular peer.

Parameters

car	original request that was queued and then solicited, ownership does not change (dequeue will be called soon).
msg	message to transmit
priority	how important is this message

Definition at line 647 of file gnunet-service-core_sessions.c.

{
  struct Session *session;
  struct SessionMessageEntry *sme;
  struct SessionMessageEntry *pos;
  size_t msize;
 
  session = find_session (&car->target);
  if (NULL == session)
    return;
  msize = ntohs (msg->size);
  sme = GNUNET_malloc (sizeof(struct SessionMessageEntry) + msize);
  GNUNET_memcpy (&sme[1], msg, msize);
  sme->size = msize;
  sme->priority = priority;
  if (0 != (GNUNET_MQ_PREF_CORK_ALLOWED & priority))
  {
    sme->deadline =
      GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_MAX_CORK_DELAY);
    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                "Message corked, delaying transmission\n");
  }
  pos = session->sme_head;
  while ((NULL != pos) && (pos->priority >= sme->priority))
    pos = pos->next;
  if (NULL == pos)
    GNUNET_CONTAINER_DLL_insert_tail (session->sme_head,
                                      session->sme_tail,
                                      sme);
  else
    GNUNET_CONTAINER_DLL_insert_after (session->sme_head,
                                       session->sme_tail,
                                       pos->prev,
                                       sme);
  try_transmission (session);
}

References SessionMessageEntry::deadline, find_session(), GNUNET_CONSTANTS_MAX_CORK_DELAY, GNUNET_CONTAINER_DLL_insert_after, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_malloc, GNUNET_memcpy, GNUNET_MQ_PREF_CORK_ALLOWED, GNUNET_TIME_relative_to_absolute(), msg, SessionMessageEntry::next, SessionMessageEntry::prev, SessionMessageEntry::priority, GNUNET_MessageHeader::size, SessionMessageEntry::size, Session::sme_head, Session::sme_tail, GSC_ClientActiveRequest::target, and try_transmission().

Referenced by tokenized_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_SESSIONS_notify_client_about_sessions()

void GSC_SESSIONS_notify_client_about_sessions

(

struct GSC_Client *

client

)

We have a new client, notify it about all current sessions.

Parameters

client

the new client

Definition at line 305 of file gnunet-service-core_sessions.c.

{
  /* notify new client about existing sessions */
  GNUNET_CONTAINER_multipeermap_iterate (sessions,
                                         &notify_client_about_session,
                                         client);
}

References GNUNET_CONTAINER_multipeermap_iterate(), notify_client_about_session(), and sessions.

Referenced by handle_client_init().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_SESSIONS_init()

void GSC_SESSIONS_init

(

void

)

Initialize sessions subsystem.

Definition at line 691 of file gnunet-service-core_sessions.c.

{
  sessions = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_YES);
}

References GNUNET_CONTAINER_multipeermap_create(), GNUNET_YES, and sessions.

Referenced by GSC_complete_initialization_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

GSC_SESSIONS_done()

void GSC_SESSIONS_done

(

void

)

Shutdown sessions subsystem.

Definition at line 722 of file gnunet-service-core_sessions.c.

{
  if (NULL != sessions)
  {
    GNUNET_CONTAINER_multipeermap_iterate (sessions,
                                           &free_session_helper,
                                           NULL);
    GNUNET_CONTAINER_multipeermap_destroy (sessions);
    sessions = NULL;
  }
}

References free_session_helper(), GNUNET_CONTAINER_multipeermap_destroy(), GNUNET_CONTAINER_multipeermap_iterate(), and sessions.

Referenced by shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function: