send.h

   1 /*
   2  * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file send.h Sender-related defines and structures. */
   8
   9 /** The sender subcommands. */
  10 enum {SENDER_ADD, SENDER_DELETE, SENDER_ALLOW, SENDER_DENY, SENDER_ON, SENDER_OFF, NUM_SENDER_CMDS};
  11
  12 /**
  13  * describes one supported sender of para_server
  14  *
  15  * \sa http_send.c ortp_send.c
  16  */
  17 struct sender {
  18 /** the name of the sender */
  19         const char *name;
  20 /**
  21  * the init function of this sender
  22  *
  23  * It must fill in all function pointers of \a s as well as the \a client_cmds
  24  * array, see below. It should also do all necessary preparations to init
  25  * this sending facility, for example it could open a tcp port.
  26  */
  27         void (*init)(struct sender *s);
  28 /** \p SENDER_ON or \p SENDER_OFF */
  29         int status;
  30 /**
  31  * return the help text of this sender
  32  *
  33  * The result must be dynamically allocated and is freed by the caller.
  34  */
  35         char* (*help)(void);
  36 /**
  37  * return current status info about this sender
  38  *
  39  * The result must be dynamically allocated and is freed by the caller.
  40  */
  41         char* (*info)(void);
  42 /**
  43  * the send-hook
  44  *
  45  * It gets called whenever para_server is playing and the current
  46  * audio format handler indicates that another chunk of data should
  47  * be sent now. The two parameters \a current_chunk and \a chunks_sent
  48  * only differ if the stream was repositioned by the \a ff or \a jmp
  49  * command. Of course, \a buf is a pointer to the chunk of data which
  50  * should be sent, and \a len is the length of this buffer.
  51 */
  52         void (*send)(long unsigned current_chunk, long unsigned chunks_sent,
  53                 const char *buf, size_t len);
  54 /** add file descriptors to fd_sets
  55  *
  56  * The pre_select function of each supported sender is called just before
  57  * para_server enters its main select loop. Each sender may add its own
  58  * file descriptors to the \a rfds or the \a wfds set.
  59  *
  60  * If a file descriptor was added, \a max_fileno must be increased by
  61  * this function, if necessary.
  62  *
  63  * \sa select(2)
  64 */
  65         void (*pre_select)(int *max_fileno, fd_set *rfds, fd_set *wfds);
  66 /**
  67  * handle the file descriptors which are ready for I/O
  68  *
  69  * If the pre_select hook added one ore more file descriptors to the read or write
  70  * set, this is the hook to check the result and do any I/O on those descriptors
  71  * which are ready for reading/writing.
  72  */
  73         void (*post_select)(fd_set *rfds, fd_set *wfds);
  74 /**
  75  * terminate all connected clients
  76  *
  77  * This is called e.g. if the stop command was executed. It should make the clients
  78  * aware of the end-of-file condition.
  79  */
  80         void (*shutdown_clients)(void);
  81 /**
  82  * array of function pointers for the sender subcommands
  83  *
  84  * Each sender may implement any subset of the sender commands by filling in
  85  * the appropriate function pointer in the array. A \p NULL pointer means this
  86  * command is not implemented by this sender.
  87  */
  88         int (*client_cmds[NUM_SENDER_CMDS])(struct sender_command_data*);
  89 };
  90