/*
This file is part of GNUnet
- (C) 2012, 2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2012, 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_regex_service.h
- * @brief access regex service to advertise capabilities via regex and discover
- * respective peers using matching strings
* @author Maximilian Szengel
* @author Christian Grothoff
+ *
+ * @file
+ * API to access regex service to advertise capabilities via regex and discover
+ * respective peers using matching strings
+ *
+ * @defgroup regex RegEx service
+ * Advertise capabilities via RegEx and discover
+ * respective peers using matching strings.
+ *
+ * @see [Documentation](https://gnunet.org/regex)
+ *
+ * @{
*/
#ifndef GNUNET_REGEX_SERVICE_H
#define GNUNET_REGEX_SERVICE_H
* Announce this peer under the given regular expression. Does
* not free resources, must call #GNUNET_REGEX_announce_cancel for
* that.
- *
+ *
* @param cfg configuration to use
* @param regex Regular expression to announce.
* @param refresh_delay after what delay should the announcement be repeated?
/**
* Stop announcing the regex specified by the given handle.
- *
+ *
* @param a handle returned by a previous #GNUNET_REGEX_announce call.
*/
void
* @param put_path Path of the put request.
* @param put_path_length Length of the @a put_path.
*/
-typedef void (*GNUNET_REGEX_Found)(void *cls,
- const struct GNUNET_PeerIdentity *id,
- const struct GNUNET_PeerIdentity *get_path,
- unsigned int get_path_length,
- const struct GNUNET_PeerIdentity *put_path,
- unsigned int put_path_length);
+typedef void
+(*GNUNET_REGEX_Found)(void *cls,
+ const struct GNUNET_PeerIdentity *id,
+ const struct GNUNET_PeerIdentity *get_path,
+ unsigned int get_path_length,
+ const struct GNUNET_PeerIdentity *put_path,
+ unsigned int put_path_length);
/**
/**
* Stop search and free all data used by a #GNUNET_REGEX_search call.
- *
+ *
* @param s Handle returned by a previous #GNUNET_REGEX_search call.
*/
void
}
#endif
-/* end of gnunet_regex_service.h */
#endif
+
+/** @} */ /* end of group */