RegEx service

Advertise capabilities via RegEx and discover respective peers using matching strings. More...

Collaboration diagram for RegEx service:

Macros
#define	GNUNET_REGEX_INITIAL_BYTES   24
	Constant for how many bytes the initial string regex should have. More...

Typedefs
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)
	Search callback function, invoked for every result that was found. More...

Functions
struct GNUNET_REGEX_Announcement *	GNUNET_REGEX_announce (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *regex, struct GNUNET_TIME_Relative refresh_delay, uint16_t compression)
	Announce this peer under the given regular expression. More...
void	GNUNET_REGEX_announce_cancel (struct GNUNET_REGEX_Announcement *a)
	Stop announcing the regex specified by the given handle. More...
struct GNUNET_REGEX_Search *	GNUNET_REGEX_search (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *string, GNUNET_REGEX_Found callback, void *callback_cls)
	Search for a peer offering a regex matching certain string in the DHT. More...
void	GNUNET_REGEX_search_cancel (struct GNUNET_REGEX_Search *s)
	Stop search and free all data used by a GNUNET_REGEX_search call. More...

Detailed Description

Advertise capabilities via RegEx and discover respective peers using matching strings.

See also

Documentation

Macro Definition Documentation

GNUNET_REGEX_INITIAL_BYTES

#define GNUNET_REGEX_INITIAL_BYTES   24

Constant for how many bytes the initial string regex should have.

Definition at line 57 of file gnunet_regex_service.h.

Typedef Documentation

GNUNET_REGEX_Found

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)

Search callback function, invoked for every result that was found.

Parameters

cls	Closure provided in GNUNET_REGEX_search.
id	Peer providing a regex that matches the string.
get_path	Path of the get request.
get_path_length	Length of get_path.
put_path	Path of the put request.
put_path_length	Length of the put_path.

Definition at line 109 of file gnunet_regex_service.h.

Function Documentation

GNUNET_REGEX_announce()

struct GNUNET_REGEX_Announcement * GNUNET_REGEX_announce	(	const struct GNUNET_CONFIGURATION_Handle *	cfg,
		const char *	regex,
		struct GNUNET_TIME_Relative	refresh_delay,
		uint16_t	compression
	)

Announce this peer under the given regular expression.

Does not free resources, must call GNUNET_REGEX_announce_cancel for that.

Parameters

cfg	configuration to use
regex	Regular expression to announce.
refresh_delay	after what delay should the announcement be repeated?
compression	How many characters per edge can we squeeze?

Returns

Handle to reuse o free cached resources. Must be freed by calling GNUNET_REGEX_announce_cancel.

Announce this peer under the given regular expression.

Parameters

cfg	configuration to use
regex	Regular expression to announce.
refresh_delay	after what delay should the announcement be repeated?
compression	How many characters per edge can we squeeze?

Returns

Handle to reuse o free cached resources. Must be freed by calling GNUNET_REGEX_announce_cancel().

Definition at line 139 of file regex_api_announce.c.

{
  struct GNUNET_REGEX_Announcement *a;
  size_t slen;
 
  slen = strlen (regex) + 1;
  if (slen + sizeof(struct AnnounceMessage) >= GNUNET_MAX_MESSAGE_SIZE)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                _ ("Regex `%s' is too long!\n"),
                regex);
    GNUNET_break (0);
    return NULL;
  }
  a = GNUNET_new (struct GNUNET_REGEX_Announcement);
  a->cfg = cfg;
  a->refresh_delay = refresh_delay;
  a->compression = compression;
  a->regex = GNUNET_strdup (regex);
  announce_reconnect (a);
  if (NULL == a->mq)
  {
    GNUNET_free (a->regex);
    GNUNET_free (a);
    return NULL;
  }
  return a;
}

References _, announce_reconnect(), cfg, GNUNET_REGEX_Announcement::cfg, GNUNET_REGEX_Announcement::compression, GNUNET_break, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_MAX_MESSAGE_SIZE, GNUNET_new, GNUNET_strdup, GNUNET_REGEX_Announcement::mq, GNUNET_REGEX_Announcement::refresh_delay, and GNUNET_REGEX_Announcement::regex.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_REGEX_announce_cancel()

void GNUNET_REGEX_announce_cancel

(

struct GNUNET_REGEX_Announcement *

a

)

Stop announcing the regex specified by the given handle.

Parameters

a	handle returned by a previous GNUNET_REGEX_announce call.

Definition at line 173 of file regex_api_announce.c.

{
  GNUNET_MQ_destroy (a->mq);
  GNUNET_free (a->regex);
  GNUNET_free (a);
}

References GNUNET_free, GNUNET_MQ_destroy(), GNUNET_REGEX_Announcement::mq, and GNUNET_REGEX_Announcement::regex.

Referenced by cleanup().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_REGEX_search()

struct GNUNET_REGEX_Search * GNUNET_REGEX_search	(	const struct GNUNET_CONFIGURATION_Handle *	cfg,
		const char *	string,
		GNUNET_REGEX_Found	callback,
		void *	callback_cls
	)

Search for a peer offering a regex matching certain string in the DHT.

The search runs until GNUNET_REGEX_search_cancel is called, even if results are returned.

Parameters

cfg	configuration to use
string	String to match against the regexes in the DHT.
callback	Callback for found peers.
callback_cls	Closure for callback.

Returns

Handle to stop search and free resources. Must be freed by calling GNUNET_REGEX_search_cancel.

Definition at line 189 of file regex_api_search.c.

{
  struct GNUNET_REGEX_Search *s;
  size_t slen = strlen (string) + 1;
 
  if (slen + sizeof(struct RegexSearchMessage) >= GNUNET_MAX_MESSAGE_SIZE)
  {
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                _ ("Search string `%s' is too long!\n"),
                string);
    GNUNET_break (0);
    return NULL;
  }
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Starting regex search for %s\n",
       string);
  s = GNUNET_new (struct GNUNET_REGEX_Search);
  s->cfg = cfg;
  s->string = GNUNET_strdup (string);
  s->callback = callback;
  s->callback_cls = callback_cls;
  search_reconnect (s);
  if (NULL == s->mq)
  {
    GNUNET_free (s->string);
    GNUNET_free (s);
    return NULL;
  }
  return s;
}

References _, GNUNET_REGEX_Search::callback, GNUNET_REGEX_Search::callback_cls, cfg, GNUNET_REGEX_Search::cfg, GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_MAX_MESSAGE_SIZE, GNUNET_new, GNUNET_strdup, LOG, GNUNET_REGEX_Search::mq, search_reconnect(), and GNUNET_REGEX_Search::string.

Referenced by create_channel_to_destination().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_REGEX_search_cancel()

void GNUNET_REGEX_search_cancel

(

struct GNUNET_REGEX_Search *

s

)

Stop search and free all data used by a GNUNET_REGEX_search call.

Parameters

s	Handle returned by a previous GNUNET_REGEX_search call.

Definition at line 225 of file regex_api_search.c.

{
  GNUNET_MQ_destroy (s->mq);
  GNUNET_free (s->string);
  GNUNET_free (s);
}

References GNUNET_free, GNUNET_MQ_destroy(), GNUNET_REGEX_Search::mq, and GNUNET_REGEX_Search::string.

Referenced by free_channel_state(), and handle_regex_result().

Here is the call graph for this function:

Here is the caller graph for this function: