TrustCore SDK NanoSSH API reference  version 7.0
sftpSettings Struct Reference

Configuration settings and callback function pointers for NanoSSH FTP servers. More...

Data Fields

sbyte4(* funcPtrCloseDirUpcall )(sbyte4 connectionInstance, void **pDirCookie)
 Respond to completion of a file list command or directory list command. More...
 
sbyte4(* funcPtrCloseFileUpcall )(sbyte4 connectionInstance, void *sftpInternelDescr)
 Respond to a file close request. More...
 
sbyte4(* funcPtrCreateDir )(sbyte4 connectionInstance, sbyte *pCreateDirectoryName)
 Respond to a directory create (make) request. More...
 
sbyte4(* funcPtrGetFileStats )(sbyte4 connectionInstance, ubyte *pPath, ubyte *pPathExt, sftpFileObjDescr *p_sftpFileDescr)
 Respond to a user's request for file metadata. More...
 
sbyte4(* funcPtrGetOpenFileStats )(sbyte4 connectionInstance, sbyte4 cookie, sftpFileObjDescr *p_sftpFileDescr)
 Respond to a user's request for an open file's metadata. More...
 
sbyte4(* funcPtrOpenDirUpcall )(sbyte4 connectionInstance, const sbyte *pLongDirectoryName, void **pDirCookie)
 Respond to a directory listing request. More...
 
sbyte4(* funcPtrOpenFileUpcall )(sbyte4 connectionInstance, void *sftpInternelDescr, sbyte *pLongDirectoryName, sbyte *pFilename, sbyte4 flags)
 Respond to a file open request. More...
 
sbyte4(* funcPtrReadDirUpcall )(sbyte4 connectionInstance, sbyte *pLongDirectoryName, sftpFileObjDescr *p_sftpFileDescr, void **pDirCookie)
 Respond to a file list request. More...
 
sbyte4(* funcPtrReadFileUpcall )(sbyte4 connectionInstance, void *sftpInternelDescr)
 Respond to a file download request. More...
 
sbyte4(* funcPtrRemoveDir )(sbyte4 connectionInstance, sbyte *pRemoveDirectoryName)
 Respond to a directory remove (delete) request. More...
 
sbyte4(* funcPtrRemoveFile )(sbyte4 connectionInstance, sbyte *pRemoveFilename)
 Respond to a file remove (delete) request. More...
 
sbyte4(* funcPtrRenameFile )(sbyte4 connectionInstance, sbyte *pOldFilename, sbyte *pNewFilename)
 Respond to a file rename request. More...
 
sbyte4(* funcPtrWriteFileUpcall )(sbyte4 connectionInstance, void *sftpInternelDescr)
 Respond to a file upload request. More...
 

Detailed Description

This structure is used for NanoSSH FTP Server configuration. Each included callback function should be customized for your application and then registered by assigning it to the appropriate structure function pointer(s).

Since
1.41
Version
2.02 and later

To use this structure, the following flag must be defined in moptions.h:

  • __ENABLE_MOCANA_SSH_FTP_SERVER__

The documentation for this struct was generated from the following file: