doc
|
Data Structures | |
struct | csync_tree_walk_file_s |
CSync File Traversal structure. More... |
Macros | |
#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_STRINGIFY(s) CSYNC_TOSTRING(s) |
#define | CSYNC_TOSTRING(s) #s |
#define | CSYNC_VERSION(a, b, c) CSYNC_VERSION_DOT(a, b, c) |
#define | CSYNC_VERSION_DOT(a, b, c) a ##.## b ##.## c |
#define | CSYNC_VERSION_INT(a, b, c) ((a) << 16 | (b) << 8 | (c)) |
#define | LIBCSYNC_VERSION |
#define | LIBCSYNC_VERSION_INT |
#define | LIBCSYNC_VERSION_MAJOR 0 |
#define | LIBCSYNC_VERSION_MICRO 8 |
#define | LIBCSYNC_VERSION_MINOR 50 |
Typedefs | |
typedef struct csync_s | CSYNC |
typedef int(* | csync_auth_callback )(const char *prompt, char *buf, size_t len, int echo, int verify, void *userdata) |
typedef enum csync_error_codes_e | CSYNC_ERROR_CODE |
typedef int | csync_treewalk_visit_func (TREE_WALK_FILE *, void *) |
typedef struct csync_tree_walk_file_s | TREE_WALK_FILE |
Enumerations | |
enum | csync_error_codes_e { CSYNC_ERR_NONE = 0, CSYNC_ERR_LOG, CSYNC_ERR_LOCK, CSYNC_ERR_STATEDB_LOAD, CSYNC_ERR_MODULE, CSYNC_ERR_TIMESKEW, CSYNC_ERR_FILESYSTEM, CSYNC_ERR_TREE, CSYNC_ERR_MEM, CSYNC_ERR_PARAM, CSYNC_ERR_RECONCILE, CSYNC_ERR_PROPAGATE, CSYNC_ERR_ACCESS_FAILED, CSYNC_ERR_REMOTE_CREATE, CSYNC_ERR_REMOTE_STAT, CSYNC_ERR_LOCAL_CREATE, CSYNC_ERR_LOCAL_STAT, CSYNC_ERR_PROXY, CSYNC_ERR_UNSPEC } |
enum | csync_instructions_e { CSYNC_INSTRUCTION_NONE = 0x00000000, CSYNC_INSTRUCTION_EVAL = 0x00000001, CSYNC_INSTRUCTION_REMOVE = 0x00000002, CSYNC_INSTRUCTION_RENAME = 0x00000004, CSYNC_INSTRUCTION_NEW = 0x00000008, CSYNC_INSTRUCTION_CONFLICT = 0x00000010, CSYNC_INSTRUCTION_IGNORE = 0x00000020, CSYNC_INSTRUCTION_SYNC = 0x00000040, CSYNC_INSTRUCTION_STAT_ERROR = 0x00000080, CSYNC_INSTRUCTION_ERROR = 0x00000100, CSYNC_INSTRUCTION_DELETED = 0x00000200, CSYNC_INSTRUCTION_UPDATED = 0x00000400 } |
Variables | |
gid_t | csync_tree_walk_file_s::gid |
enum csync_instructions_e | csync_tree_walk_file_s::instruction |
mode_t | csync_tree_walk_file_s::mode |
time_t | csync_tree_walk_file_s::modtime |
const char * | csync_tree_walk_file_s::path |
int | csync_tree_walk_file_s::type |
uid_t | csync_tree_walk_file_s::uid |
#define CSYNC_STRINGIFY | ( | s | ) | CSYNC_TOSTRING(s) |
#define CSYNC_VERSION | ( | a, | |
b, | |||
c | |||
) | CSYNC_VERSION_DOT(a, b, c) |
#define CSYNC_VERSION_INT | ( | a, | |
b, | |||
c | |||
) | ((a) << 16 | (b) << 8 | (c)) |
#define LIBCSYNC_VERSION |
#define LIBCSYNC_VERSION_INT |
typedef int(* csync_auth_callback)(const char *prompt, char *buf, size_t len, int echo, int verify, void *userdata) |
typedef enum csync_error_codes_e CSYNC_ERROR_CODE |
typedef int csync_treewalk_visit_func(TREE_WALK_FILE *,void *) |
typedef struct csync_tree_walk_file_s TREE_WALK_FILE |
enum csync_error_codes_e |
enum csync_instructions_e |
Instruction enum.
In the file traversal structure, it describes the csync state of a file.
int csync_add_exclude_list | ( | CSYNC * | ctx, |
const char * | path | ||
) |
Add an additional exclude list.
ctx | The context to add the exclude list. |
path | The path pointing to the file. |
int csync_create | ( | CSYNC ** | csync, |
const char * | local, | ||
const char * | remote | ||
) |
Allocate a csync context.
csync | The context variable to allocate. |
int csync_destroy | ( | CSYNC * | ctx | ) |
Destroy the csync context.
Writes the statedb, unlocks csync and frees the memory.
ctx | The context to destroy. |
int csync_disable_statedb | ( | CSYNC * | ctx | ) |
Disable the usage of the statedb.
It is enabled by default.
ctx | The csync context. |
int csync_enable_conflictcopys | ( | CSYNC * | ctx | ) |
Enable the creation of backup copys if files are changed on both sides.
ctx | The csync context. |
int csync_enable_statedb | ( | CSYNC * | ctx | ) |
Enable the usage of the statedb.
It is enabled by default.
ctx | The csync context. |
csync_auth_callback csync_get_auth_callback | ( | CSYNC * | ctx | ) |
Get the authentication callback set.
ctx | The csync context. |
const char* csync_get_config_dir | ( | CSYNC * | ctx | ) |
Get the config directory.
ctx | The csync context. |
CSYNC_ERROR_CODE csync_get_error | ( | CSYNC * | ctx | ) |
Get the error code from the last operation.
bool csync_get_local_only | ( | CSYNC * | ctx | ) |
Retrieve the flag to tell csync that only a local run is intended.
const char* csync_get_statedb_file | ( | CSYNC * | ctx | ) |
Get the path of the statedb file used.
ctx | The csync context. |
int csync_get_status | ( | CSYNC * | ctx | ) |
void* csync_get_userdata | ( | CSYNC * | ctx | ) |
Get the userdata saved in the context.
ctx | The csync context. |
int csync_init | ( | CSYNC * | ctx | ) |
Initialize the file synchronizer.
This function loads the configuration, the statedb and locks the client.
ctx | The context to initialize. |
int csync_is_statedb_disabled | ( | CSYNC * | ctx | ) |
Check if the statedb usage is enabled.
ctx | The csync context. |
int csync_propagate | ( | CSYNC * | ctx | ) |
Propagation.
ctx | The context to run the propagation on. |
int csync_reconcile | ( | CSYNC * | ctx | ) |
Reconciliation.
ctx | The context to run the reconciliation on. |
int csync_remove_config_dir | ( | CSYNC * | ctx | ) |
Remove the complete config directory.
ctx | The csync context. |
int csync_set_auth_callback | ( | CSYNC * | ctx, |
csync_auth_callback | cb | ||
) |
Set the authentication callback.
ctx | The csync context. |
cb | The authentication callback. |
int csync_set_config_dir | ( | CSYNC * | ctx, |
const char * | path | ||
) |
Change the config directory.
ctx | The csync context. |
path | The path to the new config directory. |
int csync_set_local_only | ( | CSYNC * | ctx, |
bool | local_only | ||
) |
Flag to tell csync that only a local run is intended.
Call before csync_init
local_only | Bool flag to indicate local only mode. |
int csync_set_status | ( | CSYNC * | ctx, |
int | status | ||
) |
int csync_set_userdata | ( | CSYNC * | ctx, |
void * | userdata | ||
) |
Save userdata to the context which is passed to the auth callback function.
ctx | The csync context. |
userdata | The userdata to be stored in the context. |
int csync_update | ( | CSYNC * | ctx | ) |
Update detection.
ctx | The context to run the update detection on. |
const char* csync_version | ( | int | req_version | ) |
Check if csync is the required version or get the version string.
req_version | The version required. |
Example:
int csync_walk_local_tree | ( | CSYNC * | ctx, |
csync_treewalk_visit_func * | visitor, | ||
int | filter | ||
) |
Walk the local file tree and call a visitor function for each file.
ctx | The csync context. |
visitor | A callback function to handle the file info. |
filter | A filter, built from or'ed csync_instructions_e |
int csync_walk_remote_tree | ( | CSYNC * | ctx, |
csync_treewalk_visit_func * | visitor, | ||
int | filter | ||
) |
Walk the remote file tree and call a visitor function for each file.
ctx | The csync context. |
visitor | A callback function to handle the file info. |
filter | A filter, built from and'ed csync_instructions_e |
enum csync_instructions_e csync_tree_walk_file_s::instruction |