/*
This file is part of GNUnet.
- (C) 2009, 2010 Christian Grothoff (and other contributing authors)
+ (C) 2009-2013 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
* @brief core service; this is the main API for encrypted P2P
* communications
* @author Christian Grothoff
+ * @defgroup core encrypted direct communication between peers
+ * @{
*/
#ifndef GNUNET_CORE_SERVICE_H
* @param peer peer identity this notification is about
*/
typedef void (*GNUNET_CORE_ConnectEventHandler) (void *cls,
- const struct
- GNUNET_PeerIdentity * peer);
+ const struct GNUNET_PeerIdentity *peer);
/**
* @param peer peer identity this notification is about
*/
typedef void (*GNUNET_CORE_DisconnectEventHandler) (void *cls,
- const struct
- GNUNET_PeerIdentity * peer);
+ const struct GNUNET_PeerIdentity *peer);
/**
* do this later).
*
* @param cls closure
- * @param server handle to the server, NULL if we failed;
- * TODO: consider removing this argument, it is redundant...
* @param my_identity ID of this peer, NULL if we failed
*/
typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
- struct GNUNET_CORE_Handle * server,
- const struct GNUNET_PeerIdentity *
- my_identity);
+ const struct GNUNET_PeerIdentity *my_identity);
/**
* messages if the client does not process them fast enough (for this
* notification type, a bounded queue is used)
* @param inbound_hdr_only set to #GNUNET_YES if @a inbound_notify will only read the
- * GNUNET_MessageHeader and hence we do not need to give it the full message;
+ * `struct GNUNET_MessageHeader` and hence we do not need to give it the full message;
* can be used to improve efficiency, ignored if inbound_notify is NULL
* note that the core is allowed to drop notifications about inbound
* messages if the client does not process them fast enough (for this
* messages if the client does not process them fast enough (for this
* notification type, a bounded queue is used)
* @param outbound_hdr_only set to #GNUNET_YES if @a outbound_notify will only read the
- * GNUNET_MessageHeader and hence we do not need to give it the full message
+ * `struct GNUNET_MessageHeader` and hence we do not need to give it the full message
* can be used to improve efficiency, ignored if outbound_notify is NULL
* note that the core is allowed to drop notifications about outbound
* messages if the client does not process them fast enough (for this
void *cb_cls);
-/**
- * Handle to cancel 'is_peer_connected' test.
- */
-struct GNUNET_CORE_ConnectTestHandle;
-
-
-/**
- * Check if the given peer is currently connected and return information
- * about the session if so. This function is for special cirumstances
- * (GNUNET_TESTING uses it), normal users of the CORE API are
- * expected to track which peers are connected based on the
- * connect/disconnect callbacks from GNUNET_CORE_connect. This
- * function is NOT part of the 'versioned', 'official' API.
- *
- * @param cfg configuration to use
- * @param peer the specific peer to check for
- * @param peer_cb function to call with the peer information
- * @param cb_cls closure for @a peer_cb
- * @return handle to cancel the operation
- */
-struct GNUNET_CORE_ConnectTestHandle *
-GNUNET_CORE_is_peer_connected (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_PeerIdentity *peer,
- GNUNET_CORE_ConnectEventHandler peer_cb,
- void *cb_cls);
-
-
-/**
- * Abort 'is_connected' test operation.
- *
- * @param cth handle for operation to cancel
- */
-void
-GNUNET_CORE_is_peer_connected_cancel (struct GNUNET_CORE_ConnectTestHandle *cth);
-
-
/**
* Check if the given peer is currently connected. This function is for special
* cirumstances (GNUNET_TESTBED uses it), normal users of the CORE API are
* expected to track which peers are connected based on the connect/disconnect
* callbacks from #GNUNET_CORE_connect. This function is NOT part of the
- * 'versioned', 'official' API. The difference between this function and the
- * function #GNUNET_CORE_is_peer_connected is that this one returns
- * synchronously after looking in the CORE API cache. The function
- * #GNUNET_CORE_is_peer_connected sends a message to the CORE service and hence
- * its response is given asynchronously.
+ * 'versioned', 'official' API. This function returns
+ * synchronously after looking in the CORE API cache.
*
* @param h the core handle
* @param pid the identity of the peer to check if it has been connected to us
const struct GNUNET_PeerIdentity *pid);
+/**
+ * Create a message queue for sending messages to a peer with CORE.
+ * Messages may only be queued with #GNUNET_MQ_send once the init callback has
+ * been called for the given handle.
+ * There must only be one queue per peer for each core handle.
+ * The message queue can only be used to transmit messages,
+ * not to receive them.
+ *
+ * @param h the core handle
+ * @param target the target peer for this queue, may not be NULL
+ * @return a message queue for sending messages over the core handle
+ * to the target peer
+ */
+struct GNUNET_MQ_Handle *
+GNUNET_CORE_mq_create (struct GNUNET_CORE_Handle *h,
+ const struct GNUNET_PeerIdentity *target);
+
+
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
}
#endif
+/** @} */ /* end of group core */
+
/* ifndef GNUNET_CORE_SERVICE_H */
#endif
/* end of gnunet_core_service.h */
projects / oweals / gnunet.git / blobdiff