shell.h File Reference

Command shell interface. More...

Data Structures
struct	fluid_cmd_t
	Shell command information structure. More...
Typedefs
typedef int(*	fluid_cmd_func_t )(void *data, int ac, char **av, fluid_ostream_t out)
	Command handler function prototype.
typedef fluid_cmd_handler_t *(*	fluid_server_newclient_func_t )(void *data, char *addr)
	Callback function which is executed for new server connections.

---

Detailed Description

Command shell interface.

The shell interface allows you to send simple textual commands to the synthesizer, to parse a command file, or to read commands from the stdin or other input streams.

---

Typedef Documentation

typedef int(* fluid_cmd_func_t)(void *data, int ac, char **av, fluid_ostream_t out)

Command handler function prototype.

Parameters:

	data	User defined data
	ac	Argument count
	av	Array of string arguments
	out	Output stream to send response to

Returns:

Should return FLUID_OK on success, FLUID_FAILED otherwise

typedef fluid_cmd_handler_t*(* fluid_server_newclient_func_t)(void *data, char *addr)

Callback function which is executed for new server connections.

Parameters:

	data	User defined data supplied in call to new_fluid_server()
	addr	The IP address of the client (can be NULL)

Returns:

Should return a new command handler for the connection (new_fluid_cmd_handler()).