Boston, MA 02111-1307, USA.
*/
-/**
+/**
* @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
#include "gnunet_multicast_service.h"
-/**
+/**
* Version number of GNUnet-PSYC API.
*/
#define GNUNET_PSYC_VERSION 0x00000000
-/**
+/**
* Policy flags for a channel.
*/
enum GNUNET_PSYC_ChannelFlags
GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY = 1 << 1,
};
-/**
+/**
* PSYC channel policies.
*/
enum GNUNET_PSYC_Policy
*/
GNUNET_PSYC_CHANNEL_ANONYMOUS = 0,
- /**
+ /**
* The master must approve membership to the channel, messages must only be
* distributed to current channel slaves. This includes the channel
* state as well as transient messages.
| GNUNET_PSYC_CHANNEL_RESTRICTED_HISTORY,
#if IDEAS_FOR_FUTURE
- /**
+ /**
* Anyone can freely join the channel (no approval required);
* however, messages must only be distributed to current channel
* slaves, so the master must still acknowledge that the slave
enum GNUNET_PSYC_MessageFlags
{
/**
- * First fragment of a message.
+ * Historic message, retrieved from PSYCstore.
*/
- GNUNET_PSYC_MESSAGE_FIRST_FRAGMENT = 1 << 0,
+ GNUNET_PSYC_MESSAGE_HISTORIC = 1
+};
+
+GNUNET_NETWORK_STRUCT_BEGIN
+/**
+ * Header of a PSYC message.
+ */
+struct GNUNET_PSYC_MessageHeader
+{
/**
- * Last fragment of a message.
+ * Generic message header with size and type information.
*/
- GNUNET_PSYC_MESSAGE_LAST_FRAGMENT = 1 << 1,
+ struct GNUNET_MessageHeader header;
- /**
- * OR'ed flags if message is not fragmented.
+ /**
+ * Flags for this message fragment.
+ *
+ * @see enum GNUNET_PSYC_MessageFlags
*/
- GNUNET_PSYC_MESSAGE_NOT_FRAGMENTED
- = GNUNET_PSYC_MESSAGE_FIRST_FRAGMENT
- | GNUNET_PSYC_MESSAGE_LAST_FRAGMENT,
+ uint32_t flags GNUNET_PACKED;
/**
- * Historic message, retrieved from PSYCstore.
+ * Number of the message this message part belongs to.
+ */
+ uint64_t message_id GNUNET_PACKED;
+
+ /**
+ * Sending slave's public key.
+ * Not set if the message is from the master.
+ */
+ struct GNUNET_CRYPTO_EddsaPublicKey slave_key;
+
+ /* Followed by concatenated PSYC message parts:
+ * messages with GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_* types
*/
- GNUNET_PSYC_MESSAGE_HISTORIC = 1 << 30
};
/**
- * M
+ * The method of a message.
*/
struct GNUNET_PSYC_MessageMethod
{
*/
struct GNUNET_MessageHeader header;
- uint32_t reserved GNUNET_PACKED;
-
- /**
- * Number of modifiers in the message.
- */
- uint32_t mod_count GNUNET_PACKED;
-
/**
* OR'ed GNUNET_PSYC_MasterTransmitFlags
*/
uint32_t flags GNUNET_PACKED;
- /**
- * Sending slave's public key. NULL if the message is from the master, or when
- * transmitting a message.
- */
- struct GNUNET_CRYPTO_EccPublicSignKey slave_key;
-
/* Followed by NUL-terminated method name. */
};
+/**
+ * A modifier of a message.
+ */
struct GNUNET_PSYC_MessageModifier
{
/**
/* Followed by NUL-terminated name, then the value. */
};
+GNUNET_NETWORK_STRUCT_END
-enum GNUNET_PSYC_DataStatus
-{
- /**
- * To be continued.
- */
- GNUNET_PSYC_DATA_CONT = 0,
-
- /**
- * Reached the end of message.
- */
- GNUNET_PSYC_DATA_END = 1,
-
- /**
- * Cancelled before the end.
- */
- GNUNET_PSYC_DATA_CANCEL = 2
-};
-
+#define GNUNET_PSYC_MODIFIER_MAX_PAYLOAD \
+ GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD \
+ - sizeof (struct GNUNET_PSYC_MessageModifier)
-struct GNUNET_PSYC_MessageData
-{
- /**
- * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
- */
- struct GNUNET_MessageHeader header;
+#define GNUNET_PSYC_MOD_CONT_MAX_PAYLOAD \
+ GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD \
+ - sizeof (struct GNUNET_MessageHeader)
- /**
- * enum GNUNET_PSYC_DataStatus
- */
- uint8_t status;
-};
+#define GNUNET_PSYC_DATA_MAX_PAYLOAD \
+ GNUNET_MULTICAST_FRAGMENT_MAX_PAYLOAD \
+ - sizeof (struct GNUNET_MessageHeader)
-/**
+/**
* Handle that identifies a join request.
*
* Used to match calls to #GNUNET_PSYC_JoinCallback to the
struct GNUNET_PSYC_JoinHandle;
-/**
- * Method called from PSYC upon receiving a message indicating a call to a
- * @e method.
+/**
+ * Method called from PSYC upon receiving part of a message.
*
* @param cls Closure.
- * @param slave_key Who transmitted the message.
- * - NULL for multicast messages from the master.
- * - The sending slave's public key for unicast requests from one of the
- * slaves to the master.
- * @param message_id Unique message counter for this message.
- * Unique only in combination with the given sender for this channel.
- * @param method_name Method name from PSYC.
- * @param modifier_count Number of elements in the @a modifiers array.
- * @param modifiers State modifiers and transient variables for the message.
- * @param data_offset Byte offset of @a data in the overall data of the method.
- * @param data Data stream given to the method (might not be zero-terminated
- * if data is binary).
- * @param data_size Number of bytes in @a data.
- * @param frag Fragmentation status for the data.
+ * @param msg Message part, one of the following types:
+ * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_HEADER
+ * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_METHOD
+ * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
+ * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MOD_CONT
+ * - GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA
*/
-typedef int
-(*GNUNET_PSYC_Method) (void *cls,
- const struct GNUNET_CRYPTO_EccPublicSignKey *slave_key,
- uint64_t message_id,
- const char *method_name,
- size_t modifier_count,
- const struct GNUNET_ENV_Modifier *modifiers,
- uint64_t data_offset,
- const void *data,
- size_t data_size,
- enum GNUNET_PSYC_MessageFlags flags);
-
-
-/**
+typedef void
+(*GNUNET_PSYC_MessageCallback) (void *cls,
+ uint64_t message_id,
+ uint32_t flags,
+ const struct GNUNET_MessageHeader *msg);
+
+
+/**
* Method called from PSYC upon receiving a join request.
*
* @param cls Closure.
* @param data_size Number of bytes in @a data.
* @param jh Join handle to use with GNUNET_PSYC_join_decision()
*/
-typedef int
+typedef void
(*GNUNET_PSYC_JoinCallback) (void *cls,
- const struct GNUNET_CRYPTO_EccPublicSignKey
+ const struct GNUNET_CRYPTO_EddsaPublicKey
*slave_key,
const char *method_name,
size_t variable_count,
struct GNUNET_PSYC_JoinHandle *jh);
-/**
+/**
* 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
void
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,
size_t data_size);
-/**
+/**
* Handle for the master of a PSYC channel.
*/
struct GNUNET_PSYC_Master;
-/**
+/**
* Function called after the channel master started.
*
* @param cls Closure.
(*GNUNET_PSYC_MasterStartCallback) (void *cls, uint64_t max_message_id);
-/**
+/**
* Start a PSYC master channel.
*
* Will start a multicast group identified by the given ECC key. Messages
* one in the future.
* @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 message_cb Function to invoke on message parts received from slaves.
* @param join_cb Function to invoke when a peer wants to join.
- * @param start_cb Function to invoke after the channel master started.
+ * @param master_started_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_MessageCallback message_cb,
GNUNET_PSYC_JoinCallback join_cb,
- GNUNET_PSYC_MasterStartCallback start_cb,
+ GNUNET_PSYC_MasterStartCallback master_started_cb,
void *cls);
-/**
+/**
* Function called to provide data for a transmission via PSYC.
*
* Note that returning #GNUNET_OK or #GNUNET_SYSERR (but not #GNUNET_NO)
*/
typedef int
(*GNUNET_PSYC_MasterTransmitNotify) (void *cls,
- size_t *data_size,
+ uint16_t *data_size,
void *data);
+typedef int
+(*GNUNET_PSYC_MasterTransmitNotifyModifier) (void *cls,
+ uint16_t *data_size,
+ void *data,
+ uint8_t *oper);
/**
* Flags for transmitting messages to a channel by the master.
enum GNUNET_PSYC_MasterTransmitFlags
{
GNUNET_PSYC_MASTER_TRANSMIT_NONE = 0,
- /**
+ /**
* Whether this message should reset the channel state,
* i.e. remove all previously stored state variables.
*/
GNUNET_PSYC_MASTER_TRANSMIT_RESET_STATE = 1 << 0,
- /**
+ /**
* Whether we need to increment the group generation counter after
* transmitting this message.
*/
};
-/**
+/**
* Handle for a pending PSYC transmission operation.
*/
struct GNUNET_PSYC_MasterTransmitHandle;
-/**
+/**
* Send a message to call a method to all members in 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).
*/
struct GNUNET_PSYC_MasterTransmitHandle *
GNUNET_PSYC_master_transmit (struct GNUNET_PSYC_Master *master,
const char *method_name,
- const struct GNUNET_ENV_Environment *env,
- GNUNET_PSYC_MasterTransmitNotify notify,
+ GNUNET_PSYC_MasterTransmitNotifyModifier notify_mod,
+ GNUNET_PSYC_MasterTransmitNotify notify_data,
void *notify_cls,
enum GNUNET_PSYC_MasterTransmitFlags flags);
-/**
+/**
* Resume transmission to the channel.
*
* @param th Handle of the request that is being resumed.
GNUNET_PSYC_master_transmit_resume (struct GNUNET_PSYC_MasterTransmitHandle *th);
-/**
+/**
* Abort transmission request to channel.
*
* @param th Handle of the request that is being aborted.
GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *th);
-/**
+/**
* Stop a PSYC master channel.
*
* @param master PSYC channel master to stop.
GNUNET_PSYC_master_stop (struct GNUNET_PSYC_Master *master);
-/**
+/**
* Handle for a PSYC channel slave.
*/
struct GNUNET_PSYC_Slave;
-/**
+/**
* Function called after the slave joined.
*
* @param cls Closure.
(*GNUNET_PSYC_SlaveJoinCallback) (void *cls, uint64_t max_message_id);
-/**
+/**
* Join a PSYC channel.
*
* The entity joining is always the local peer. The user must immediately use
* @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 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 join_cb function invoked once we have joined with the current
+ * message ID of the channel
+ * @param slave_joined_cb Function to invoke when a peer wants to join.
+ * @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.
*/
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_MessageCallback message_cb,
GNUNET_PSYC_JoinCallback join_cb,
GNUNET_PSYC_SlaveJoinCallback slave_joined_cb,
void *cls,
const char *method_name,
const struct GNUNET_ENV_Environment *env,
const void *data,
- size_t data_size);
+ uint16_t data_size);
-/**
+/**
* 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 slave Slave handle.
*/
GNUNET_PSYC_slave_part (struct GNUNET_PSYC_Slave *slave);
-/**
+/**
* Function called to provide data for a transmission to the channel master
* (a.k.a. the @e host of the channel).
*
};
-/**
+/**
* Handle for a pending PSYC transmission operation.
*/
struct GNUNET_PSYC_SlaveTransmitHandle;
-/**
+/**
* Request a message to be sent to the channel master.
*
* @param slave Slave handle.
enum GNUNET_PSYC_SlaveTransmitFlags flags);
-/**
+/**
* Resume transmission to the master.
*
* @param th Handle of the request that is being resumed.
GNUNET_PSYC_slave_transmit_resume (struct GNUNET_PSYC_MasterTransmitHandle *th);
-/**
+/**
* Abort transmission request to master.
*
* @param th Handle of the request that is being aborted.
GNUNET_PSYC_slave_transmit_cancel (struct GNUNET_PSYC_SlaveTransmitHandle *th);
-/**
+/**
* Handle to access PSYC channel operations for both the master and slaves.
*/
struct GNUNET_PSYC_Channel;
-/**
+/**
* Convert a channel @a master to a @e channel handle to access the @e channel
* APIs.
*
GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master);
-/**
+/**
* Convert @a slave to a @e channel handle to access the @e channel APIs.
*
* @param slave Slave handle.
GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slave);
-/**
+/**
* Add a slave to the channel's membership list.
*
* Note that this will NOT generate any PSYC traffic, it will merely update the
*/
void
GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *channel,
- const struct GNUNET_CRYPTO_EccPublicSignKey
- *slave_key,
+ const struct GNUNET_CRYPTO_EddsaPublicKey *slave_key,
uint64_t announced_at,
uint64_t effective_since);
-/**
+/**
* Remove a slave from the channel's membership list.
*
* Note that this will NOT generate any PSYC traffic, it will merely update the
*/
void
GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *channel,
- const struct GNUNET_CRYPTO_EccPublicSignKey
+ const struct GNUNET_CRYPTO_EddsaPublicKey
*slave_key,
uint64_t announced_at);
-/**
+/**
* Function called to inform a member about stored state values for a channel.
*
* @param cls Closure.
(*GNUNET_PSYC_FinishCallback) (void *cls);
-/**
+/**
* Handle to a story telling operation.
*/
struct GNUNET_PSYC_Story;
-/**
+/**
* Request to be told the message history of the channel.
*
* Historic messages (but NOT the state at the time) will be replayed (given to
* @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
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);
-/**
+/**
* Abort story telling.
*
* This function must not be called from within method handlers (as given to
struct GNUNET_PSYC_StateQuery;
-/**
+/**
* Retrieve the best matching channel state variable.
*
* If the requested variable name is not present in the state, the nearest
void *cb_cls);
-/**
+/**
* 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
void *cb_cls);
-/**
+/**
* Cancel a state query operation.
*
* @param query Handle for the operation to cancel.
projects / oweals / gnunet.git / blobdiff