brlapi_settings_t man page on YellowDog

Man page or keyword search:  
man Server   18644 pages
apropos Keyword Search (all sections)
Output format
YellowDog logo
[printable version]

brlapi_settings_t(3)		    BrlAPI		  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: which
       file the authentication key can be found in and which computer to
       connect to.

       Examples:.RS 4

	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=':1';

lets libbrlapi connect to the local computer, on port BRLAPI_SOCKETPORTNUM+1

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:1', which
       means TCP port number BRLAPI_SOCKETPORTNUM+1 on computer called 'foo'.

       Note:
	   Please check that resolving this name works before complaining

       Settings 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.

Version 1.0			  26 Dec 2005		  brlapi_settings_t(3)
[top]

List of man pages available for YellowDog

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net