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
* '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.
- * Higher-level applications should use NAMES within GADS
+ * Higher-level applications should use NAMES within GNS
* to obtain public keys, and the distinction between
* 'places' and 'persons' can then be made with the help
* of the naming system (and/or conventions).
* @c \#define for the maximum size of a variable).
* - PSYC defines standard variables, methods, etc. This
* library deliberately abstracts over all of these; a
- * higher-level API should combine the naming system (GADS)
+ * 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
#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
*/
GNUNET_PSYC_MESSAGE_LAST_FRAGMENT = 1 << 1,
- /**
+ /**
* OR'ed flags if message is not fragmented.
*/
GNUNET_PSYC_MESSAGE_NOT_FRAGMENTED
uint32_t flags GNUNET_PACKED;
/**
- * Sending slave's public key. NULL if the message is from the master, or when
- * transmitting a message.
+ * Sending slave's public key.
+ * NULL if the message is from the master, or when transmitting a message.
*/
- struct GNUNET_CRYPTO_EccPublicSignKey slave_key;
+ struct GNUNET_CRYPTO_EddsaPublicKey slave_key;
/* Followed by NUL-terminated method name. */
};
struct GNUNET_PSYC_MessageData
{
/**
- * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_MODIFIER
+ * Type: GNUNET_MESSAGE_TYPE_PSYC_MESSAGE_DATA
*/
struct GNUNET_MessageHeader header;
uint8_t status;
};
-/**
+/**
* 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.
*
*/
typedef int
(*GNUNET_PSYC_Method) (void *cls,
- const struct GNUNET_CRYPTO_EccPublicSignKey *slave_key,
+ const struct GNUNET_CRYPTO_EddsaPublicKey *slave_key,
uint64_t message_id,
const char *method_name,
size_t modifier_count,
enum GNUNET_PSYC_MessageFlags flags);
-/**
+/**
* Method called from PSYC upon receiving a join request.
*
* @param cls Closure.
*/
typedef int
(*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
* @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 GADS for places managed by other users, or select
+ * 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.
* 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 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_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)
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.
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
* 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 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 method_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_JoinCallback join_cb,
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
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