doc
|
Data Structures | |
struct | csync_tree_walk_file_s |
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_STATUS_IS_EQUAL(x, y) ((x) == (y)) |
#define | CSYNC_STATUS_IS_ERR(x) (unlikely((x) >= CSYNC_STATUS_ERROR)) |
#define | CSYNC_STATUS_IS_OK(x) (likely((x) == CSYNC_STATUS_OK)) |
#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 0 |
#define | LIBCSYNC_VERSION_MINOR 50 |
#define | likely(x) (x) |
#define | unlikely(x) (x) |
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 void(* | csync_file_progress_callback) (const char *remote_url, enum csync_notify_type_e kind, long long o1, long long o2, void *userdata) |
typedef void(* | csync_log_callback) (int verbosity, const char *function, const char *buffer, void *userdata) |
typedef void(* | csync_overall_progress_callback) (const char *file_name, int file_no, int file_cnt, long long o1, long long o2, void *userdata) |
typedef enum csync_status_codes_e | CSYNC_STATUS |
typedef int | csync_treewalk_visit_func(TREE_WALK_FILE *, void *) |
typedef struct csync_tree_walk_file_s | TREE_WALK_FILE |
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_STATUS_IS_ERR | ( | x | ) | (unlikely((x) >= CSYNC_STATUS_ERROR)) |
#define CSYNC_STATUS_IS_OK | ( | x | ) | (likely((x) == CSYNC_STATUS_OK)) |
#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 void(* csync_file_progress_callback) (const char *remote_url, enum csync_notify_type_e kind, long long o1, long long o2, void *userdata) |
typedef void(* csync_log_callback) (int verbosity, const char *function, const char *buffer, void *userdata) |
typedef void(* csync_overall_progress_callback) (const char *file_name, int file_no, int file_cnt, long long o1, long long o2, void *userdata) |
Callback definition for overall progress callback.
file_no | The current number of up- or downloaded files. |
file_cnt | The overall number of files to transmit. |
o1 | The current transmitted bytes. |
o2 | The overall sum of bytes to transmit. |
userdata | The user data pointer. |
typedef enum csync_status_codes_e CSYNC_STATUS |
typedef int csync_treewalk_visit_func(TREE_WALK_FILE *,void *) |
typedef struct csync_tree_walk_file_s TREE_WALK_FILE |
enum csync_instructions_e |
enum csync_notify_type_e |
enum csync_status_codes_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_commit | ( | CSYNC * | ctx | ) |
Commit the sync results to journal.
ctx | The context to commit. |
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. |
bool csync_get_local_only | ( | CSYNC * | ctx | ) |
Retrieve the flag to tell csync that only a local run is intended.
csync_log_callback csync_get_log_callback | ( | void | ) |
Get the logging callback set.
int csync_get_log_level | ( | void | ) |
Get the log verbosity.
void* csync_get_log_userdata | ( | void | ) |
get the userdata set for the logging callback.
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 | ) |
const char* csync_get_status_string | ( | CSYNC * | ctx | ) |
Get the csync status string.
ctx | The csync context. |
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_file_progress_callback | ( | CSYNC * | ctx, |
csync_file_progress_callback | cb | ||
) |
Set a progress callback for individual files.
This callback reports about up- or download progress of a individual file.
ctx | The csync context. |
cb | The callback |
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_log_callback | ( | csync_log_callback | cb | ) |
Set the logging callback.
cb | The logging callback. |
int csync_set_log_level | ( | int | level | ) |
Set the log level.
[in] | level | The log verbosity. |
int csync_set_log_userdata | ( | void * | data | ) |
Set the userdata passed to the logging callback.
[in] | data | The userdata to set. |
int csync_set_module_property | ( | CSYNC * | ctx, |
const char * | key, | ||
void * | value | ||
) |
Set a property to module.
ctx | The csync context. |
key | The property key |
value | An opaque pointer to the data. |
int csync_set_overall_progress_callback | ( | CSYNC * | ctx, |
csync_overall_progress_callback | cb | ||
) |
Set a progress callback for the overall files.
This callback reports about overall up- or download progress.
ctx | The csync context. |
cb | The callback |
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. |
bool csync_status_ok | ( | CSYNC * | ctx | ) |
Check internal csync status.
csync | The context to check. |
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 and'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 |