/*
- silcsftp_fs.h
+ silcsftp_fs.h
Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 2001 Pekka Riikonen
+ Copyright (C) 2001 - 2007 Pekka Riikonen
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#ifndef SILCSFTP_FS_H
#define SILCSFTP_FS_H
-/****h* silcsftp/SilcSFTPFSAPI
+/****h* silcsftp/SFTP Filesystems Interface
*
* DESCRIPTION
*
*
* The directories cannot be removed from remote access using the
* filesystem access function sftp_rmdir. This is because the filesystem
- * is one-user filesystem and differentiating between users is not
+ * is one-user filesystem and differentiating between users is not
* possible. Thus, it would allow anyone to remove directories and
* their contents. Removing directories is possible only locally using
* the silc_sftp_fs_memory_del_dir function. The same thing is with
* the silc_sftp_fs_memory_del_file function. Also, files can not ever
* be executed from remote access.
*
- * Also some of the file operation flags are not supported, such as
+ * Also some of the file operation flags are not supported, such as
* SILC_SFTP_FXF_CREAT, SILC_SFTP_FXF_TRUNC and SILC_SFTP_FXF_EXCL
* since they would require access to a real filesystem file which does
* not exist yet, or would mean destroying the file. However, the
/****s* silcsftp/SilcSFTPFSAPI/SilcSFTPFilesystemOps
*
* NAME
- *
- * typedef struct SilcSFTPFilesystemOpsStruct { ... }
+ *
+ * typedef struct SilcSFTPFilesystemOpsStruct { ... }
* *SilcSFTPFilesystemOps;
*
* DESCRIPTION
* SOURCE
*/
typedef struct SilcSFTPFilesystemOpsStruct {
- /* Find a file handle by the file handle data indicated by the `data'.
+ /* Find a file handle by the file handle data indicated by the `data'.
If the handle is not found this returns NULL. */
SilcSFTPHandle (*sftp_get_handle)(void *context, SilcSFTP sftp,
const unsigned char *data,
- uint32 data_len);
+ SilcUInt32 data_len);
/* Return encoded handle of `handle' or NULL on error. The caller
must free the returned buffer. */
unsigned char *(*sftp_encode_handle)(void *context, SilcSFTP sftp,
SilcSFTPHandle handle,
- uint32 *handle_len);
+ SilcUInt32 *handle_len);
/* Open a file indicated by the `filename' with flags indicated by the
`pflags', and with attributes indicated by the `attr'. Calls the
`callback' to return the opened file handle. */
- void (*sftp_open)(void *context, SilcSFTP sftp,
- const char *filename,
+ void (*sftp_open)(void *context, SilcSFTP sftp,
+ const char *filename,
SilcSFTPFileOperation pflags,
SilcSFTPAttributes attr,
SilcSFTPHandleCallback callback,
/* Closes the file indicated by the file handle `handle'. Calls the
`callback' to indicate the status of the closing. */
- void (*sftp_close)(void *context, SilcSFTP sftp,
+ void (*sftp_close)(void *context, SilcSFTP sftp,
SilcSFTPHandle handle,
SilcSFTPStatusCallback callback,
void *callback_context);
from the offset of `offset' at most `len' bytes. The `callback' is
called to return the read data. */
void (*sftp_read)(void *context, SilcSFTP sftp,
- SilcSFTPHandle handle,
- uint64 offset,
- uint32 len,
+ SilcSFTPHandle handle,
+ SilcUInt64 offset,
+ SilcUInt32 len,
SilcSFTPDataCallback callback,
void *callback_context);
/* Writes to a file indicated by the file handle `handle' starting from
- offset of `offset' at most `data_len' bytes of `data'. The `callback'
+ offset of `offset' at most `data_len' bytes of `data'. The `callback'
is called to indicate the status of the writing. */
void (*sftp_write)(void *context, SilcSFTP sftp,
SilcSFTPHandle handle,
- uint64 offset,
+ SilcUInt64 offset,
const unsigned char *data,
- uint32 data_len,
+ SilcUInt32 data_len,
SilcSFTPStatusCallback callback,
void *callback_context);
SilcSFTPHandle handle,
SilcSFTPAttrCallback callback,
void *callback_context);
-
+
/* Sets a file attributes to a file indicated by the `path' with the
attributes indicated by the `attrs'. Calls the `callback' to indicate
the status of the setting. */
SilcSFTPNameCallback callback,
void *callback_context);
- /* Performs an extended operation indicated by the `request' with
+ /* Performs an extended operation indicated by the `request' with
optional extended operation data indicated by the `data'. The callback
is called to return any data associated with the extended request. */
void (*sftp_extended)(void *context, SilcSFTP sftp,
const char *request,
const unsigned char *data,
- uint32 data_len,
+ SilcUInt32 data_len,
SilcSFTPExtendedCallback callback,
void *callback_context);
} *SilcSFTPFilesystemOps;
/****s* silcsftp/SilcSFTPFSAPI/SilcSFTPFilesystem
*
* NAME
- *
+ *
* typedef struct { ... } *SilcSFTPFilesystem;
*
* DESCRIPTION
*
* SOURCE
*/
-typedef struct {
+typedef struct SilcSFTPFilesystemStruct {
SilcSFTPFilesystemOps fs;
void *fs_context;
} *SilcSFTPFilesystem;
/****d* silcsftp/SilcSFTPFSAPI/SilcSFTPFSMemoryPerm
*
* NAME
- *
+ *
* typedef enum { ... } SilcSFTPFSMemoryPerm;
*
* DESCRIPTION
*
* SYNOPSIS
*
- * void *silc_sftp_fs_memory_add_dir(void *context, void *dir,
+ * void *silc_sftp_fs_memory_add_dir(SilcSFTPFilesystem fs, void *dir,
* SilcSFTPFSMemoryPerm perm,
* const char *name);
*
* or new subdirectories under the directory. The `dir' is the parent
* directory of the directory to be added. If this directory is to be
* added to the root directory the `dir' is NULL. The `name' is the name
- * of the directory. If error occurs this returns NULL. The `perm' will
+ * of the directory. If error occurs this returns NULL. The `perm' will
* indicate the permissions for the directory and they work in POSIX
- * style.
+ * style.
*
***/
void *silc_sftp_fs_memory_add_dir(SilcSFTPFilesystem fs, void *dir,
*
* SYNOPSIS
*
- * bool silc_sftp_fs_memory_del_dir(SilcSFTPFilesystem fs, void *dir);
+ * SilcBool silc_sftp_fs_memory_del_dir(SilcSFTPFilesystem fs, void *dir);
*
* DESCRIPTION
*
* access function sftp_rmdir.
*
***/
-bool silc_sftp_fs_memory_del_dir(SilcSFTPFilesystem fs, void *dir);
+SilcBool silc_sftp_fs_memory_del_dir(SilcSFTPFilesystem fs, void *dir);
/****f* silcsftp/SilcSFTPFSAPI/silc_sftp_fs_memory_add_file
*
* SYNOPSIS
*
- * bool silc_sftp_fs_memory_add_file(SilcSFTPFilesystem fs, void *dir,
- * SilcSFTPFSMemoryPerm perm,
- * const char *filename,
- * const char *realpath);
+ * SilcBool silc_sftp_fs_memory_add_file(SilcSFTPFilesystem fs, void *dir,
+ * SilcSFTPFSMemoryPerm perm,
+ * const char *filename,
+ * const char *realpath);
*
* DESCRIPTION
*
* was added to the directory.
*
***/
-bool silc_sftp_fs_memory_add_file(SilcSFTPFilesystem fs, void *dir,
- SilcSFTPFSMemoryPerm perm,
- const char *filename,
- const char *realpath);
+SilcBool silc_sftp_fs_memory_add_file(SilcSFTPFilesystem fs, void *dir,
+ SilcSFTPFSMemoryPerm perm,
+ const char *filename,
+ const char *realpath);
/****f* silcsftp/SilcSFTPFSAPI/silc_sftp_fs_memory_del_file
*
* SYNOPSIS
*
- * bool silc_sftp_fs_memory_del_file(SilcSFTPFilesystem fs, void *dir,
- * const char *filename);
+ * SilcBool silc_sftp_fs_memory_del_file(SilcSFTPFilesystem fs, void *dir,
+ * const char *filename);
*
* DESCRIPTION
*
* access function sftp_remove.
*
***/
-bool silc_sftp_fs_memory_del_file(SilcSFTPFilesystem fs, void *dir,
- const char *filename);
+SilcBool silc_sftp_fs_memory_del_file(SilcSFTPFilesystem fs, void *dir,
+ const char *filename);
#endif /* SILCSFTP_FS_H */
projects / runtime.git / blobdiff