* 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
const struct GNUNET_MessageHeader *msg;
};
-/**
+/**
* Handle to access PSYC channel operations for both the master and slaves.
*/
struct GNUNET_PSYC_Channel
};
-/**
+/**
* Handle for the master of a PSYC channel.
*/
struct GNUNET_PSYC_Master
};
-/**
+/**
* Handle for a PSYC channel slave.
*/
struct GNUNET_PSYC_Slave
};
-/**
+/**
* Handle that identifies a join request.
*
* Used to match calls to #GNUNET_PSYC_JoinCallback to the
};
-/**
+/**
* Handle for a pending PSYC transmission operation.
*/
struct GNUNET_PSYC_MasterTransmitHandle
};
-/**
+/**
* Handle for a pending PSYC transmission operation.
*/
struct GNUNET_PSYC_SlaveTransmitHandle
};
-/**
+/**
* Handle to a story telling operation.
*/
struct GNUNET_PSYC_Story
}
-/**
+/**
* 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.
}
-/**
+/**
* Stop a PSYC master channel.
*
* @param master PSYC channel master to stop.
}
-/**
+/**
* 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
}
-/**
+/**
* Send a message to call a method to all members in the PSYC channel.
*
* @param mst Handle to the PSYC channel.
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;
}
-/**
+/**
* Abort transmission request to the channel.
*
* @param th Handle of the request that is being aborted.
if (GNUNET_NO != ch->in_transmit)
return;
-
+
}
-/**
+/**
* Join a PSYC channel.
*
* The entity joining is always the local peer. The user must immediately use
}
-/**
+/**
* Part a PSYC channel.
*
* Will terminate the connection to the PSYC service. Polite clients should
}
-/**
+/**
* Request a message to be sent to the channel master.
*
* @param slave Slave handle.
}
-/**
+/**
* Abort transmission request to master.
*
* @param th Handle of the request that is being aborted.
}
-/**
+/**
* Convert a channel @a master to a @e channel handle to access the @e channel
* APIs.
*
}
-/**
+/**
* Convert @a slave to a @e channel handle to access the @e channel APIs.
*
* @param slave Slave handle.
}
-/**
+/**
* Add a slave to the channel's membership list.
*
* Note that this will NOT generate any PSYC traffic, it will merely update the
}
-/**
+/**
* Remove a slave from the channel's membership list.
*
* Note that this will NOT generate any PSYC traffic, it will merely update the
}
-/**
+/**
* Request to be told the message history of the channel.
*
* Historic messages (but NOT the state at the time) will be replayed (given to
}
-/**
+/**
* 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
}
-/**
+/**
* 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
}
-/**
+/**
* Cancel a state query operation.
*
* @param query Handle for the operation to cancel.
projects / oweals / gnunet.git / blobdiff