Merge commit 'origin/silc.1.1.branch'

[silc.git] / lib / silcsftp / silcsftp.h

diff --git a/lib/silcsftp/silcsftp.h b/lib/silcsftp/silcsftp.h
index c1aa5624cf858f6c3e5e55885fff63e4d6d487de..d2364146c79f39c5f0254ce317efb6930748471f 100644 (file)
--- a/lib/silcsftp/silcsftp.h
+++ b/lib/silcsftp/silcsftp.h
@@ -158,7 +158,7 @@ typedef enum {
  *    server, and by server to return file attributes to the client.
  *
  ***/
-typedef struct {
+typedef struct SilcSFTPAttributesObject {
   SilcUInt32 flags;            /* Flags to indicate present attributes */
   SilcUInt64 size;             /* Sife of the file in bytes */
   SilcUInt32 uid;                      /* Unix user ID */
@@ -186,7 +186,7 @@ typedef struct {
  *    example when reading the contents of a directory.
  *
  ***/
-typedef struct {
+typedef struct SilcSFTPNameObject {
   char **filename;
   char **long_filename;
   SilcSFTPAttributes *attrs;
@@ -410,6 +410,9 @@ typedef void (*SilcSFTPExtendedCallback)(SilcSFTP sftp,
  *    used to read and write the SFTP packets.  The `error_cb' will be called
  *    in case a stream error occurs, such as end of stream.
  *
+ *    If `schedule' is NULL this will call silc_schedule_get_global to try to
+ *    get global scheduler.
+ *
  ***/
 SilcSFTP silc_sftp_client_start(SilcStream stream,
                                SilcSchedule schedule,
@@ -426,8 +429,8 @@ SilcSFTP silc_sftp_client_start(SilcStream stream,
  * DESCRIPTION
  *
  *    Shutdown's the SFTP client.  The caller is responsible of closing
- *    the associated socket connection.  The SFTP context is freed and is
- *    invalid after this function returns.
+ *    the associated stream.  The SFTP context is freed and is invalid after
+ *    this function returns.
  *
  ***/
 void silc_sftp_client_shutdown(SilcSFTP sftp);
@@ -874,6 +877,9 @@ void silc_sftp_extended(SilcSFTP sftp,
  *    responsible of closing and destroying the `stream'.  The `fs' is the
  *    filesystem context allocated by the application.
  *
+ *    If `schedule' is NULL this will call silc_schedule_get_global to try to
+ *    get global scheduler.
+ *
  ***/
 SilcSFTP silc_sftp_server_start(SilcStream stream,
                                SilcSchedule schedule,
@@ -889,9 +895,9 @@ SilcSFTP silc_sftp_server_start(SilcStream stream,
  *
  * DESCRIPTION
  *
- *    Shutdown's the SFTP server.  The caller is responsible of closing
- *    the associated socket connection.  The SFTP context is freed and is
- *    invalid after this function returns.
+ *    Shutdown the SFTP server.  The caller is responsible of closing the
+ *    associated stream.  The SFTP context is freed and is invalid after
+ *    this function returns.
  *
  ***/
 void silc_sftp_server_shutdown(SilcSFTP sftp);
@@ -943,11 +949,12 @@ typedef enum {
  *
  *    This structure includes the monitor type specific data.  The
  *    application can check what the client has requested from this
- *    structure.
+ *    structure.  See the comments below what data is available for what
+ *    monitor type.
  *
  * SOURCE
  */
-typedef struct {
+typedef struct SilcSFTPMonitorDataObject {
   SilcSFTPVersion version;     /* _INIT */
   char *name;                  /* _OPEN, _REMOVE, _RENAME, _MKDIR,
                                   _RMDIR, _OPENDIR, _STAT, _LSTAT,