AUSSLib API for C

This document is to supplement the actual AUSS.h interface file not replace it.

The main structure which is used in most of the AUSS API calls is the connection struct. The connection struct contains all the information about the connection you want to make. It will be used to generate a XML header for AUSS as well.

A connection contains fields:

framesize: the size of a frame of this type
interleaved: is the data interleaved (multichannel)
rate: what is the data rate of this connection
name: what is the name of the connection
channels: how many channels
endian: the endian of the connection
type: the type of connection

Not all of these features are supported.

To initalize a connection (please don't fill in a connection yourself until this is done) the "auss_make_conn" function is used:

		connection aussconn = auss_make_conn();

Once a connection object is created you can set values in it like the name.

Then one would want to connect this connection to preferrablly a connector. to connect one simply calls:

		auss_connect(&aussconn, host, port, true,true);

This simply means use the aussconn object and connect to the remotehost host with the port number port, the host is a connector and send the header too. You can do the same thing with a pipe except a pipe is unidirectional so sometimes you can send a header (e.g. STDIN). Once connected you can read and write from the connection as you wish much like unix read and write commands.

		int readBytes = auss_read(&aussconn, data,size);
		int writeBytes = auss_write(&aussconn, data,size);

Data should be casted to bytes and the size is in bytes.

Once you're done reading and writing one can simply disconnect from AUSS with:

		auss_disconnect(&aussconn);