X-Git-Url: https://git.distorted.org.uk/~mdw/tripe/blobdiff_plain/f88b41d65f2284fb974b40ff5915db730f4bad55..b50ba1bda8722c66c40005f43707ebc63515732b:/server/tripe.h

diff --git a/server/tripe.h b/server/tripe.h
index 9549ec37..b062b366 100644
--- a/server/tripe.h
+++ b/server/tripe.h
@@ -859,6 +859,20 @@ extern void km_init(const char */*privkr*/, const char */*pubkr*/,
 
 extern int km_reload(void);
 
+/* --- @km_clear@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	---
+ *
+ * Use:		Forget the currently loaded keyrings.  The @master@ key will
+ *		be cleared, but other keys already loaded will continue to
+ *		exist until their reference count drops to zero.  Call
+ *		@km_init@ to make everything work again.
+ */
+
+extern void km_clear(void);
+
 /* --- @km_findpub@, @km_findpriv@ --- *
  *
  * Arguments:	@const char *tag@ = key tag to load
@@ -1233,7 +1247,9 @@ extern int c_check(const void */*m*/, size_t /*msz*/, buf */*b*/);
  *
  *		  * "?PEER" PEER -- peer's name
  *
- *		  * "?ERRNO" ERRNO -- system error code
+ *		  * "?ERR" CODE -- system error code
+ *
+ *		  * "?ERRNO" -- system error code from @errno@
  *
  *		  * "[!]..." ... -- @dstr_putf@-like string as single token
  */
@@ -1298,22 +1314,13 @@ extern void EXECL_LIKE(0) a_notify(const char */*fmt*/, ...);
  * Returns:	---
  *
  * Use:		Creates a new admin connection.  It's safe to call this
- *		before @a_init@.
+ *		before @a_init@ -- and, indeed, this makes sense if you also
+ *		call @a_switcherr@ to report initialization errors through
+ *		the administration machinery.
  */
 
 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
 
-/* --- @a_quit@ --- *
- *
- * Arguments:	---
- *
- * Returns:	---
- *
- * Use:		Shuts things down nicely.
- */
-
-extern void a_quit(void);
-
 /* --- @a_preselect@ --- *
  *
  * Arguments:	---
@@ -1338,6 +1345,61 @@ extern void a_preselect(void);
 
 extern void a_daemon(void);
 
+/* --- @a_listen@ --- *
+ *
+ * Arguments:	@const char *name@ = socket name to create
+ *		@uid_t u@ = user to own the socket
+ *		@gid_t g@ = group to own the socket
+ *		@mode_t m@ = permissions to set on the socket
+ *
+ * Returns:	---
+ *
+ * Use:		Creates the admin listening socket.
+ */
+
+extern void a_listen(const char */*sock*/,
+		     uid_t /*u*/, gid_t /*g*/, mode_t /*m*/);
+
+/* --- @a_unlisten@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	---
+ *
+ * Use:		Stops listening to the administration socket and removes it.
+ */
+
+extern void a_unlisten(void);
+
+/* --- @a_switcherr@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	---
+ *
+ * Use:		Arrange to report warnings, trace messages, etc. to
+ *		administration clients rather than the standard-error stream.
+ *
+ *		Obviously this makes no sense unless there is at least one
+ *		client established.  Calling @a_listen@ won't help with this,
+ *		because the earliest a new client can connect is during the
+ *		first select-loop iteration, which is too late: some initial
+ *		client must have been added manually using @a_create@.
+ */
+
+extern void a_switcherr(void);
+
+/* --- @a_signals@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	---
+ *
+ * Use:		Establishes handlers for the obvious signals.
+ */
+
+extern void a_signals(void);
+
 /* --- @a_init@ --- *
  *
  * Arguments:	@const char *sock@ = socket name to create
@@ -1350,8 +1412,7 @@ extern void a_daemon(void);
  * Use:		Creates the admin listening socket.
  */
 
-extern void a_init(const char */*sock*/,
-		   uid_t /*u*/, gid_t /*g*/, mode_t /*m*/);
+extern void a_init(void);
 
 /*----- Mapping with addresses as keys ------------------------------------*/
 
@@ -1640,16 +1701,39 @@ extern void p_setifname(peer */*p*/, const char */*name*/);
 
 extern const addr *p_addr(peer */*p*/);
 
-/* --- @p_init@ --- *
+/* --- @p_bind@ --- *
  *
  * Arguments:	@struct addrinfo *ailist@ = addresses to bind to
  *
  * Returns:	---
  *
- * Use:		Initializes the peer system; creates the socket.
+ * Use:		Binds to the main UDP sockets.
+ */
+
+extern void p_bind(struct addrinfo */*ailist*/);
+
+/* --- @p_unbind@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	---
+ *
+ * Use:		Unbinds the UDP sockets.  There must not be any active peers,
+ *		and none can be created until the sockets are rebound.
  */
 
-extern void p_init(struct addrinfo */*ailist*/);
+extern void p_unbind(void);
+
+/* --- @p_init@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	---
+ *
+ * Use:		Initializes the peer system.
+ */
+
+extern void p_init(void);
 
 /* --- @p_create@ --- *
  *
@@ -1735,6 +1819,17 @@ extern peer *p_find(const char */*name*/);
 
 extern void p_destroy(peer */*p*/, int /*bye*/);
 
+/* --- @p_destroyall@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	---
+ *
+ * Use:		Destroys all of the peers, saying goodbye.
+ */
+
+extern void p_destroyall(void);
+
 /* --- @FOREACH_PEER@ --- *
  *
  * Arguments:	@p@ = name to bind to each peer
@@ -1771,6 +1866,68 @@ extern void p_mkiter(peer_iter */*i*/);
 
 extern peer *p_next(peer_iter */*i*/);
 
+/*----- The interval timer ------------------------------------------------*/
+
+/* --- @iv_addreason@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	---
+ *
+ * Use:		Adds an `interval timer reason'; if there are no others, the
+ *		interval timer is engaged.
+ */
+
+extern void iv_addreason(void);
+
+/* --- @iv_rmreason@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	---
+ *
+ * Use:		Removes an interval timer reason; if there are none left, the
+ *		interval timer is disengaged.
+ */
+
+extern void iv_rmreason(void);
+
+/*----- The main loop -----------------------------------------------------*/
+
+/* --- @lp_init@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	---
+ *
+ * Use:		Initializes the main loop.  Most importantly, this sets up
+ *		the select multiplexor that everything else hooks onto.
+ */
+
+extern void lp_init(void);
+
+/* --- @lp_end@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	---
+ *
+ * Use:		Requests an exit from the main loop.
+ */
+
+extern void lp_end(void);
+
+/* --- @lp_run@ --- *
+ *
+ * Arguments:	---
+ *
+ * Returns:	Zero on successful termination; @-1@ if things went wrong.
+ *
+ * Use:		Cranks the main loop until it should be cranked no more.
+ */
+
+extern int lp_run(void);
+
 /*----- Tunnel drivers ----------------------------------------------------*/
 
 #ifdef TUN_LINUX