doc
csync_vio_method.h
Go to the documentation of this file.
1 /*
2  * libcsync -- a library to sync a directory with another
3  *
4  * Copyright (c) 2008 by Andreas Schneider <mail@cynapses.org>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * vim: ft=c.doxygen ts=2 sw=2 et cindent
21  */
22 
23 #ifndef _CSYNC_VIO_METHOD_H
24 #define _CSYNC_VIO_METHOD_H
25 
26 #include <sys/time.h>
27 
28 #include "csync.h"
30 #include "vio/csync_vio_handle.h"
31 
32 #define VIO_METHOD_HAS_FUNC(method,func) \
33  (method != NULL && method->func != NULL \
34  && ((size_t)(((char *)&((method)->func)) - ((char *)(method))) < (method)->method_table_size))
35 
37 
38 /* module capabilities definition.
39  * remember to set useful defaults in csync_vio.c if you add something here. */
41  bool atomar_copy_support; /* set to true if the backend provides atomar copy */
42  bool do_post_copy_stat; /* true if csync should check the copy afterwards */
43  bool time_sync_required; /* true if local and remote need to be time synced */
44  int unix_extensions; /* -1: do csync detection, 0: no unix extensions,
45  1: extensions available */
46  bool use_send_file_to_propagate; /* if set, the module rather copies files using send_file than read and write */
47 };
48 
50 
51 typedef csync_vio_method_t *(*csync_vio_method_init_fn)(const char *method_name,
52  const char *config_args, csync_auth_callback cb, void *userdata);
54 
55 typedef csync_vio_capabilities_t *(*csync_method_get_capabilities_fn)(void);
56 typedef const char* (*csync_method_get_file_id_fn)(const char* path);
57 typedef csync_vio_method_handle_t *(*csync_method_open_fn)(const char *durl, int flags, mode_t mode);
58 typedef csync_vio_method_handle_t *(*csync_method_creat_fn)(const char *durl, mode_t mode);
60 typedef ssize_t (*csync_method_read_fn)(csync_vio_method_handle_t *fhandle, void *buf, size_t count);
61 typedef ssize_t (*csync_method_write_fn)(csync_vio_method_handle_t *fhandle, const void *buf, size_t count);
63 typedef int64_t (*csync_method_lseek_fn)(csync_vio_method_handle_t *fhandle, int64_t offset, int whence);
64 
65 typedef csync_vio_method_handle_t *(*csync_method_opendir_fn)(const char *name);
67 typedef csync_vio_file_stat_t *(*csync_method_readdir_fn)(csync_vio_method_handle_t *dhandle);
68 
69 typedef int (*csync_method_mkdir_fn)(const char *uri, mode_t mode);
70 typedef int (*csync_method_rmdir_fn)(const char *uri);
71 
72 typedef int (*csync_method_stat_fn)(const char *uri, csync_vio_file_stat_t *buf);
73 typedef int (*csync_method_rename_fn)(const char *olduri, const char *newuri);
74 typedef int (*csync_method_unlink_fn)(const char *uri);
75 
76 typedef int (*csync_method_chmod_fn)(const char *uri, mode_t mode);
77 typedef int (*csync_method_chown_fn)(const char *uri, uid_t owner, gid_t group);
78 
79 typedef int (*csync_method_utimes_fn)(const char *uri, const struct timeval times[2]);
80 
81 typedef int (*csync_method_set_property_fn)(const char *key, void *data);
82 
83 typedef char* (*csync_method_get_error_string_fn)();
84 typedef void (*csync_method_commit_fn)();
85 
87  size_t method_table_size; /* Used for versioning */
111 };
112 
113 #endif /* _CSYNC_VIO_H */
csync_method_creat_fn creat
Application developer interface for csync.
csync_vio_file_stat_t *(* csync_method_readdir_fn)(csync_vio_method_handle_t *dhandle)
csync_method_open_fn open
csync_method_get_error_string_fn get_error_string
int(* csync_method_close_fn)(csync_vio_method_handle_t *fhandle)
csync_method_chmod_fn chmod
csync_method_get_capabilities_fn get_capabilities
csync_method_unlink_fn unlink
csync_method_mkdir_fn mkdir
csync_method_closedir_fn closedir
void(* csync_method_commit_fn)()
csync_method_close_fn close
char *(* csync_method_get_error_string_fn)()
mode_t mode
Definition: csync_private.h:70
csync_method_readdir_fn readdir
int64_t(* csync_method_lseek_fn)(csync_vio_method_handle_t *fhandle, int64_t offset, int whence)
csync_method_read_fn read
csync_vio_method_handle_t *(* csync_method_opendir_fn)(const char *name)
csync_method_chown_fn chown
csync_method_opendir_fn opendir
int(* csync_method_chown_fn)(const char *uri, uid_t owner, gid_t group)
const char *(* csync_method_get_file_id_fn)(const char *path)
int(* csync_method_closedir_fn)(csync_vio_method_handle_t *dhandle)
csync_method_commit_fn commit
int(* csync_method_sendfile_fn)(csync_vio_method_handle_t *src, csync_vio_method_handle_t *dst)
int(* csync_method_stat_fn)(const char *uri, csync_vio_file_stat_t *buf)
csync_method_stat_fn stat
int(* csync_method_rename_fn)(const char *olduri, const char *newuri)
void(* csync_vio_method_finish_fn)(csync_vio_method_t *method)
int(* csync_method_chmod_fn)(const char *uri, mode_t mode)
csync_vio_method_handle_t *(* csync_method_creat_fn)(const char *durl, mode_t mode)
int(* csync_method_set_property_fn)(const char *key, void *data)
csync_vio_capabilities_t *(* csync_method_get_capabilities_fn)(void)
csync_method_get_file_id_fn get_file_id
csync_method_rename_fn rename
csync_method_write_fn write
int(* csync_auth_callback)(const char *prompt, char *buf, size_t len, int echo, int verify, void *userdata)
Definition: csync.h:189
csync_method_set_property_fn set_property
csync_method_lseek_fn lseek
csync_vio_method_handle_t *(* csync_method_open_fn)(const char *durl, int flags, mode_t mode)
ssize_t(* csync_method_write_fn)(csync_vio_method_handle_t *fhandle, const void *buf, size_t count)
char path[1]
Definition: csync_private.h:81
int(* csync_method_unlink_fn)(const char *uri)
int(* csync_method_rmdir_fn)(const char *uri)
csync_method_rmdir_fn rmdir
ssize_t(* csync_method_read_fn)(csync_vio_method_handle_t *fhandle, void *buf, size_t count)
csync_method_sendfile_fn sendfile
int(* csync_method_utimes_fn)(const char *uri, const struct timeval times[2])
csync_method_utimes_fn utimes
void csync_vio_method_handle_t
int(* csync_method_mkdir_fn)(const char *uri, mode_t mode)