* Boston, MA 02111-1307, USA.
*/
-/**
+/**
* @file psyc/psyc_api.c
* @brief PSYC service; high-level access to the PSYC protocol
* note that clients of this API are NOT expected to
* @author Gabor X Toth
*/
+#include <inttypes.h>
+
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_env_lib.h"
+#include "gnunet_multicast_service.h"
#include "gnunet_psyc_service.h"
+#include "gnunet_psyc_util_lib.h"
#include "psyc.h"
#define LOG(kind,...) GNUNET_log_from (kind, "psyc-api",__VA_ARGS__)
-struct OperationHandle
-{
- struct OperationHandle *prev;
- struct OperationHandle *next;
- const struct GNUNET_MessageHeader *msg;
-};
-
-/**
+/**
* Handle to access PSYC channel operations for both the master and slaves.
*/
struct GNUNET_PSYC_Channel
const struct GNUNET_CONFIGURATION_Handle *cfg;
/**
- * Socket (if available).
+ * Client connection to the service.
*/
- struct GNUNET_CLIENT_Connection *client;
+ struct GNUNET_CLIENT_MANAGER_Connection *client;
/**
- * Currently pending transmission request, or NULL for none.
+ * Transmission handle;
*/
- struct GNUNET_CLIENT_TransmitHandle *th;
+ struct GNUNET_PSYC_TransmitHandle *tmit;
/**
- * Head of operations to transmit.
+ * Receipt handle;
*/
- struct OperationHandle *transmit_head;
-
- /**
- * Tail of operations to transmit.
- */
- struct OperationHandle *transmit_tail;
+ struct GNUNET_PSYC_ReceiveHandle *recv;
/**
* Message to send on reconnect.
*/
- struct GNUNET_MessageHeader *reconnect_msg;
-
- /**
- * Task doing exponential back-off trying to reconnect.
- */
- GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
-
- /**
- * Time for next connect retry.
- */
- struct GNUNET_TIME_Relative reconnect_delay;
-
- GNUNET_PSYC_Method method_cb;
-
- GNUNET_PSYC_JoinCallback join_cb;
-
- void *cb_cls;
+ struct GNUNET_MessageHeader *connect_msg;
/**
* Are we polling for incoming messages right now?
*/
- int in_receive;
+ uint8_t in_receive;
/**
- * Are we currently transmitting a message?
+ * Is this a master or slave channel?
*/
- int in_transmit;
+ uint8_t is_master;
};
-/**
+/**
* Handle for the master of a PSYC channel.
*/
struct GNUNET_PSYC_Master
{
- struct GNUNET_PSYC_Channel ch;
+ struct GNUNET_PSYC_Channel chn;
GNUNET_PSYC_MasterStartCallback start_cb;
- uint64_t max_message_id;
+ /**
+ * Join request callback.
+ */
+ GNUNET_PSYC_JoinRequestCallback join_req_cb;
+
+ /**
+ * Closure for the callbacks.
+ */
+ void *cb_cls;
};
-/**
+/**
* Handle for a PSYC channel slave.
*/
struct GNUNET_PSYC_Slave
{
- struct GNUNET_PSYC_Channel ch;
+ struct GNUNET_PSYC_Channel chn;
+
+ GNUNET_PSYC_SlaveConnectCallback connect_cb;
+
+ GNUNET_PSYC_JoinDecisionCallback join_dcsn_cb;
+
+ /**
+ * Closure for the callbacks.
+ */
+ void *cb_cls;
};
-/**
+/**
* Handle that identifies a join request.
*
- * Used to match calls to #GNUNET_PSYC_JoinCallback to the
+ * Used to match calls to #GNUNET_PSYC_JoinRequestCallback to the
* corresponding calls to GNUNET_PSYC_join_decision().
*/
struct GNUNET_PSYC_JoinHandle
{
-
+ struct GNUNET_PSYC_Master *mst;
+ struct GNUNET_CRYPTO_EddsaPublicKey slave_key;
};
-/**
- * Handle for a pending PSYC transmission operation.
- */
-struct GNUNET_PSYC_MasterTransmitHandle
-{
- struct GNUNET_PSYC_Master *master;
- const struct GNUNET_ENV_Environment *env;
- GNUNET_PSYC_MasterTransmitNotify notify;
- void *notify_cls;
- enum GNUNET_PSYC_MasterTransmitFlags flags;
-};
-
-
-/**
+/**
* Handle for a pending PSYC transmission operation.
*/
struct GNUNET_PSYC_SlaveTransmitHandle
};
-/**
+/**
* Handle to a story telling operation.
*/
struct GNUNET_PSYC_Story
};
-/**
- * Try again to connect to the PSYCstore service.
- *
- * @param cls handle to the PSYCstore service.
- * @param tc scheduler context
- */
static void
-reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+channel_send_connect_msg (struct GNUNET_PSYC_Channel *chn)
+{
+ uint16_t cmsg_size = ntohs (chn->connect_msg->size);
+ struct GNUNET_MessageHeader * cmsg = GNUNET_malloc (cmsg_size);
+ memcpy (cmsg, chn->connect_msg, cmsg_size);
+ GNUNET_CLIENT_MANAGER_transmit_now (chn->client, cmsg);
+}
-/**
- * Reschedule a connect attempt to the service.
- *
- * @param h transport service to reconnect
- */
static void
-reschedule_connect (struct GNUNET_PSYC_Channel *c)
-{
- GNUNET_assert (c->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
-
- if (NULL != c->th)
- {
- GNUNET_CLIENT_notify_transmit_ready_cancel (c->th);
- c->th = NULL;
- }
- if (NULL != c->client)
- {
- GNUNET_CLIENT_disconnect (c->client);
- c->client = NULL;
- }
- c->in_receive = GNUNET_NO;
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Scheduling task to reconnect to PSYCstore service in %s.\n",
- GNUNET_STRINGS_relative_time_to_string (c->reconnect_delay, GNUNET_YES));
- c->reconnect_task =
- GNUNET_SCHEDULER_add_delayed (c->reconnect_delay, &reconnect, c);
- c->reconnect_delay = GNUNET_TIME_STD_BACKOFF (c->reconnect_delay);
+channel_recv_disconnect (void *cls,
+ struct GNUNET_CLIENT_MANAGER_Connection *client,
+ const struct GNUNET_MessageHeader *msg)
+{
+ struct GNUNET_PSYC_Channel *
+ chn = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*chn));
+ GNUNET_CLIENT_MANAGER_reconnect (client);
+ channel_send_connect_msg (chn);
}
-/**
- * Schedule transmission of the next message from our queue.
- *
- * @param h PSYCstore handle
- */
static void
-transmit_next (struct GNUNET_PSYC_Channel *c);
+channel_recv_message (void *cls,
+ struct GNUNET_CLIENT_MANAGER_Connection *client,
+ const struct GNUNET_MessageHeader *msg)
+{
+ struct GNUNET_PSYC_Channel *
+ chn = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*chn));
+ GNUNET_PSYC_receive_message (chn->recv,
+ (const struct GNUNET_PSYC_MessageHeader *) msg);
+}
-/**
- * Type of a function to call when we receive a message
- * from the service.
- *
- * @param cls closure
- * @param msg message received, NULL on timeout or fatal error
- */
static void
-message_handler (void *cls, const struct GNUNET_MessageHeader *msg)
-{
- struct GNUNET_PSYC_Channel *ch = cls;
- struct GNUNET_PSYC_Master *mst = cls;
- struct GNUNET_PSYC_Slave *slv = cls;
-
- if (NULL == msg)
- {
- reschedule_connect (ch);
- return;
- }
- uint16_t size_eq = 0;
- uint16_t size_min = 0;
- const uint16_t size = ntohs (msg->size);
- const uint16_t type = ntohs (msg->type);
-
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Received message of type %d from PSYC service\n", type);
-
- switch (type)
- {
- case GNUNET_MESSAGE_TYPE_PSYC_MASTER_START_ACK:
- case GNUNET_MESSAGE_TYPE_PSYC_SLAVE_JOIN_ACK:
- size_eq = sizeof (struct CountersResult);
- break;
- }
-
- if (! ((0 < size_eq && size == size_eq)
- || (0 < size_min && size >= size_min)))
- {
- GNUNET_break (0);
- reschedule_connect (ch);
- return;
- }
-
- struct CountersResult *cres;
-
- switch (type)
- {
- case GNUNET_MESSAGE_TYPE_PSYC_MASTER_START_ACK:
- cres = (struct CountersResult *) msg;
- mst->max_message_id = GNUNET_ntohll (cres->max_message_id);
- if (NULL != mst->start_cb)
- mst->start_cb (ch->cb_cls, mst->max_message_id);
- break;
-
- case GNUNET_MESSAGE_TYPE_PSYC_SLAVE_JOIN_ACK:
- cres = (struct CountersResult *) msg;
-#if TODO
- slv->max_message_id = GNUNET_ntohll (cres->max_message_id);
- if (NULL != slv->join_ack_cb)
- mst->join_ack_cb (ch->cb_cls, mst->max_message_id);
-#endif
- break;
- }
-
- GNUNET_CLIENT_receive (ch->client, &message_handler, ch,
- GNUNET_TIME_UNIT_FOREVER_REL);
+channel_recv_message_ack (void *cls,
+ struct GNUNET_CLIENT_MANAGER_Connection *client,
+ const struct GNUNET_MessageHeader *msg)
+{
+ struct GNUNET_PSYC_Channel *
+ chn = GNUNET_CLIENT_MANAGER_get_user_context_ (client, sizeof (*chn));
+ GNUNET_PSYC_transmit_got_ack (chn->tmit);
}
-/**
- * Transmit next message to service.
- *
- * @param cls The 'struct GNUNET_PSYCSTORE_Handle'.
- * @param size Number of bytes available in buf.
- * @param buf Where to copy the message.
- * @return Number of bytes copied to buf.
- */
-static size_t
-send_next_message (void *cls, size_t size, void *buf)
-{
- struct GNUNET_PSYC_Channel *ch = cls;
- struct OperationHandle *op = ch->transmit_head;
- size_t ret;
-
- ch->th = NULL;
- if (NULL == op->msg)
- return 0;
- ret = ntohs (op->msg->size);
- if (ret > size)
- {
- reschedule_connect (ch);
- return 0;
- }
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Sending message of type %d to PSYCstore service\n",
- ntohs (op->msg->type));
- memcpy (buf, op->msg, ret);
-
- GNUNET_CONTAINER_DLL_remove (ch->transmit_head, ch->transmit_tail, op);
- GNUNET_free (op);
-
- if (NULL != ch->transmit_head)
- transmit_next (ch);
-
- if (GNUNET_NO == ch->in_receive)
- {
- ch->in_receive = GNUNET_YES;
- GNUNET_CLIENT_receive (ch->client, &message_handler, ch,
- GNUNET_TIME_UNIT_FOREVER_REL);
- }
- return ret;
+static void
+master_recv_start_ack (void *cls,
+ struct GNUNET_CLIENT_MANAGER_Connection *client,
+ const struct GNUNET_MessageHeader *msg)
+{
+ struct GNUNET_PSYC_Master *
+ mst = GNUNET_CLIENT_MANAGER_get_user_context_ (client,
+ sizeof (struct GNUNET_PSYC_Channel));
+
+ struct CountersResult *cres = (struct CountersResult *) msg;
+ if (NULL != mst->start_cb)
+ mst->start_cb (mst->cb_cls, GNUNET_ntohll (cres->max_message_id));
}
-/**
- * Schedule transmission of the next message from our queue.
- *
- * @param h PSYCstore handle.
- */
static void
-transmit_next (struct GNUNET_PSYC_Channel *ch)
+master_recv_join_request (void *cls,
+ struct GNUNET_CLIENT_MANAGER_Connection *client,
+ const struct GNUNET_MessageHeader *msg)
{
- if (NULL != ch->th || NULL == ch->client)
- return;
+ struct GNUNET_PSYC_Master *
+ mst = GNUNET_CLIENT_MANAGER_get_user_context_ (client,
+ sizeof (struct GNUNET_PSYC_Channel));
+
+ const struct MasterJoinRequest *req = (const struct MasterJoinRequest *) msg;
- struct OperationHandle *op = ch->transmit_head;
- if (NULL == op)
- return;
+ struct GNUNET_PSYC_MessageHeader *pmsg = NULL;
+ if (ntohs (req->header.size) <= sizeof (*req) + sizeof (*pmsg))
+ pmsg = (struct GNUNET_PSYC_MessageHeader *) &req[1];
- ch->th = GNUNET_CLIENT_notify_transmit_ready (ch->client,
- ntohs (op->msg->size),
- GNUNET_TIME_UNIT_FOREVER_REL,
- GNUNET_NO,
- &send_next_message,
- ch);
+ struct GNUNET_PSYC_JoinHandle *jh = GNUNET_malloc (sizeof (*jh));
+ jh->mst = mst;
+ jh->slave_key = req->slave_key;
+
+ if (NULL != mst->join_req_cb)
+ mst->join_req_cb (mst->cb_cls, &req->slave_key, pmsg, jh);
}
-/**
- * Try again to connect to the PSYC service.
- *
- * @param cls Channel handle.
- * @param tc Scheduler context.
- */
static void
-reconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
-{
- struct GNUNET_PSYC_Channel *ch = cls;
-
- ch->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
- LOG (GNUNET_ERROR_TYPE_DEBUG,
- "Connecting to PSYC service.\n");
- GNUNET_assert (NULL == ch->client);
- ch->client = GNUNET_CLIENT_connect ("psyc", ch->cfg);
- GNUNET_assert (NULL != ch->client);
-
- if (NULL == ch->transmit_head ||
- ch->transmit_head->msg->type != ch->reconnect_msg->type)
- {
- struct OperationHandle *op
- = GNUNET_malloc (sizeof (struct OperationHandle)
- + ntohs (ch->reconnect_msg->size));
- memcpy (&op[1], ch->reconnect_msg, ntohs (ch->reconnect_msg->size));
- op->msg = (struct GNUNET_MessageHeader *) &op[1];
- GNUNET_CONTAINER_DLL_insert (ch->transmit_head, ch->transmit_tail, op);
- }
-
- transmit_next (ch);
+slave_recv_join_ack (void *cls,
+ struct GNUNET_CLIENT_MANAGER_Connection *client,
+ const struct GNUNET_MessageHeader *msg)
+{
+ struct GNUNET_PSYC_Slave *
+ slv = GNUNET_CLIENT_MANAGER_get_user_context_ (client,
+ sizeof (struct GNUNET_PSYC_Channel));
+ struct CountersResult *cres = (struct CountersResult *) msg;
+ if (NULL != slv->connect_cb)
+ slv->connect_cb (slv->cb_cls, GNUNET_ntohll (cres->max_message_id));
}
-/**
- * Disconnect from the PSYC service.
- *
- * @param cls Channel handle.
- * @param tc Scheduler context.
- */
static void
-disconnect (void *c)
-{
- struct GNUNET_PSYC_Channel *ch = c;
- GNUNET_assert (NULL != ch);
- GNUNET_assert (ch->transmit_head == ch->transmit_tail);
- if (ch->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
- {
- GNUNET_SCHEDULER_cancel (ch->reconnect_task);
- ch->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
- }
- if (NULL != ch->th)
- {
- GNUNET_CLIENT_notify_transmit_ready_cancel (ch->th);
- ch->th = NULL;
- }
- if (NULL != ch->client)
- {
- GNUNET_CLIENT_disconnect (ch->client);
- ch->client = NULL;
- }
- if (NULL != ch->reconnect_msg)
- ch->reconnect_msg = NULL;
+slave_recv_join_decision (void *cls,
+ struct GNUNET_CLIENT_MANAGER_Connection *client,
+ const struct GNUNET_MessageHeader *msg)
+{
+ struct GNUNET_PSYC_Slave *
+ slv = GNUNET_CLIENT_MANAGER_get_user_context_ (client,
+ sizeof (struct GNUNET_PSYC_Channel));
+ const struct SlaveJoinDecision *
+ dcsn = (const struct SlaveJoinDecision *) msg;
+
+ struct GNUNET_PSYC_MessageHeader *pmsg = NULL;
+ if (ntohs (dcsn->header.size) <= sizeof (*dcsn) + sizeof (*pmsg))
+ pmsg = (struct GNUNET_PSYC_MessageHeader *) &dcsn[1];
+
+ struct GNUNET_PSYC_JoinHandle *jh = GNUNET_malloc (sizeof (*jh));
+ if (NULL != slv->join_dcsn_cb)
+ slv->join_dcsn_cb (slv->cb_cls, ntohl (dcsn->is_admitted), pmsg);
}
-/**
+static struct GNUNET_CLIENT_MANAGER_MessageHandler master_handlers[] =
+{
+ { &channel_recv_disconnect, NULL, 0, 0, GNUNET_NO },
+
+ { &channel_recv_message, NULL,
+ GNUNET_MESSAGE_TYPE_PSYC_MESSAGE,
+ sizeof (struct GNUNET_PSYC_MessageHeader), GNUNET_YES },
+
+ { &channel_recv_message_ack, NULL,
+ GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_ACK,
+ sizeof (struct GNUNET_MessageHeader), GNUNET_NO },
+
+ { &master_recv_start_ack, NULL,
+ GNUNET_MESSAGE_TYPE_PSYC_MASTER_START_ACK,
+ sizeof (struct CountersResult), GNUNET_NO },
+
+ { &master_recv_join_request, NULL,
+ GNUNET_MESSAGE_TYPE_PSYC_JOIN_REQUEST,
+ sizeof (struct MasterJoinRequest), GNUNET_YES },
+
+ { NULL, NULL, 0, 0, GNUNET_NO }
+};
+
+
+static struct GNUNET_CLIENT_MANAGER_MessageHandler slave_handlers[] =
+{
+ { &channel_recv_disconnect, NULL, 0, 0, GNUNET_NO },
+
+ { &channel_recv_message, NULL,
+ GNUNET_MESSAGE_TYPE_PSYC_MESSAGE,
+ sizeof (struct GNUNET_PSYC_MessageHeader), GNUNET_YES },
+
+ { &channel_recv_message_ack, NULL,
+ GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_ACK,
+ sizeof (struct GNUNET_MessageHeader), GNUNET_NO },
+
+ { &slave_recv_join_ack, NULL,
+ GNUNET_MESSAGE_TYPE_PSYC_SLAVE_JOIN_ACK,
+ sizeof (struct CountersResult), GNUNET_NO },
+
+ { &slave_recv_join_decision, NULL,
+ GNUNET_MESSAGE_TYPE_PSYC_JOIN_DECISION,
+ sizeof (struct SlaveJoinDecision), GNUNET_YES },
+
+ { NULL, NULL, 0, 0, GNUNET_NO }
+};
+
+
+/**
* Start a PSYC master channel.
*
* Will start a multicast group identified by the given ECC key. Messages
* or part messages, the respective methods must call other PSYC functions to
* inform PSYC about the meaning of the respective events.
*
- * @param cfg Configuration to use (to connect to PSYC service).
- * @param channel_key ECC key that will be used to sign messages for this
+ * @param cfg Configuration to use (to connect to PSYC service).
+ * @param channel_key ECC key that will be used to sign messages for this
* PSYC session. The public key is used to identify the PSYC channel.
* Note that end-users will usually not use the private key directly, but
* rather look it up in GNS for places managed by other users, or select
* a file with the private key(s) when setting up their own channels
* FIXME: we'll likely want to use NOT the p521 curve here, but a cheaper
* one in the future.
- * @param policy Channel policy specifying join and history restrictions.
+ * @param policy Channel policy specifying join and history restrictions.
* Used to automate join decisions.
- * @param method Function to invoke on messages received from slaves.
- * @param join_cb Function to invoke when a peer wants to join.
- * @param cls Closure for @a method and @a join_cb.
+ * @param message_cb Function to invoke on message parts received from slaves.
+ * @param join_request_cb Function to invoke when a slave wants to join.
+ * @param master_start_cb Function to invoke after the channel master started.
+ * @param cls Closure for @a method and @a join_cb.
+ *
* @return Handle for the channel master, NULL on error.
*/
struct GNUNET_PSYC_Master *
GNUNET_PSYC_master_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_CRYPTO_EccPrivateKey *channel_key,
+ const struct GNUNET_CRYPTO_EddsaPrivateKey *channel_key,
enum GNUNET_PSYC_Policy policy,
- GNUNET_PSYC_Method method,
- GNUNET_PSYC_JoinCallback join_cb,
- GNUNET_PSYC_MasterStartCallback master_started_cb,
+ GNUNET_PSYC_MasterStartCallback start_cb,
+ GNUNET_PSYC_JoinRequestCallback join_request_cb,
+ GNUNET_PSYC_MessageCallback message_cb,
void *cls)
{
struct GNUNET_PSYC_Master *mst = GNUNET_malloc (sizeof (*mst));
- struct GNUNET_PSYC_Channel *ch = &mst->ch;
- struct MasterStartRequest *req = GNUNET_malloc (sizeof (*req));
+ struct GNUNET_PSYC_Channel *chn = &mst->chn;
- req->header.size = htons (sizeof (*req) + sizeof (*channel_key));
+ struct MasterStartRequest *req = GNUNET_malloc (sizeof (*req));
+ req->header.size = htons (sizeof (*req));
req->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_MASTER_START);
req->channel_key = *channel_key;
req->policy = policy;
- ch->cfg = cfg;
- ch->reconnect_msg = (struct GNUNET_MessageHeader *) req;
- ch->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
- ch->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect, mst);
+ chn->connect_msg = (struct GNUNET_MessageHeader *) req;
+ chn->cfg = cfg;
+ chn->is_master = GNUNET_YES;
- ch->method_cb = method;
- ch->join_cb = join_cb;
- ch->cb_cls = cls;
- mst->start_cb = master_started_cb;
+ mst->start_cb = start_cb;
+ mst->join_req_cb = join_request_cb;
+ mst->cb_cls = cls;
+ chn->client = GNUNET_CLIENT_MANAGER_connect (cfg, "psyc", master_handlers);
+ GNUNET_CLIENT_MANAGER_set_user_context_ (chn->client, mst, sizeof (*chn));
+
+ chn->tmit = GNUNET_PSYC_transmit_create (chn->client);
+ chn->recv = GNUNET_PSYC_receive_create (message_cb, message_cb, cls);
+
+ channel_send_connect_msg (chn);
return mst;
}
-/**
+/**
* Stop a PSYC master channel.
*
* @param master PSYC channel master to stop.
+ * @param keep_active FIXME
*/
void
GNUNET_PSYC_master_stop (struct GNUNET_PSYC_Master *mst)
{
- disconnect (mst);
+ GNUNET_CLIENT_MANAGER_disconnect (mst->chn.client, GNUNET_YES);
GNUNET_free (mst);
}
-/**
+/**
* Function to call with the decision made for a join request.
*
* Must be called once and only once in response to an invocation of the
* #GNUNET_PSYC_JoinCallback.
*
* @param jh Join request handle.
- * @param is_admitted #GNUNET_YES if joining is approved,
- * #GNUNET_NO if it is disapproved.
+ * @param is_admitted #GNUNET_YES if the join is approved,
+ * #GNUNET_NO if it is disapproved,
+ * #GNUNET_SYSERR if we cannot answer the request.
* @param relay_count Number of relays given.
* @param relays Array of suggested peers that might be useful relays to use
* when joining the multicast group (essentially a list of peers that
* be the multicast origin) is a good candidate for building the
* multicast tree. Note that it is unnecessary to specify our own
* peer identity in this array.
- * @param method_name Method name for the message transmitted with the response.
- * @param env Environment containing transient variables for the message, or NULL.
- * @param data Data of the message.
- * @param data_size Size of @a data.
+ * @param join_resp Application-dependent join response message.
+ *
+ * @return #GNUNET_OK on success,
+ * #GNUNET_SYSERR if the message is too large.
*/
-void
+int
GNUNET_PSYC_join_decision (struct GNUNET_PSYC_JoinHandle *jh,
int is_admitted,
- unsigned int relay_count,
+ uint32_t relay_count,
const struct GNUNET_PeerIdentity *relays,
- const char *method_name,
- const struct GNUNET_ENV_Environment *env,
- const void *data,
- size_t data_size)
+ const struct GNUNET_PSYC_MessageHeader *join_resp)
{
+ struct GNUNET_PSYC_Channel *chn = &jh->mst->chn;
+ struct MasterJoinDecision *dcsn;
+ uint16_t join_resp_size
+ = (NULL != join_resp) ? ntohs (join_resp->header.size) : 0;
+ uint16_t relay_size = relay_count * sizeof (*relays);
-}
+ if (GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD
+ < sizeof (*dcsn) + relay_size + join_resp_size)
+ return GNUNET_SYSERR;
+ dcsn = GNUNET_malloc (sizeof (*dcsn) + relay_size + join_resp_size);
+ dcsn->header.size = htons (sizeof (*dcsn) + relay_size + join_resp_size);
+ dcsn->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_JOIN_DECISION);
+ dcsn->is_admitted = htonl (is_admitted);
+ dcsn->slave_key = jh->slave_key;
-/* FIXME: split up value into <64K chunks and transmit the continuations in
- * MOD_CONT msgs */
-int
-send_modifier (void *cls, struct GNUNET_ENV_Modifier *mod)
-{
- struct GNUNET_PSYC_Channel *ch = cls;
- size_t name_size = strlen (mod->name) + 1;
- struct GNUNET_PSYC_MessageModifier *pmod;
- struct OperationHandle *op = GNUNET_malloc (sizeof (*op) + sizeof (*pmod)
- + name_size + mod->value_size);
- pmod = (struct GNUNET_PSYC_MessageModifier *) &op[1];
- op->msg = (struct GNUNET_MessageHeader *) pmod;
-
- pmod->header.type = GNUNET_MESSAGE_TYPE_PSYC_TRANSMIT_MODIFIER;
- pmod->header.size = htons (sizeof (*pmod) + name_size + mod->value_size);
- pmod->name_size = htons (name_size);
- memcpy (&pmod[1], mod->name, name_size);
- memcpy ((void *) &pmod[1] + name_size, mod->value, mod->value_size);
-
- GNUNET_CONTAINER_DLL_insert (ch->transmit_head, ch->transmit_tail, op);
- return GNUNET_YES;
+ if (0 < join_resp_size)
+ memcpy (&dcsn[1], join_resp, join_resp_size);
+
+ GNUNET_CLIENT_MANAGER_transmit (chn->client, &dcsn->header);
+ return GNUNET_OK;
}
-/**
+/**
* Send a message to call a method to all members in the PSYC channel.
*
- * @param mst Handle to the PSYC channel.
+ * @param master Handle to the PSYC channel.
* @param method_name Which method should be invoked.
- * @param env Environment containing state operations and transient variables
- * for the message, or NULL.
- * @param notify Function to call to obtain the arguments.
- * @param notify_cls Closure for @a notify.
+ * @param notify_mod Function to call to obtain modifiers.
+ * @param notify_data Function to call to obtain fragments of the data.
+ * @param notify_cls Closure for @a notify_mod and @a notify_data.
* @param flags Flags for the message being transmitted.
- * @return Transmission handle, NULL on error (i.e. more than one request
- * queued).
+ *
+ * @return Transmission handle, NULL on error (i.e. more than one request queued).
*/
struct GNUNET_PSYC_MasterTransmitHandle *
GNUNET_PSYC_master_transmit (struct GNUNET_PSYC_Master *mst,
const char *method_name,
- const struct GNUNET_ENV_Environment *env,
- GNUNET_PSYC_MasterTransmitNotify notify,
+ GNUNET_PSYC_TransmitNotifyModifier notify_mod,
+ GNUNET_PSYC_TransmitNotifyData notify_data,
void *notify_cls,
enum GNUNET_PSYC_MasterTransmitFlags flags)
{
- GNUNET_assert (NULL != mst);
- struct GNUNET_PSYC_Channel *ch = &mst->ch;
- if (GNUNET_NO != ch->in_transmit)
+ if (GNUNET_OK
+ == GNUNET_PSYC_transmit_message (mst->chn.tmit, method_name, NULL,
+ notify_mod, notify_data, notify_cls,
+ flags))
+ return (struct GNUNET_PSYC_MasterTransmitHandle *) mst->chn.tmit;
+ else
return NULL;
- ch->in_transmit = GNUNET_YES;
-
- struct GNUNET_PSYC_MessageMethod *pmeth;
- struct OperationHandle *op = GNUNET_malloc (sizeof (*op) + sizeof (*pmeth));
- pmeth = (struct GNUNET_PSYC_MessageMethod *) &op[1];
- op->msg = (struct GNUNET_MessageHeader *) pmeth;
-
- pmeth->header.type = GNUNET_MESSAGE_TYPE_PSYC_TRANSMIT_METHOD;
- size_t size = strlen (method_name) + 1;
- pmeth->header.size = htons (sizeof (*pmeth) + size);
- pmeth->flags = htonl (flags);
- pmeth->mod_count
- = GNUNET_ntohll (GNUNET_ENV_environment_get_mod_count (env));
- memcpy (&pmeth[1], method_name, size);
-
- GNUNET_CONTAINER_DLL_insert (ch->transmit_head, ch->transmit_tail, op);
-
- GNUNET_ENV_environment_iterate (env, send_modifier, mst);
-
- struct GNUNET_PSYC_MasterTransmitHandle *th = GNUNET_malloc (sizeof (*th));
- th->master = mst;
- th->env = env;
- th->notify = notify;
- th->notify_cls = notify_cls;
- return th;
}
-/**
+/**
+ * Resume transmission to the channel.
+ *
+ * @param tmit Handle of the request that is being resumed.
+ */
+void
+GNUNET_PSYC_master_transmit_resume (struct GNUNET_PSYC_MasterTransmitHandle *tmit)
+{
+ GNUNET_PSYC_transmit_resume ((struct GNUNET_PSYC_TransmitHandle *) tmit);
+}
+
+
+/**
* Abort transmission request to the channel.
*
- * @param th Handle of the request that is being aborted.
+ * @param tmit Handle of the request that is being aborted.
*/
void
-GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *th)
+GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *tmit)
{
- struct GNUNET_PSYC_Master *mst = th->master;
- struct GNUNET_PSYC_Channel *ch = &mst->ch;
- if (GNUNET_NO != ch->in_transmit)
- return;
+ GNUNET_PSYC_transmit_cancel ((struct GNUNET_PSYC_TransmitHandle *) tmit);
+}
+
-
+/**
+ * Convert a channel @a master to a @e channel handle to access the @e channel
+ * APIs.
+ *
+ * @param master Channel master handle.
+ *
+ * @return Channel handle, valid for as long as @a master is valid.
+ */
+struct GNUNET_PSYC_Channel *
+GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master)
+{
+ return &master->chn;
}
-/**
+/**
* Join a PSYC channel.
*
* The entity joining is always the local peer. The user must immediately use
* notification on failure (as the channel may simply take days to approve,
* and disapproval is simply being ignored).
*
- * @param cfg Configuration to use.
- * @param channel_key ECC public key that identifies the channel we wish to join.
- * @param slave_key ECC private-public key pair that identifies the slave, and
+ * @param cfg Configuration to use.
+ * @param channel_key ECC public key that identifies the channel we wish to join.
+ * @param slave_key ECC private-public key pair that identifies the slave, and
* used by multicast to sign the join request and subsequent unicast
* requests sent to the master.
- * @param origin Peer identity of the origin.
- * @param relay_count Number of peers in the @a relays array.
- * @param relays Peer identities of members of the multicast group, which serve
+ * @param origin Peer identity of the origin.
+ * @param relay_count Number of peers in the @a relays array.
+ * @param relays Peer identities of members of the multicast group, which serve
* as relays and used to join the group at.
- * @param method Function to invoke on messages received from the channel,
- * typically at least contains functions for @e join and @e part.
- * @param join_cb Function to invoke when a peer wants to join.
- * @param cls Closure for @a method_cb and @a join_cb.
- * @param method_name Method name for the join request.
- * @param env Environment containing transient variables for the request, or NULL.
- * @param data Payload for the join message.
- * @param data_size Number of bytes in @a data.
+ * @param message_cb Function to invoke on message parts received from the
+ * channel, typically at least contains method handlers for @e join and
+ * @e part.
+ * @param slave_connect_cb Function invoked once we have connected to the
+ * PSYC service.
+ * @param join_decision_cb Function invoked once we have received a join
+ * decision.
+ * @param cls Closure for @a message_cb and @a slave_joined_cb.
+ * @param method_name Method name for the join request.
+ * @param env Environment containing transient variables for the request, or NULL.
+ * @param data Payload for the join message.
+ * @param data_size Number of bytes in @a data.
+ *
* @return Handle for the slave, NULL on error.
*/
struct GNUNET_PSYC_Slave *
GNUNET_PSYC_slave_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_CRYPTO_EccPublicSignKey *channel_key,
- const struct GNUNET_CRYPTO_EccPrivateKey *slave_key,
+ const struct GNUNET_CRYPTO_EddsaPublicKey *channel_key,
+ const struct GNUNET_CRYPTO_EddsaPrivateKey *slave_key,
const struct GNUNET_PeerIdentity *origin,
- size_t relay_count,
+ uint32_t relay_count,
const struct GNUNET_PeerIdentity *relays,
- GNUNET_PSYC_Method method,
- GNUNET_PSYC_JoinCallback join_cb,
- GNUNET_PSYC_SlaveJoinCallback slave_joined_cb,
+ GNUNET_PSYC_MessageCallback message_cb,
+ GNUNET_PSYC_SlaveConnectCallback connect_cb,
+ GNUNET_PSYC_JoinDecisionCallback join_decision_cb,
void *cls,
const char *method_name,
const struct GNUNET_ENV_Environment *env,
const void *data,
- size_t data_size)
+ uint16_t data_size)
{
struct GNUNET_PSYC_Slave *slv = GNUNET_malloc (sizeof (*slv));
- struct GNUNET_PSYC_Channel *ch = &slv->ch;
- struct SlaveJoinRequest *req = GNUNET_malloc (sizeof (*req));
-
+ struct GNUNET_PSYC_Channel *chn = &slv->chn;
+ struct SlaveJoinRequest *req
+ = GNUNET_malloc (sizeof (*req) + relay_count * sizeof (*relays));
req->header.size = htons (sizeof (*req)
- + sizeof (*channel_key) + sizeof (*slave_key)
+ relay_count * sizeof (*relays));
req->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_SLAVE_JOIN);
req->channel_key = *channel_key;
req->slave_key = *slave_key;
- req->relay_count = relay_count;
+ req->origin = *origin;
+ req->relay_count = htonl (relay_count);
memcpy (&req[1], relays, relay_count * sizeof (*relays));
- ch->cfg = cfg;
- ch->reconnect_msg = (struct GNUNET_MessageHeader *) req;
- ch->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
- ch->reconnect_task = GNUNET_SCHEDULER_add_now (&reconnect, slv);
+ chn->connect_msg = (struct GNUNET_MessageHeader *) req;
+ chn->cfg = cfg;
+ chn->is_master = GNUNET_NO;
+ slv->connect_cb = connect_cb;
+ slv->join_dcsn_cb = join_decision_cb;
+ slv->cb_cls = cls;
+
+ chn->client = GNUNET_CLIENT_MANAGER_connect (cfg, "psyc", slave_handlers);
+ GNUNET_CLIENT_MANAGER_set_user_context_ (chn->client, slv, sizeof (*chn));
+
+ chn->recv = GNUNET_PSYC_receive_create (message_cb, message_cb, cls);
+ chn->tmit = GNUNET_PSYC_transmit_create (chn->client);
+
+ channel_send_connect_msg (chn);
return slv;
}
-/**
+/**
* Part a PSYC channel.
*
* Will terminate the connection to the PSYC service. Polite clients should
- * first explicitly send a @e part request (via GNUNET_PSYC_slave_transmit()).
+ * first explicitly send a part request (via GNUNET_PSYC_slave_transmit()).
*
- * @param slv Slave handle.
+ * @param slave Slave handle.
*/
void
GNUNET_PSYC_slave_part (struct GNUNET_PSYC_Slave *slv)
{
- disconnect (slv);
+ GNUNET_CLIENT_MANAGER_disconnect (slv->chn.client, GNUNET_YES);
GNUNET_free (slv);
}
-/**
+/**
* Request a message to be sent to the channel master.
*
* @param slave Slave handle.
* @param method_name Which (PSYC) method should be invoked (on host).
- * @param env Environment containing transient variables for the message, or
- * NULL.
- * @param notify Function to call when we are allowed to transmit (to get data).
+ * @param notify_mod Function to call to obtain modifiers.
+ * @param notify_data Function to call to obtain fragments of the data.
* @param notify_cls Closure for @a notify.
* @param flags Flags for the message being transmitted.
+ *
* @return Transmission handle, NULL on error (i.e. more than one request
* queued).
*/
struct GNUNET_PSYC_SlaveTransmitHandle *
-GNUNET_PSYC_slave_transmit (struct GNUNET_PSYC_Slave *slave,
+GNUNET_PSYC_slave_transmit (struct GNUNET_PSYC_Slave *slv,
const char *method_name,
- const struct GNUNET_ENV_Environment *env,
- GNUNET_PSYC_SlaveTransmitNotify notify,
+ GNUNET_PSYC_TransmitNotifyModifier notify_mod,
+ GNUNET_PSYC_TransmitNotifyData notify_data,
void *notify_cls,
enum GNUNET_PSYC_SlaveTransmitFlags flags)
+
{
- return NULL;
+ if (GNUNET_OK
+ == GNUNET_PSYC_transmit_message (slv->chn.tmit, method_name, NULL,
+ notify_mod, notify_data, notify_cls,
+ flags))
+ return (struct GNUNET_PSYC_SlaveTransmitHandle *) slv->chn.tmit;
+ else
+ return NULL;
}
-/**
- * Abort transmission request to master.
+/**
+ * Resume transmission to the master.
*
- * @param th Handle of the request that is being aborted.
+ * @param tmit Handle of the request that is being resumed.
*/
void
-GNUNET_PSYC_slave_transmit_cancel (struct GNUNET_PSYC_SlaveTransmitHandle *th)
+GNUNET_PSYC_slave_transmit_resume (struct GNUNET_PSYC_SlaveTransmitHandle *tmit)
{
-
+ GNUNET_PSYC_transmit_resume ((struct GNUNET_PSYC_TransmitHandle *) tmit);
}
-/**
- * Convert a channel @a master to a @e channel handle to access the @e channel
- * APIs.
+/**
+ * Abort transmission request to master.
*
- * @param master Channel master handle.
- * @return Channel handle, valid for as long as @a master is valid.
+ * @param tmit Handle of the request that is being aborted.
*/
-struct GNUNET_PSYC_Channel *
-GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master)
+void
+GNUNET_PSYC_slave_transmit_cancel (struct GNUNET_PSYC_SlaveTransmitHandle *tmit)
{
- return (struct GNUNET_PSYC_Channel *) master;
+ GNUNET_PSYC_transmit_cancel ((struct GNUNET_PSYC_TransmitHandle *) tmit);
}
-/**
+/**
* Convert @a slave to a @e channel handle to access the @e channel APIs.
*
- * @param slave Slave handle.
+ * @param slv Slave handle.
+ *
* @return Channel handle, valid for as long as @a slave is valid.
*/
struct GNUNET_PSYC_Channel *
-GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slave)
+GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slv)
{
- return (struct GNUNET_PSYC_Channel *) slave;
+ return &slv->chn;
}
-/**
+/**
* Add a slave to the channel's membership list.
*
* Note that this will NOT generate any PSYC traffic, it will merely update the
* correctly; not doing so correctly will result in either denying other slaves
* access or offering access to channel data to non-members.
*
- * @param ch Channel handle.
+ * @param channel Channel handle.
* @param slave_key Identity of channel slave to add.
* @param announced_at ID of the message that announced the membership change.
* @param effective_since Addition of slave is in effect since this message ID.
*/
void
-GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *ch,
- const struct GNUNET_CRYPTO_EccPublicSignKey
- *slave_key,
+GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *chn,
+ const struct GNUNET_CRYPTO_EddsaPublicKey *slave_key,
uint64_t announced_at,
uint64_t effective_since)
{
- struct ChannelSlaveAdd *slvadd;
- struct OperationHandle *op = GNUNET_malloc (sizeof (*op) + sizeof (*slvadd));
- slvadd = (struct ChannelSlaveAdd *) &op[1];
- op->msg = (struct GNUNET_MessageHeader *) slvadd;
-
- slvadd->header.type = GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_SLAVE_ADD;
- slvadd->header.size = htons (sizeof (*slvadd));
- slvadd->announced_at = GNUNET_htonll (announced_at);
- slvadd->effective_since = GNUNET_htonll (effective_since);
-
- GNUNET_CONTAINER_DLL_insert (ch->transmit_head, ch->transmit_tail, op);
- transmit_next (ch);
+ struct ChannelSlaveAdd *add = GNUNET_malloc (sizeof (*add));
+ add->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_SLAVE_ADD);
+ add->header.size = htons (sizeof (*add));
+ add->announced_at = GNUNET_htonll (announced_at);
+ add->effective_since = GNUNET_htonll (effective_since);
+ GNUNET_CLIENT_MANAGER_transmit (chn->client, &add->header);
}
-/**
+/**
* Remove a slave from the channel's membership list.
*
* Note that this will NOT generate any PSYC traffic, it will merely update the
* denying members access or offering access to channel data to
* non-members.
*
- * @param ch Channel handle.
+ * @param channel Channel handle.
* @param slave_key Identity of channel slave to remove.
* @param announced_at ID of the message that announced the membership change.
*/
void
-GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *ch,
- const struct GNUNET_CRYPTO_EccPublicSignKey
- *slave_key,
+GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *chn,
+ const struct GNUNET_CRYPTO_EddsaPublicKey *slave_key,
uint64_t announced_at)
{
- struct ChannelSlaveRemove *slvrm;
- struct OperationHandle *op = GNUNET_malloc (sizeof (*op) + sizeof (*slvrm));
- slvrm = (struct ChannelSlaveRemove *) &op[1];
- op->msg = (struct GNUNET_MessageHeader *) slvrm;
-
- slvrm->header.type = GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_SLAVE_RM;
- slvrm->header.size = htons (sizeof (*slvrm));
- slvrm->announced_at = GNUNET_htonll (announced_at);
-
- GNUNET_CONTAINER_DLL_insert (ch->transmit_head, ch->transmit_tail, op);
- transmit_next (ch);
+ struct ChannelSlaveRemove *rm = GNUNET_malloc (sizeof (*rm));
+ rm->header.type = htons (GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_SLAVE_RM);
+ rm->header.size = htons (sizeof (*rm));
+ rm->announced_at = GNUNET_htonll (announced_at);
+ GNUNET_CLIENT_MANAGER_transmit (chn->client, &rm->header);
}
-/**
+/**
* Request to be told the message history of the channel.
*
* Historic messages (but NOT the state at the time) will be replayed (given to
*
* To get the latest message, use 0 for both the start and end message ID.
*
- * @param ch Which channel should be replayed?
+ * @param channel Which channel should be replayed?
* @param start_message_id Earliest interesting point in history.
* @param end_message_id Last (exclusive) interesting point in history.
- * @param method Function to invoke on messages received from the story.
+ * @param message_cb Function to invoke on message parts received from the story.
* @param finish_cb Function to call when the requested story has been fully
* told (counting message IDs might not suffice, as some messages
* might be secret and thus the listener would not know the story is
- * finished without being told explicitly)
-{
- return NULL;
-} once this function
+ * finished without being told explicitly) once this function
* has been called, the client must not call
* GNUNET_PSYC_channel_story_tell_cancel() anymore.
* @param cls Closure for the callbacks.
+ *
* @return Handle to cancel story telling operation.
*/
struct GNUNET_PSYC_Story *
-GNUNET_PSYC_channel_story_tell (struct GNUNET_PSYC_Channel *ch,
+GNUNET_PSYC_channel_story_tell (struct GNUNET_PSYC_Channel *channel,
uint64_t start_message_id,
uint64_t end_message_id,
- GNUNET_PSYC_Method method,
- GNUNET_PSYC_FinishCallback *finish_cb,
+ GNUNET_PSYC_MessageCallback message_cb,
+ GNUNET_PSYC_FinishCallback finish_cb,
void *cls)
{
return NULL;
}
-/**
+/**
* Abort story telling.
*
* This function must not be called from within method handlers (as given to
}
-/**
+/**
* Retrieve the best matching channel state variable.
*
* If the requested variable name is not present in the state, the nearest
* @param cb Function called once when a matching state variable is found.
* Not called if there's no matching state variable.
* @param cb_cls Closure for the callbacks.
+ *
* @return Handle that can be used to cancel the query operation.
*/
struct GNUNET_PSYC_StateQuery *
}
-/**
+/**
* Return all channel state variables whose name matches a given prefix.
*
* A name matches if it starts with the given @a name_prefix, thus requesting
* @param name_prefix Prefix of the state variable name to match.
* @param cb Function to call with the matching state variables.
* @param cb_cls Closure for the callbacks.
+ *
* @return Handle that can be used to cancel the query operation.
*/
struct GNUNET_PSYC_StateQuery *
}
-/**
+/**
* Cancel a state query operation.
*
* @param query Handle for the operation to cancel.