csync.h File Reference


Detailed Description

Application developer interface for csync.

Definition in file csync.h.

#include <stdbool.h>
#include <stdint.h>
#include <unistd.h>
#include <sys/types.h>

Go to the source code of this file.

Data Structures

struct  csync_tree_walk_file_s
 CSync File Traversal structure. More...

Defines

#define CSYNC_CONF_DIR   ".ocsync"
#define CSYNC_CONF_FILE   "ocsync.conf"
#define CSYNC_EXCLUDE_FILE   "ocsync_exclude.conf"
#define CSYNC_LOCK_FILE   "lock"
#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   6
#define LIBCSYNC_VERSION_MINOR   70

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 void(* csync_log_callback )(CSYNC *ctx, int verbosity, const char *function, const char *buffer, void *userdata)
typedef void(* csync_progress_callback )(const char *remote_url, enum csync_notify_type_e kind, long long o1, long long o2, void *userdata)
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_UPDATE, 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_LOOKUP,
  CSYNC_ERR_AUTH_SERVER, CSYNC_ERR_AUTH_PROXY, CSYNC_ERR_CONNECT, CSYNC_ERR_TIMEOUT,
  CSYNC_ERR_HTTP, CSYNC_ERR_PERM, CSYNC_ERR_NOT_FOUND, CSYNC_ERR_EXISTS,
  CSYNC_ERR_NOSPC, CSYNC_ERR_QUOTA, CSYNC_ERR_SERVICE_UNAVAILABLE, CSYNC_ERR_FILE_TOO_BIG,
  CSYNC_ERR_UNSPEC
}
enum  csync_ftw_type_e { CSYNC_FTW_TYPE_FILE, CSYNC_FTW_TYPE_SLINK, CSYNC_FTW_TYPE_DIR, CSYNC_FTW_TYPE_SKIP }
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
}
enum  csync_notify_type_e {
  CSYNC_NOTIFY_START_DOWNLOAD, CSYNC_NOTIFY_START_UPLOAD, CSYNC_NOTIFY_PROGRESS, CSYNC_NOTIFY_FINISHED_DOWNLOAD,
  CSYNC_NOTIFY_FINISHED_UPLOAD, CSYNC_NOTIFY_ERROR
}

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_conflictcopys (CSYNC *ctx)
int csync_enable_statedb (CSYNC *ctx)
csync_auth_callback csync_get_auth_callback (CSYNC *ctx)
const char * csync_get_config_dir (CSYNC *ctx)
CSYNC_ERROR_CODE csync_get_error (CSYNC *ctx)
const char * csync_get_error_string (CSYNC *ctx)
bool csync_get_local_only (CSYNC *ctx)
csync_log_callback csync_get_log_callback (CSYNC *ctx)
int csync_get_log_verbosity (CSYNC *ctx)
const char * csync_get_statedb_file (CSYNC *ctx)
int csync_get_status (CSYNC *ctx)
void * csync_get_userdata (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_iconv_codec (const char *from)
int csync_set_local_only (CSYNC *ctx, bool local_only)
int csync_set_log_callback (CSYNC *ctx, csync_log_callback cb)
int csync_set_log_verbosity (CSYNC *ctx, int verbosity)
int csync_set_module_property (CSYNC *ctx, const char *key, void *value)
int csync_set_progress_callback (CSYNC *ctx, csync_progress_callback cb)
int csync_set_status (CSYNC *ctx, int status)
int csync_set_userdata (CSYNC *ctx, void *userdata)
int csync_update (CSYNC *ctx)
const char * csync_version (int req_version)
int csync_walk_local_tree (CSYNC *ctx, csync_treewalk_visit_func *visitor, int filter)
int csync_walk_remote_tree (CSYNC *ctx, csync_treewalk_visit_func *visitor, int filter)


Generated on Mon Aug 18 13:53:10 2014 for doc by  doxygen 1.5.6