/*
This file is part of GNUnet.
- (C) 2012, 2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2012, 2013 GNUnet e.V.
- GNUnet is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
- * @file include/gnunet_psyc_service.h
- * @brief PSYC service; high-level access to the PSYC protocol
- * note that clients of this API are NOT expected to
- * understand the PSYC message format, only the semantics!
- * Parsing (and serializing) the PSYC stream format is done
- * within the implementation of the libgnunetpsyc library,
- * and this API deliberately exposes as little as possible
- * of the actual data stream format to the application!
- * @author Christian Grothoff
* @author Gabor X Toth
+ * @author Christian Grothoff
+ *
+ * @file
+ * PSYC service
+ *
+ * @defgroup psyc PSYC service
+ * Send/receive messages in PSYC channels and access the PSYC Store.
+ *
+ * Note that clients of this API are NOT expected to understand the PSYC message
+ * format, only the semantics! Parsing (and serializing) the PSYC stream format
+ * is done within the implementation of the libgnunetpsyc library, and this API
+ * deliberately exposes as little as possible of the actual data stream format
+ * to the application!
*
* NOTE:
- * - this API does not know about psyc's "root" and "places";
- * there is no 'root' in GNUnet-Psyc as we're decentralized;
+ * - this API does not know about PSYC's "root" and "places";
+ * there is no 'root' in GNUnet-PSYC as we're decentralized;
* 'places' and 'persons' are combined within the same
* abstraction, that of a "channel". Channels are identified
* and accessed in this API using a public/private key.
* - PSYC defines standard variables, methods, etc. This
* library deliberately abstracts over all of these; a
* higher-level API should combine the naming system (GNS)
- * and standard methods (message, join, part, warn,
- * fail, error) and variables (action, color, time,
- * tag, etc.). However, this API does take over the
- * routing variables, specifically 'context' (channel),
- * and 'source'. We only kind-of support 'target', as
+ * and standard methods (_converse, _notice, _request,
+ * _warning, _error etc) and variables (_action, _color,
+ * _time, etc). However, this API does take over the
+ * routing variables, specifically '_context' (channel),
+ * and '_source'. We only kind-of support '_target', as
* the target is either everyone in the group or the
* origin, and never just a single member of the group;
* for such individual messages, an application needs to
* be called 'PSYC-low', whereas a higher-level API
* implementing defaults for standard methods and
* variables might be called 'PSYC-std' or 'PSYC-high'.
+ *
+ * In PSYC terminology this is simply called the "PSYC
+ * routing layer" and the abstractions, for instance in
+ * psyced, are quite similar. The higher one is called
+ * "PSYC entity layer." In the text rendering of the
+ * protocol the two are separated by an empty line. See
+ * http://about.psyc.eu/Spec:Packet and related. --lynX
+ *
+ * @{
*/
#ifndef GNUNET_PSYC_SERVICE_H
#endif
#include "gnunet_util_lib.h"
-#include "gnunet_env_lib.h"
#include "gnunet_multicast_service.h"
//Mingw work around
#ifdef MINGW
/**
* Header of a PSYC message.
*
- * Only present when receiving a message.
+ * The PSYC service adds this when delivering the message to local clients,
+ * not present on the multicast layer.
*/
struct GNUNET_PSYC_MessageHeader
{
/**
* Byte offset of this @e fragment of the @e message.
- * FIXME: use data_offset instead
*/
uint64_t fragment_offset GNUNET_PACKED;
* Sending slave's public key.
* Not set if the message is from the master.
*/
- struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
+ struct GNUNET_CRYPTO_EcdsaPublicKey slave_pub_key;
/* Followed by concatenated PSYC message parts:
* messages with GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_* types
uint16_t name_size GNUNET_PACKED;
/**
- * enum GNUNET_ENV_Operator
+ * enum GNUNET_PSYC_Operator
*/
uint8_t oper;
/**
* Public key of the joining slave.
*/
- struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
+ struct GNUNET_CRYPTO_EcdsaPublicKey slave_pub_key;
/* Followed by struct GNUNET_MessageHeader join_request */
};
* Only set when the master is sending the decision,
* not set when a slave is receiving it.
*/
- struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
+ struct GNUNET_CRYPTO_EcdsaPublicKey slave_pub_key;
/* Followed by struct GNUNET_MessageHeader join_response */
};
+
+enum GNUNET_PSYC_HistoryReplayFlags
+{
+ /**
+ * Replay locally available messages.
+ */
+ GNUNET_PSYC_HISTORY_REPLAY_LOCAL = 0,
+
+ /**
+ * Replay messages from remote peers if not found locally.
+ */
+ GNUNET_PSYC_HISTORY_REPLAY_REMOTE = 1,
+};
+
+
+struct GNUNET_PSYC_HistoryRequestMessage
+{
+ /**
+ * Type: GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_HISTORY_REPLAY
+ */
+ struct GNUNET_MessageHeader header;
+
+ /**
+ * @see enum GNUNET_PSYC_HistoryReplayFlags
+ */
+ uint32_t flags GNUNET_PACKED;
+
+ /**
+ * ID for this operation.
+ */
+ uint64_t op_id GNUNET_PACKED;
+
+ uint64_t start_message_id GNUNET_PACKED;
+
+ uint64_t end_message_id GNUNET_PACKED;
+
+ uint64_t message_limit GNUNET_PACKED;
+
+ /* Followed by NUL-terminated method name prefix. */
+};
+
+
+struct GNUNET_PSYC_StateRequestMessage
+{
+ /**
+ * Types:
+ * - GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_GET
+ * - GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_GET_PREFIX
+ */
+ struct GNUNET_MessageHeader header;
+
+ uint32_t reserved GNUNET_PACKED;
+
+ /**
+ * ID for this operation.
+ */
+ uint64_t op_id GNUNET_PACKED;
+
+ /* Followed by NUL-terminated name. */
+};
+
+
+/**** service -> library ****/
+
+
+/**
+ * Answer from service to client about last operation.
+ */
+struct GNUNET_PSYC_OperationResultMessage
+{
+ /**
+ * Types:
+ * - GNUNET_MESSAGE_TYPE_PSYC_RESULT_CODE
+ * - GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_RESULT
+ */
+ struct GNUNET_MessageHeader header;
+
+ uint32_t reserved GNUNET_PACKED;
+
+ /**
+ * Operation ID.
+ */
+ uint64_t op_id GNUNET_PACKED;
+
+ /**
+ * Status code for the operation.
+ */
+ uint64_t result_code GNUNET_PACKED;
+
+ /* Followed by:
+ * - on error: NUL-terminated error message
+ * - on success: one of the following message types
+ *
+ * For a STATE_RESULT, one of:
+ * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
+ * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT
+ * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_END
+ */
+};
+
GNUNET_NETWORK_STRUCT_END
*/
typedef void
(*GNUNET_PSYC_MessageCallback) (void *cls,
- uint64_t message_id,
- uint32_t flags,
const struct GNUNET_PSYC_MessageHeader *msg);
/**
* Method called from PSYC upon receiving part of a message.
*
- * @param cls Closure.
- * @param message_id Sequence number of the message.
- * @param data_offset Byte offset of data, only set if @a msg has a type
- * #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA
- * @param flags OR'ed GNUNET_PSYC_MessageFlags
+ * @param cls
+ * Closure.
+ * @param slave_pub_key
+ * Public key of the slave sending the message.
+ * Only set for channel master.
+ * @param message_id
+ * Sequence number of the message.
+ * @param flags
+ * OR'ed GNUNET_PSYC_MessageFlags
+ * @param fragment_offset
+ * Multicast message fragment offset.
* @param msg Message part, one of the following types:
* - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_HEADER
* - #GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
*/
typedef void
(*GNUNET_PSYC_MessagePartCallback) (void *cls,
- uint64_t message_id,
- uint64_t data_offset,
- uint32_t flags,
- const struct GNUNET_MessageHeader *msg);
+ const struct GNUNET_PSYC_MessageHeader *msg,
+ const struct GNUNET_MessageHeader *pmsg);
/**
* Method called from PSYC upon receiving a join request.
*
- * @param cls Closure.
- * @param slave_key Public key of the slave requesting join.
- * @param join_msg Join message sent along with the request.
- * @param jh Join handle to use with GNUNET_PSYC_join_decision()
+ * @param cls
+ * Closure.
+ * @param slave_pub_key
+ * Public key of the slave requesting join.
+ * @param join_msg
+ * Join message sent along with the request.
+ * @param jh
+ * Join handle to use with GNUNET_PSYC_join_decision()
*/
typedef void
(*GNUNET_PSYC_JoinRequestCallback) (void *cls,
const struct GNUNET_PSYC_JoinRequestMessage *req,
- const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
+ const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_pub_key,
const struct GNUNET_PSYC_Message *join_msg,
struct GNUNET_PSYC_JoinHandle *jh);
/**
- * Function called after connected to the PSYC service
- * and the channel master started.
+ * Function called once we are connected to the PSYC service
+ * and the channel master is started.
*
- * Also called when reconnected to the service
+ * Also called when we reconnected to the service
* after the connection closed unexpectedly.
*
* @param cls
GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *th);
+/**
+ * Relay a message
+ *
+ * @param master Handle to the PSYC channel.
+ * @param method_name Which method should be invoked.
+ * @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).
+ */
+struct GNUNET_PSYC_MasterTransmitHandle *
+GNUNET_PSYC_master_relay (struct GNUNET_PSYC_Master *master,
+ uint64_t message_id);
+
+
/**
* Stop a PSYC master channel.
*
int is_admitted,
const struct GNUNET_PSYC_Message *join_msg);
+/**
+ * Flags for GNUNET_PSYC_slave_join()
+ */
+enum GNUNET_PSYC_SlaveJoinFlags
+{
+ GNUNET_PSYC_SLAVE_JOIN_NONE = 0,
+
+ /**
+ * Local join for history access, no network connection is established.
+ */
+ GNUNET_PSYC_SLAVE_JOIN_LOCAL = 1,
+};
+
/**
* Join a PSYC channel.
* 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_pub_key
+ * ECC public key that identifies the channel we wish to join.
+ * @param slave_pub_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 flags
+ * Join flags.
+ * @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 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.
+ * @param message_cb
+ * Function to invoke on message fragments received from the channel.
+ * @param message_part_cb
+ * Function to invoke on message parts received from the channel.
+ * @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 join_msg
+ * Join message.
*
* @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_EddsaPublicKey *channel_key,
- const struct GNUNET_CRYPTO_EcdsaPrivateKey *slave_key,
+ const struct GNUNET_CRYPTO_EddsaPublicKey *channel_pub_key,
+ const struct GNUNET_CRYPTO_EcdsaPrivateKey *slave_pub_key,
+ enum GNUNET_PSYC_SlaveJoinFlags flags,
const struct GNUNET_PeerIdentity *origin,
uint32_t relay_count,
const struct GNUNET_PeerIdentity *relays,
struct GNUNET_PSYC_Channel;
-/**
- * Function called with the result of an asynchronous operation.
- *
- * @param cls
- * Closure.
- * @param result
- * Result of the operation.
- * Usually one of #GNUNET_OK, #GNUNET_YES, #GNUNET_NO, or #GNUNET_SYSERR.
- * @param err_msg
- * Error message.
- */
-typedef void
-(*GNUNET_PSYC_ResultCallback) (void *cls,
- int64_t result,
- const char *err_msg);
-
-
/**
* Convert a channel @a master to a @e channel handle to access the @e channel
* APIs.
* correctly; not doing so correctly will result in either denying other slaves
* access or offering access to channel data to non-members.
*
- * @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.
+ * @param channel
+ * Channel handle.
+ * @param slave_pub_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.
+ * @param result_cb
+ * Function to call with the result of the operation.
+ * The @e result_code argument is #GNUNET_OK on success, or
+ * #GNUNET_SYSERR on error. In case of an error, the @e data argument
+ * can contain an optional error message.
+ * @param cls
+ * Closure for @a result_cb.
*/
void
GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *channel,
- const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_key,
+ const struct GNUNET_CRYPTO_EcdsaPublicKey *slave_pub_key,
uint64_t announced_at,
uint64_t effective_since,
- GNUNET_PSYC_ResultCallback result_cb,
+ GNUNET_ResultCallback result_cb,
void *cls);
* denying members access or offering access to channel data to
* non-members.
*
- * @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.
+ * @param channel
+ * Channel handle.
+ * @param slave_pub_key
+ * Identity of channel slave to remove.
+ * @param announced_at
+ * ID of the message that announced the membership change.
+ * @param result_cb
+ * Function to call with the result of the operation.
+ * The @e result_code argument is #GNUNET_OK on success, or
+ * #GNUNET_SYSERR on error. In case of an error, the @e data argument
+ * can contain an optional error message.
+ * @param cls
+ * Closure for @a result_cb.
*/
void
GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *channel,
const struct GNUNET_CRYPTO_EcdsaPublicKey
- *slave_key,
+ *slave_pub_key,
uint64_t announced_at,
- GNUNET_PSYC_ResultCallback result_cb,
+ GNUNET_ResultCallback result_cb,
void *cls);
/**
- * Function called to inform a member about stored state values for a channel.
- *
- * @param cls Closure.
- * @param name Name of the state variable. A NULL value indicates that there
- * are no more state variables to be returned.
- * @param value Value of the state variable.
- * @param value_size Number of bytes in @a value.
+ * History request handle.
*/
-typedef void
-(*GNUNET_PSYC_StateVarCallback) (void *cls,
- const char *name,
- const void *value,
- size_t value_size);
+struct GNUNET_PSYC_HistoryRequest;
/**
* Earliest interesting point in history.
* @param end_message_id
* Last (inclusive) interesting point in history.
- * @param finish_cb
- * Function to call when the requested history has been fully replayed
- * (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)o once this function has been called, the
- * client must not call GNUNET_PSYC_channel_history_replay_cancel() anymore.
+ * @param method_prefix
+ * Retrieve only messages with a matching method prefix.
+ * @param flags
+ * OR'ed enum GNUNET_PSYC_HistoryReplayFlags
+ * @param result_cb
+ * Function to call when the requested history has been fully replayed.
+ * Once this function has been called, the client must not call
+ * GNUNET_PSYC_channel_history_replay_cancel() anymore.
* @param cls
* Closure for the callbacks.
*
* @return Handle to cancel history replay operation.
*/
-void
+struct GNUNET_PSYC_HistoryRequest *
GNUNET_PSYC_channel_history_replay (struct GNUNET_PSYC_Channel *channel,
uint64_t start_message_id,
uint64_t end_message_id,
- GNUNET_PSYC_ResultCallback finish_cb,
+ const char *method_prefix,
+ uint32_t flags,
+ GNUNET_PSYC_MessageCallback message_cb,
+ GNUNET_PSYC_MessagePartCallback message_part_cb,
+ GNUNET_ResultCallback result_cb,
void *cls);
* Which channel should be replayed?
* @param message_limit
* Maximum number of messages to replay.
+ * @param flags
+ * OR'ed enum GNUNET_PSYC_HistoryReplayFlags
* @param finish_cb
* Function to call when the requested history has been fully replayed
* (counting message IDs might not suffice, as some messages might be
*
* @return Handle to cancel history replay operation.
*/
-void
+struct GNUNET_PSYC_HistoryRequest *
GNUNET_PSYC_channel_history_replay_latest (struct GNUNET_PSYC_Channel *channel,
uint64_t message_limit,
- GNUNET_PSYC_ResultCallback finish_cb,
+ const char *method_prefix,
+ uint32_t flags,
+ GNUNET_PSYC_MessageCallback message_cb,
+ GNUNET_PSYC_MessagePartCallback message_part_cb,
+ GNUNET_ResultCallback result_cb,
void *cls);
+void
+GNUNET_PSYC_channel_history_replay_cancel (struct GNUNET_PSYC_Channel *channel,
+ struct GNUNET_PSYC_HistoryRequest *hr);
+
+
+/**
+ * Function called to inform a member about stored state values for a channel.
+ *
+ * If @a full_value_size > value_size then this function is called multiple
+ * times until the whole value arrived.
+ *
+ * @param cls
+ * Closure.
+ * @param name
+ * Name of the state variable.
+ * NULL if there are no more state variables to be returned.
+ * @param value
+ * Value of the state variable.
+ * @param value_size
+ * Number of bytes in @a value.
+ * @param full_value_size
+ * Number of bytes in the full value, including continuations.
+ * Only set for the first part of a variable,
+ * in case of a continuation it is 0.
+ */
+typedef void
+(*GNUNET_PSYC_StateVarCallback) (void *cls,
+ const struct GNUNET_MessageHeader *mod,
+ const char *name,
+ const void *value,
+ uint32_t value_size,
+ uint32_t full_value_size);
+
+
+/**
+ * State request handle.
+ */
+struct GNUNET_PSYC_StateRequest;
+
+
/**
* Retrieve the best matching channel state variable.
*
* @param cls
* Closure for the callbacks.
*/
-void
+struct GNUNET_PSYC_StateRequest *
GNUNET_PSYC_channel_state_get (struct GNUNET_PSYC_Channel *channel,
const char *full_name,
GNUNET_PSYC_StateVarCallback var_cb,
- GNUNET_PSYC_ResultCallback result_cb,
+ GNUNET_ResultCallback result_cb,
void *cls);
* @param cls
* Closure for the callbacks.
*/
-void
+struct GNUNET_PSYC_StateRequest *
GNUNET_PSYC_channel_state_get_prefix (struct GNUNET_PSYC_Channel *channel,
const char *name_prefix,
GNUNET_PSYC_StateVarCallback var_cb,
- GNUNET_PSYC_ResultCallback result_cb,
+ GNUNET_ResultCallback result_cb,
void *cls);
+/**
+ * Cancel a state request operation.
+ *
+ * @param sr
+ * Handle for the operation to cancel.
+ */
+void
+GNUNET_PSYC_channel_state_get_cancel (struct GNUNET_PSYC_StateRequest *sr);
+
+
#if 0 /* keep Emacsens' auto-indent happy */
{
/* ifndef GNUNET_PSYC_SERVICE_H */
#endif
-/* end of gnunet_psyc_service.h */
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff