[RoarAudio] Getting general infos about a server

[Philipp Schafft]

flum,

This is a another small tutorial/howto/info about a feature of the
protocol, hope you like it. Please send your comments back using this
list.

Ever wondered if you can access some gerneral infos of the server like
the version or location? starting with 0.4beta1 you can! Here is how:

If you already have a connection to the server using the object 'con'
you can do something like this:
 struct roar_server_info * info = roar_server_info(con);
 ... access the infos in info ...
 roar_server_info_free(info);

(Note: a real application needs to do error checking!)

Now I'm going to describe the members of the info struct. Those are
called ITSTs at protocol level. The following are currently defined:
* version
        The version string of the server. This is in format:
        Product/Version <VendorID/VendorName> (comments)
        For example:
        roard/0.4beta1 <0/RoarAudio> (Debian build 0.4~beta1-1)
        The VendorID and VendorName are the officaly assigned Device
        VendorIDs. If you Need one ask on this list. If you do not need
        one because of example you just implement a single server which
        behaves exactly like the specs say (it MUST NOT conflict anyway
        but may implement additional features) you don't need one. Then
        just use the format:
        Product/Version <UnreggedVendorName> (comments)
        UnreggedVendorName MUST NOT contain a slash, and SHOULD NOT
        conflict with any regged or future regged vendor. Example:
        myEduRoarD/0.7.3 <EduRoarD Project at University of TigerTown>
* location
        The location of the server. While this a a freeform you should
        use the following format:
        lion readable location (comment) <geo coords>
        Examples:
        livingroom (near the TV) <49.55°N, 8.58333°E>
        Kitchen
        My Radio station
        
        In addition there should be a LOC DNS recoard placed for the
        server if possible.
* description
        A Description of the server. Fully freeform. Example:
        My Desktop
        connected to PA #7
* contact
        Contact infos for the server.
        The format should be:
        first "nick" last (comment) <email>/OpenPGPkey/Phone/Room
        Examples:
        Philipp "ph3-der-loewe" Schafft (RoarAudio Developer) <lion at lion.leolix.org>/67F78264/+49.123.../LionDen
        No Body <nobody at example.org>///310
* serial
        Only for embedded devices and simular.
        A freeform serial for the device.
        Examples:
        RAF-1234-413a0bc6-a382-4c46-80ca-8ce77660aa66
* address
        Address(es) of this server.
        Exact format not yet defined.
        For future use. Do not use it.
* uiurl
        Only for embedded devices and simular.
        URL to a user interface to manage non-RoarAudio settings like
        network config. This can be a HTTP or HTTPS url but also some
        other schema like SSH, Telnet or C/DTERM.
* un.sysname
* un.release
* un.nodename
* un.machine
        NOT for embedded devices and simular.
        The un.* parameters are to include infos about the operating
        system.
        For embedded devices and such which do not run a real OS below
        the RoarAudio server those should not be used.
        The values are the same as the values of the attributes of
        uname() with the same name. A implementation may include a
        switch to enable the user to disable this parameters. I/We do
        not consider those infos as security relevant. If you can attach
        a system because you know the operatingsysten and relese you
        should switch away from this operating system anyway.

More attribues can be defined in future. If you think we missed some
please contact us. Best is to contact us before the first pre-release of
this version.

Thanks for listening :)

-- 
Philipp.
 (Rah of PH2)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 482 bytes
Desc: This is a digitally signed message part
URL: <http://lists.keep-cool.org/pipermail/roaraudio/attachments/20101009/a0d3a8cf/attachment.pgp>