holy crap there is some old cruft in here I have to rewrite!
[citadel.git] / citadel / modules / network / netspool.h
index fd2b3c209d33610e70bd0fb0527540359fd96961..ef00b88bcb120bb94007cc6930cbdf5d727dfd1a 100644 (file)
@@ -1,35 +1,29 @@
-typedef struct maplist maplist;
+/*
+ * This module handles shared rooms, inter-Citadel mail, and outbound
+ * mailing list processing.
+ *
+ * Copyright (c) 2000-2018 by the citadel.org team
+ *
+ * This program is open source 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 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * ** NOTE **   A word on the S_NETCONFIGS semaphore:
+ * This is a fairly high-level type of critical section.  It ensures that no
+ * two threads work on the netconfigs files at the same time.  Since we do
+ * so many things inside these, here are the rules:
+ *  1. begin_critical_section(S_NETCONFIGS) *before* begin_ any others.
+ *  2. Do *not* perform any I/O with the client during these sections.
+ *
+ */
 
-struct maplist {
-       struct maplist *next;
-       char remote_nodename[SIZ];
-       char remote_roomname[SIZ];
-};
-
-
-typedef struct SpoolControl SpoolControl;
-
-struct SpoolControl {
-       long lastsent;
-       namelist *listrecps;
-       namelist *digestrecps;
-       namelist *participates;
-       maplist *ignet_push_shares;
-       char *misc;
-       FILE *digestfp;
-       int num_msgs_spooled;
-
-       char *working_ignetcfg;
-       NetMap *the_netmap;
-};
-
-
-void network_spoolout_room(char *room_to_spool,                       
-                          char *working_ignetcfg,
-                          NetMap *the_netmap);
-void network_do_spoolin(char *working_ignetcfg, NetMap *the_netmap, int *netmap_changed);
-void network_consolidate_spoolout(char *working_ignetcfg, NetMap *the_netmap);
-void free_spoolcontrol_struct(SpoolControl **scc);
-int writenfree_spoolcontrol_file(SpoolControl **scc, char *filename);
-int read_spoolcontrol_file(SpoolControl **scc, char *filename);
-int is_recipient(SpoolControl *sc, const char *Name);