-moving friends file parsing logic into its own library

1 files changed, 95 insertions, 0 deletions

diff --git a/src/include/gnunet_friends_lib.h b/src/include/gnunet_friends_lib.h
new file mode 100644
index 000000000..dda1d3245
--- /dev/null
+++ b/src/include/gnunet_friends_lib.h
@@ -0,0 +1,95 @@
+/*
+     This file is part of GNUnet.
+     (C) 2013 Christian Grothoff
+
+     GNUnet is free software; you can redistribute it and/or modify
+     it under the terms of the GNU General Public License as published
+     by the Free Software Foundation; either version 3, or (at your
+     option) any later version.
+
+     GNUnet is distributed in the hope that it will be useful, but
+     WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+     General Public License for more details.
+
+     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.
+*/
+
+/**
+ * @file include/gnunet_friends_lib.h
+ * @brief library to read and write the FRIENDS file
+ * @author Christian Grothoff
+ */
+#ifndef GNUNET_FRIENDS_LIB_H
+#define GNUNET_FRIENDS_LIB_H
+
+#include "gnunet_util_lib.h"
+
+
+/**
+ * Signature of a function called on each friend found.
+ *
+ * @param cls closure
+ * @param friend peer identity of the friend
+ */
+typedef void (*GNUNET_FRIENDS_Callback)(void *cls,
+                                        const struct GNUNET_PeerIdentity *friend);
+
+
+/**
+ * Parse the FRIENDS file.
+ *
+ * @param cfg our configuration
+ * @param cb function to call on each friend found
+ * @param cb_cls closure for @a cb
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on parsing errors
+ */
+int
+GNUNET_FRIENDS_parse (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                      GNUNET_FRIENDS_Callback cb,
+                      void *cb_cls);
+
+
+/**
+ * Handle for writing a friends file.
+ */
+struct GNUNET_FRIENDS_Writer;
+
+
+/**
+ * Start writing a fresh FRIENDS file.  Will make a backup of the
+ * old one.
+ *
+ * @param cfg configuration to use.
+ * @return NULL on error
+ */
+struct GNUNET_FRIENDS_Writer *
+GNUNET_FRIENDS_write_start (const struct GNUNET_CONFIGURATION_Handle *cfg);
+
+
+/**
+ * Finish writing out the friends file.
+ *
+ * @param w write handle
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
+ */
+int
+GNUNET_FRIENDS_write_stop (struct GNUNET_FRIENDS_Writer *w);
+
+
+/**
+ * Add a friend to the friends file.
+ *
+ * @param w write handle
+ * @param friend friend to add
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
+ */
+int
+GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w,
+                      const struct GNUNET_PeerIdentity *friend);
+
+
+#endif