aft: Unify handling of hash and path duplicates.
[paraslash.git] / send.h
diff --git a/send.h b/send.h
index df0cd1cb0612c1f3e52078e1d3478423566c8152..09eb78ba5d52f701a09b269b4485913bb05d5f51 100644 (file)
--- a/send.h
+++ b/send.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2010 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -7,7 +7,15 @@
 /** \file send.h Sender-related defines and structures. */
 
 /** The sender subcommands. */
-enum {SENDER_ADD, SENDER_DELETE, SENDER_ALLOW, SENDER_DENY, SENDER_ON, SENDER_OFF, NUM_SENDER_CMDS};
+enum sender_subcommand {
+       SENDER_ADD, /**< Add a target (udp only). */
+       SENDER_DELETE, /**< Delete a target (udp only). */
+       SENDER_ALLOW, /**< Allow connections from given IP address(es). */
+       SENDER_DENY, /**< Deny connections from given IP address(es). */
+       SENDER_ON, /**< Activate the sender. */
+       SENDER_OFF, /**< Deactivate the sender. */
+       NUM_SENDER_CMDS /**< Used as array size in struct \ref sender. */
+};
 
 /**
  * Describes one supported sender of para_server.
@@ -37,7 +45,7 @@ struct sender {
         *
         * The result must be dynamically allocated and is freed by the caller.
         */
-       char* (*info)(void);
+       char* (*status)(void);
        /**
         * The send-hook.
         *
@@ -87,6 +95,15 @@ struct sender {
         * pointer means this command is not implemented by this sender.
         */
        int (*client_cmds[NUM_SENDER_CMDS])(struct sender_command_data*);
+       /**
+        * Resolve target-specific URL string
+        *
+        * This method must be defined if the sender supports the add/delete
+        * subcommands. It interprets a string specifying a target URL in a
+        * sender-specific fashion (e.g. embedded FEC string). It can also
+        * fill in sender-specific defaults if necessary.
+        */
+       int (*resolve_target)(const char *, struct sender_command_data *);
 };
 
 /** Describes one client, connected to a paraslash sender. */
@@ -122,8 +139,8 @@ struct fec_client_parms {
        uint8_t slices_per_group;
        /** Number of slices minus number of redundant slices. */
        uint8_t data_slices_per_group;
-       /** Maximal number of bytes per slice, initially zero. */
-       uint16_t max_slice_bytes;
+       /** Whether the header must be sent periodically. */
+       bool need_periodic_header;
        /**
         * Transport-layer initialisation for FEC support.
         *
@@ -137,7 +154,7 @@ struct fec_client_parms {
         */
        int (*init_fec)(struct sender_client *sc);
        /** Push out FEC-encoded packets */
-       int (*send_fec)(struct sender_client *sc, char *buf, size_t len);
+       void (*send_fec)(struct sender_client *sc, char *buf, size_t len);
 };
 
 /** Describes the current status of one paraslash sender. */
@@ -162,7 +179,7 @@ void shutdown_client(struct sender_client *sc, struct sender_status *ss);
 void shutdown_clients(struct sender_status *ss);
 void init_sender_status(struct sender_status *ss, char **access_arg, int num_access_args,
        int port, int max_clients, int default_deny);
-char *get_sender_info(struct sender_status *ss, const char *name);
+char *generic_sender_status(struct sender_status *ss, const char *name);
 
 void generic_com_allow(struct sender_command_data *scd,
                struct sender_status *ss);