* the update hook
*
* The \a update_audio_file pointer is optional and need not be supplied. In this
- * case it is not neccessary to init this pointer from within init(). If
+ * case it is not necessary to init this pointer from within init(). If
* \a update_audio_file is non-NULL, the function it points to gets called
* whenever a new audio file was successfully loaded and is going to be
* streamed by any of paraslash's senders. The full path of the audio file is
option "channels" c
#~~~~~~~~~~~~~~~~~~
-"number of channels (only neccessary for raw
+"number of channels (only necessary for raw
audio)"
int typestr="num"
option "samplerate" s
#~~~~~~~~~~~~~~~~~~~~~
-"force given sample rate (only neccessary for
+"force given sample rate (only necessary for
raw audio)"
int typestr="num"
/*
* Check if any receivers/filters/writers need to be started and do so if
- * neccessary. Since the pre_select function didn't have a chance yet to put
+ * necessary. Since the pre_select function didn't have a chance yet to put
* file descriptors into the fd sets given by s, make the upcoming select()
* return immediately to avoid a long timeout in case we started something.
*/
* \param t pointer to the task struct for this command
*
* Depending on the current state of the connection and the status of the read
- * and write fd sets of \a s, this function performs the neccessary steps to
- * authenticate the connection, to send the commmand given by \a
+ * and write fd sets of \a s, this function performs the necessary steps to
+ * authenticate the connection, to send the command given by \a
* t->private_data and to receive para_server's output, if any.
*
* \sa struct sched, struct task
/**
* paraslash's scheduler
*
- * desinged with KISS in mind. It manages two lists of tasks. The pre_select
+ * Designed with KISS in mind. It manages two lists of tasks. The pre_select
* list contains pointers to functions that are called before calling select()
* from the main loop. Similarly, \a post_select_list is a list of function
* pointers each of which is called after the select call. Tasks add hooks to
*
* If one of these functions return a negative value via \a t->ret the
* (optional) event_handler gets called (it may also be called in case another
- * event happend). In many cases the only possible event is an error or an eof
+ * event happened). In many cases the only possible event is an error or an eof
* condition and the event handler simply unregisters the task from the
* scheduler.
*
* the pre select hook of \a t
*
* Its purpose is to add file descriptors to the fd sets of the
- * scheduler and to decrease the select timeout if neccessary.
+ * scheduler and to decrease the select timeout if necessary.
*/
void (*pre_select)(struct sched *s, struct task *t);
/**
* the init function of this sender
*
* It must fill in all function pointers of \a s as well as the \a client_cmds
- * array, see below. It should also do all neccessary preparations to init
+ * array, see below. It should also do all necessary preparations to init
* this sending facility, for example it could open a tcp port.
*/
void (*init)(struct sender *s);
* file descriptors to the \a rfds or the \a wfds set.
*
* If a file descriptor was added, \a max_fileno must be increased by
- * this function, if neccessary.
+ * this function, if necessary.
*
* \sa select(2)
*/
* array of function pointers for the sender subcommands
*
* Each sender may implement any subset of the sender commands by filling in
- * the aprropriate function pointer in the array. A \p NULL pointer means this
+ * the appropriate function pointer in the array. A \p NULL pointer means this
* command is not implemented by this sender.
*/
int (*client_cmds[NUM_SENDER_CMDS])(struct sender_command_data*);
/**
* check a file descriptor for writability
*
- * \param fd the file desctiptor
+ * \param fd the file descriptor
*
* \return positive if fd is ready for writing, zero if it isn't, negative if
- * an error occured.
+ * an error occurred.
*/
static inline int write_ok(int fd)