/*
This file is part of GNUnet.
- Copyright (C) 2001-2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2001-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
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.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_client_lib.h
- * @brief functions related to accessing services
* @author Christian Grothoff
- * @defgroup client Generic client-side communication with services
+ *
+ * @file
+ * Functions related to accessing services
+
+ * @defgroup client Client library
+ * Generic client-side communication with services
+ *
+ * @see [Documentation](https://gnunet.org/ipc)
+ *
* @{
*/
#endif
#endif
+#include "gnunet_mq_lib.h"
/**
* Opaque handle for a connection to a service.
*/
struct GNUNET_CLIENT_Connection;
+
+/**
+ * Create a message queue to connect to a GNUnet service.
+ * If handlers are specfied, receive messages from the connection.
+ *
+ * @param connection the client connection
+ * @param handlers handlers for receiving messages, can be NULL
+ * @param error_handler error handler
+ * @param error_handler_cls closure for the @a error_handler
+ * @return the message queue, NULL on error
+ */
+struct GNUNET_MQ_Handle *
+GNUNET_CLIENT_connecT (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const char *service_name,
+ const struct GNUNET_MQ_MessageHandler *handlers,
+ GNUNET_MQ_ErrorHandler error_handler,
+ void *error_handler_cls);
+
+
+/**
+ * Create a message queue for a GNUNET_CLIENT_Connection.
+ * If handlers are specfied, receive messages from the connection.
+ *
+ * @param connection the client connection, taken over and freed by the MQ
+ * @param handlers handlers for receiving messages
+ * @param error_handler error handler
+ * @param error_handler_cls closure for the @a error_handler
+ * @return the message queue
+ * @deprecated use #GNUNET_CLIENT_connecT
+ */
+struct GNUNET_MQ_Handle *
+GNUNET_MQ_queue_for_connection_client (struct GNUNET_CLIENT_Connection *connection,
+ const struct GNUNET_MQ_MessageHandler *handlers,
+ GNUNET_MQ_ErrorHandler error_handler,
+ void *error_handler_cls);
+
+
/**
* Get a connection with a service.
*
* @param service_name name of the service
* @param cfg configuration to use
* @return NULL on error (service unknown to configuration)
+ * @deprecated use #GNUNET_CLIENT_connect2
*/
struct GNUNET_CLIENT_Connection *
GNUNET_CLIENT_connect (const char *service_name,
* which case the message may still be lost).
*
* @param client handle to the service connection
+ * @deprecated
*/
void
GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *client);
* @param cls closure
* @param msg message received, NULL on timeout or fatal error
*/
-typedef void (*GNUNET_CLIENT_MessageHandler) (void *cls,
- const struct GNUNET_MessageHeader *msg);
+typedef void
+(*GNUNET_CLIENT_MessageHandler) (void *cls,
+ const struct GNUNET_MessageHeader *msg);
/**
* @param handler function to call with the message
* @param handler_cls closure for @a handler
* @param timeout how long to wait until timing out
+ * @deprecated
*/
void
GNUNET_CLIENT_receive (struct GNUNET_CLIENT_Connection *client,
- GNUNET_CLIENT_MessageHandler handler, void *handler_cls,
+ GNUNET_CLIENT_MessageHandler handler,
+ void *handler_cls,
struct GNUNET_TIME_Relative timeout);
* @return NULL if someone else is already waiting to be notified
* non-NULL if the notify callback was queued (can be used to cancel
* using #GNUNET_CONNECTION_notify_transmit_ready_cancel)
+ * @deprecated
*/
struct GNUNET_CLIENT_TransmitHandle *
GNUNET_CLIENT_notify_transmit_ready (struct GNUNET_CLIENT_Connection *client,
* Cancel a request for notification.
*
* @param th handle from the original request.
+ * @deprecated
*/
void
-GNUNET_CLIENT_notify_transmit_ready_cancel (struct GNUNET_CLIENT_TransmitHandle
- *th);
+GNUNET_CLIENT_notify_transmit_ready_cancel (struct GNUNET_CLIENT_TransmitHandle *th);
/**
* @param rn_cls closure for @a rn
* @return #GNUNET_OK on success, #GNUNET_SYSERR if a request
* is already pending
+ * @deprecated
*/
int
GNUNET_CLIENT_transmit_and_get_response (struct GNUNET_CLIENT_Connection *client,
* #GNUNET_NO if the service is not running
* #GNUNET_SYSERR if the configuration is invalid
*/
-typedef void (*GNUNET_CLIENT_TestResultCallback)(void *cls,
- int result);
+typedef void
+(*GNUNET_CLIENT_TestResultCallback)(void *cls,
+ int result);
/**
* @param cb function to call with the result
* @param cb_cls closure for @a cb
* @return handle to cancel the test
+ * @deprecated
*/
struct GNUNET_CLIENT_TestHandle *
GNUNET_CLIENT_service_test (const char *service,
* Abort testing for service.
*
* @param th test handle
+ * @deprecated
*/
void
GNUNET_CLIENT_service_test_cancel (struct GNUNET_CLIENT_TestHandle *th);
}
#endif
-/** @} */ /* end of group client */
-
/* ifndef GNUNET_CLIENT_LIB_H */
#endif
+
+/** @} */ /* end of group client */
+
/* end of gnunet_client_lib.h */
projects / oweals / gnunet.git / blobdiff