*
* SFTP Version type.
*
- * SOURCE
- */
+ ***/
typedef SilcUInt32 SilcSFTPVersion;
-/***/
/* SFTP protocol version */
#define SILC_SFTP_PROTOCOL_VERSION 3
* 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 */
* example when reading the contents of a directory.
*
***/
-typedef struct {
+typedef struct SilcSFTPNameObject {
char **filename;
char **long_filename;
SilcSFTPAttributes *attrs;
*
* Error callback is called if a connection error occurs during SFTP
* session. If the connection or stream is closed this callback is
- * called. Other errors are delivered in other callbacks.
+ * called. Other errors are delivered in other callbacks. Only the
+ * SILC_SFTP_STATUS_EOF or SILC_SFTP_STATUS_NO_CONNECTION is delivered
+ * in this callback.
*
***/
typedef void (*SilcSFTPErrorCallback)(SilcSFTP sftp,
* DESCRIPTION
*
* Starts SFTP client and returns context to it. The version callback
- * indicated by the `callback' will be called after the SFTP session has
+ * indicated by the `version_cb' will be called after the SFTP session has
* been started and server has returned the version of the protocol. The
* SFTP client context is returned in the callback too. This returns the
* allocated SFTP client context or NULL on error. The `stream' will be
- * used to read and write the SFTP packets.
+ * 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.
*
***/
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);
* DESCRIPTION
*
* Starts SFTP server and returns a context to it. This function returns
- * the allocated SFTP server context or NULL on error. The `send_packet'
- * is called by the library when it needs to send a packet. The `fs' is the
- * filesystem context allocated by the application. Each socket connection
- * should start its own server by calling this function.
+ * the allocated SFTP server context or NULL on error. The `stream' is
+ * the stream (connection) to the client. The `error_cb' will be called
+ * when the `stream' is ended (SILC_SFTP_STATUS_EOF). The caller is
+ * responsible of closing and destroying the `stream'. The `fs' is the
+ * filesystem context allocated by the application.
*
***/
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);
*
* 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,