csync public API


Defines

#define CSYNC_CONF_DIR   ".csync"
#define CSYNC_CONF_FILE   "csync.conf"
#define CSYNC_EXCLUDE_FILE   "csync_exclude.conf"
#define CSYNC_LOCK_FILE   "lock"
#define CSYNC_LOG_FILE   "csync_log.conf"
#define CSYNC_VERSION_MAJOR   0
#define CSYNC_VERSION_MINOR   42
#define CSYNC_VERSION_PATCH   0
#define CSYNC_VERSION_STRING   "csync version 0.42.0 rc3"

Typedefs

typedef struct csync_s CSYNC
typedef int(* csync_auth_callback )(const char *prompt, char *buf, size_t len, int echo, int verify)

Functions

int csync_add_exclude_list (CSYNC *ctx, const char *path)
int csync_create (CSYNC **csync, const char *local, const char *remote)
int csync_destroy (CSYNC *ctx)
int csync_disable_statedb (CSYNC *ctx)
int csync_enable_statedb (CSYNC *ctx)
csync_auth_callback csync_get_auth_callback (CSYNC *ctx)
char * csync_get_config_dir (CSYNC *ctx)
char * csync_get_statedb_file (CSYNC *ctx)
int csync_get_status (CSYNC *ctx)
int csync_init (CSYNC *ctx)
int csync_is_statedb_disabled (CSYNC *ctx)
int csync_propagate (CSYNC *ctx)
int csync_reconcile (CSYNC *ctx)
int csync_remove_config_dir (CSYNC *ctx)
int csync_set_auth_callback (CSYNC *ctx, csync_auth_callback cb)
int csync_set_config_dir (CSYNC *ctx, const char *path)
int csync_set_status (CSYNC *ctx, int status)
int csync_update (CSYNC *ctx)
const char * csync_version (void)


Define Documentation

#define CSYNC_CONF_DIR   ".csync"

Definition at line 51 of file csync.h.

#define CSYNC_CONF_FILE   "csync.conf"

Definition at line 52 of file csync.h.

#define CSYNC_EXCLUDE_FILE   "csync_exclude.conf"

Definition at line 54 of file csync.h.

#define CSYNC_LOCK_FILE   "lock"

Definition at line 55 of file csync.h.

#define CSYNC_LOG_FILE   "csync_log.conf"

Definition at line 53 of file csync.h.

#define CSYNC_VERSION_MAJOR   0

Definition at line 43 of file csync.h.

#define CSYNC_VERSION_MINOR   42

Definition at line 44 of file csync.h.

#define CSYNC_VERSION_PATCH   0

Definition at line 45 of file csync.h.

#define CSYNC_VERSION_STRING   "csync version 0.42.0 rc3"

Definition at line 46 of file csync.h.


Typedef Documentation

typedef struct csync_s CSYNC

csync handle

Definition at line 62 of file csync.h.

typedef int(* csync_auth_callback)(const char *prompt, char *buf, size_t len, int echo, int verify)

Definition at line 57 of file csync.h.


Function Documentation

int csync_add_exclude_list ( CSYNC ctx,
const char *  path 
)

int csync_create ( CSYNC **  csync,
const char *  local,
const char *  remote 
)

Allocate a csync context.

Parameters:
csync The context variable to allocate.
Returns:
0 on success, less than 0 if an error occured.

int csync_destroy ( CSYNC ctx  ) 

Destroy the csync context.

Writes the statedb, unlocks csync and frees the memory.

Parameters:
ctx The context to destroy.
Returns:
0 on success, less than 0 if an error occured.

int csync_disable_statedb ( CSYNC ctx  ) 

int csync_enable_statedb ( CSYNC ctx  ) 

csync_auth_callback csync_get_auth_callback ( CSYNC ctx  ) 

char* csync_get_config_dir ( CSYNC ctx  ) 

char* csync_get_statedb_file ( CSYNC ctx  ) 

int csync_get_status ( CSYNC ctx  ) 

int csync_init ( CSYNC ctx  ) 

Initialize the file synchronizer.

This function loads the configuration, the statedb and locks the client.

Parameters:
ctx The context to initialize.
Returns:
0 on success, less than 0 if an error occured.

int csync_is_statedb_disabled ( CSYNC ctx  ) 

int csync_propagate ( CSYNC ctx  ) 

Propagation.

Parameters:
ctx The context to run the propagation on.
Returns:
0 on success, less than 0 if an error occured.

int csync_reconcile ( CSYNC ctx  ) 

Reconciliation.

Parameters:
ctx The context to run the reconciliation on.
Returns:
0 on success, less than 0 if an error occured.

int csync_remove_config_dir ( CSYNC ctx  ) 

int csync_set_auth_callback ( CSYNC ctx,
csync_auth_callback  cb 
)

int csync_set_config_dir ( CSYNC ctx,
const char *  path 
)

int csync_set_status ( CSYNC ctx,
int  status 
)

int csync_update ( CSYNC ctx  ) 

Update detection.

Parameters:
ctx The context to run the update detection on.
Returns:
0 on success, less than 0 if an error occured.

const char* csync_version ( void   ) 

Get the csync version.

Returns:
The csync version as a string.


Generated on Wed Feb 25 19:15:10 2009 for csync by  doxygen 1.5.6