axa 3.0.1
Farsight Security Advanced Exchange Access (AXA)
axa_client_config

Detailed Description

Data Structures

struct  axa_alias
 
struct  axa_client_config_t
 

Macros

#define AXA_ALIAS_STRLEN   64
 
#define AXA_CONNECT_STRLEN   1024
 

Typedefs

typedef struct axa_alias axa_alias_t
 

Functions

void axa_unload_client_config (void)
 Unload client config and free all associated memory.
 
bool axa_load_client_config (axa_emsg_t *emsg, const char *config_file0)
 Load client config.
 
const char * axa_client_config_alias_chk (const char *alias)
 Check for a connection alias.
 
void axa_client_config_alias_print (void)
 Print alias list to stdout.
 

Variables

char axa_alias::a [AXA_ALIAS_STRLEN]
 
char axa_alias::c [AXA_CONNECT_STRLEN]
 
struct axa_aliasaxa_alias::next
 
axa_alias_taxa_client_config_t::aliases
 
axa_alias_taxa_client_config_t::aliases_tail
 

Function Documentation

◆ axa_unload_client_config()

void axa_unload_client_config ( void  )

Unload client config and free all associated memory.

◆ axa_load_client_config()

bool axa_load_client_config ( axa_emsg_t emsg,
const char *  config_file0 
)

Load client config.

Parameters
[out]emsgerror message if something went wrong
[in]config_file0pointer to canonical name of config file or NULL to let the function try to find a suitable file. Because the config file may contain sensitive information such as apikeys, for the function to succeed, the file must not have permissions set for group/other.
Return values
trueif file was successfully opened and parsed
falseif there was an error, emsg will contain the reason

◆ axa_client_config_alias_chk()

const char * axa_client_config_alias_chk ( const char *  alias)

Check for a connection alias.

Parameters
[in]aliasname of alias to look for in connection alias list
Returns
if alias exists a pointer to a fully qualified server connection string or NULL if it does not

◆ axa_client_config_alias_print()

void axa_client_config_alias_print ( void  )

Print alias list to stdout.