+/**
+ @file osrf_system.h
+ @brief Header for various top-level system routines.
+*/
+
#ifndef OSRF_SYSTEM_H
#define OSRF_SYSTEM_H
extern "C" {
#endif
-/** Connects to jabber. Returns 1 on success, 0 on failure
- contextnode is the location in the config file where we collect config info
-*/
-
-
int osrf_system_bootstrap_client( char* config_file, char* contextnode );
-/* bootstraps a client adding the given resource string to the host/pid, etc. resource string */
-/**
- Sets up the global connection.
- @param configFile The OpenSRF bootstrap config file
- @param contextNode The location in the config file where we'll find the necessary info
- @param resource The login resource. If NULL a default will be created
- @return 1 on successs, 0 on failure.
- */
-int osrfSystemBootstrapClientResc( const char* configFile,
- const char* contextNode, const char* resource );
+int osrfSystemBootstrapClientResc( const char* config_file,
+ const char* contextnode, const char* resource );
-/**
- Bootstrap the server.
- @param hostname The name of this host. This is the name that will be used to
- load the settings.
- @param configfile The OpenSRF bootstrap config file
- @param contextnode The config context
- @return 0 on success, -1 on error
- */
-int osrfSystemBootstrap( const char* hostName, const char* configfile,
+int osrfSystemBootstrap( const char* hostname, const char* configfile,
const char* contextNode );
transport_client* osrfSystemGetTransportClient( void );
-/* disconnects and destroys the current client connection */
int osrf_system_disconnect_client();
-int osrf_system_shutdown( void );
+int osrf_system_shutdown( void );
-/* this will clear the global transport client pointer without
- * actually destroying the socket. this is useful for allowing
- * children to have their own socket, even though their parent
- * already created a socket
- */
void osrfSystemIgnoreTransportClient();
-
-/** Initialize the cache connection */
int osrfSystemInitCache(void);
#ifdef __cplusplus