Merge branch 'maint'
[paraslash.git] / server.h
index a83aaae29aa59362f9665c08c1abcb899cbfdb6c..a814aff07d0285aa666872b5158ea3f278b41faf 100644 (file)
--- a/server.h
+++ b/server.h
@@ -1,45 +1,36 @@
 /*
- * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file server.h common server data structures */
+/** \file server.h Common server data structures. */
 
-
-/** size of the selector_info and audio_file info strings of struct misc_meta_data */
+/** Size of the selector_info and audio_file info strings of struct misc_meta_data. */
 #define MMD_INFO_SIZE 16384
 
-/**
- * defines one command of para_server
- */
-struct server_command {
-/** the name of the command */
-       const char *name;
-/** pointer to the function that handles the command */
-       int (*handler)(int, int, char * const * const);
-/** the privileges a user must have to execute this command */
-       unsigned int perms;
-/** one-line description of the command */
-       const char *description;
-/** summary of the command line options */
-       const char *usage;
-/** the long help text */
-       const char *help;
-};
+/** The maximum length of the host component in an URL */
+#define MAX_HOSTLEN    256
+
 
-/** holds the arguments for the para_server's sender command */
+/** Holds the arguments for the para_server's sender command. */
 struct sender_command_data{
-/** greater than 0 indicates that a sender cmd is already queued */
+       /** Greater than 0 indicates that a sender cmd is already queued. */
        int cmd_num;
-/** the number of the sender in question */
+       /** The number of the sender in question. */
        int sender_num;
-/** used for the allow/deny/add/remove subcommands */
-       struct in_addr addr;
-/** used for allow/deny */
+       /** Used for the allow/deny/add/remove subcommands. */
+       char host[MAX_HOSTLEN];
+       /** Used for allow/deny. */
        int netmask;
-/** the portnumber for add/remove */
+       /** The port number for add/remove. */
        int port;
+       /** Maximal slice size. */
+       uint16_t max_slice_bytes;
+       /** Number of data slices plus redundant slices. */
+       uint8_t slices_per_group;
+       /** Number of slices minus number of redundant slices. */
+       uint8_t data_slices_per_group;
 };
 
 /**
@@ -59,23 +50,23 @@ struct sender_command_data{
  *     date.
  */
 struct misc_meta_data {
-       /** the size of the current audio file in bytes */
+       /** The size of the current audio file in bytes. */
        size_t size;
-       /** the last modification time of the current audio file */
+       /** The last modification time of the current audio file. */
        time_t mtime;
-       /** the "old" status flags -- commands may only read them */
+       /** The "old" status flags -- commands may only read them. */
        unsigned int vss_status_flags;
        /** The new status flags -- commands may set them. */
        unsigned int new_vss_status_flags;
-       /** the number of data chunks sent for the current audio file */
+       /** The number of data chunks sent for the current audio file. */
        long unsigned chunks_sent;
-       /** set by the jmp/ff commands to the new position in chunks */
+       /** Set by the jmp/ff commands to the new position in chunks. */
        long unsigned repos_request;
        /** The number of the chunk currently sent out. */
        long unsigned current_chunk;
-       /** the milliseconds that have been skipped of the current audio file */
+       /** The milliseconds that have been skipped of the current audio file. */
        long offset;
-       /** the time para_server started to stream */
+       /** The time para_server started to stream. */
        struct timeval stream_start;
        /**
         * The event counter.
@@ -84,27 +75,26 @@ struct misc_meta_data {
         * connected clients.
         */
        unsigned int events;
-       /** the number of audio files already sent */
+       /** The number of audio files already sent. */
        unsigned int num_played;
-       /** the number of executed commands */
+       /** The number of executed commands. */
        unsigned int num_commands;
-       /** the number of connections para_server received so far */
+       /** The number of connections para_server received so far. */
        unsigned int num_connects;
-       /** the number of connections currently active */
+       /** The number of connections currently active. */
        unsigned int active_connections;
-       /** the process id of para_server */
-       pid_t server_pid;
+       /** The process id of the audio file selector. */
+       pid_t afs_pid;
        /** This gets updated by afs and contains its current mode. */
        char afs_mode_string[MAXLINE];
-       /** used by the sender command */
+       /** Used by the sender command. */
        struct sender_command_data sender_cmd_data;
        /** Describes the current audio file. */
        struct audio_file_data afd;
 };
 
+/** Command line options for para_server. */
 extern struct server_args_info conf;
-extern int afs_socket;
 
-int handle_connect(int fd, struct sockaddr_in *addr);
-void mmd_unlock(void);
-void mmd_lock(void);
+__noreturn void handle_connect(int fd, const char *peername);
+void parse_config_or_die(int override);