brlapi_settings_t(3)      OpenBSD Programmer's Manual     brlapi_settings_t(3)



NAME
       brlapi_settings_t - Settings structure for BrlAPI connection.

SYNOPSIS
       #include <api.h>

   Data Fields
       char * authKey
       char * hostName

DETAILED DESCRIPTION
       This structure holds every parameter needed to connect to BrlAPI: in
       which file the authentication key can be found and to which computer to
       connect.

       Examples:


        brlapi_settings_t settings;

        settings.authKey='/etc/brlapi.key';
        settings.hostName='foo';
       libbrlapi will read authentication key from file /etc/brlapi.key and
       connect to the machine called 'foo', on the default TCP port.

        settings.hostName='10.1.0.2';

       lets directly enter an IP address instead of a machine name.

        settings.hostName=':4321';

       lets libbrlapi connect to the local computer, on TCP port 4321

       See also:
           brlapi_initializeConnection() brlapi_loadAuthKey()

FIELD DOCUMENTATION
   char* brlapi_settings_t::authKey
       To get authenticated, libbrlapi has to tell the BrlAPI server a secret
       key, for security reasons. This is the path to the file which holds it;
       it will hence have to be readable by the application.

       Setting NULL defaults it to local installation setup or to the content
       of the BRLAPI_AUTHPATH environment variable, if it exists.

   char* brlapi_settings_t::hostName
       this tells where the BrlAPI server resides: it might be listening on
       another computer, on any TCP port. It should look like 'foo:1234',
       which means TCP port number 1234 on computer called 'foo'.

       Note:
           Please check that resolving this name works before
           complainingSettings NULL defaults it to localhost, using the local
           installation's default TCP port, or to the content of the
           BRLAPI_HOSTNAME environment variable, if it exists.


AUTHOR
       Generated automatically by Doxygen for BrlAPI from the source code.



BrlAPI                            13 Jul 2004             brlapi_settings_t(3)
