sftp.h File Reference

NanoSSH SFTP server developer API header. More...

Go to the source code of this file.

Data Structures
struct	sftpSettings
	Configuration settings and callback function pointers for NanoSSH FTP servers. More...

Functions
MOC_EXTERN void *	SSH_sftpGetCookie (void *sftpInternelDescr)
	Get a connection's cookie (containing custom information). More...
MOC_EXTERN void	SSH_sftpNumBytesRead (void *sftpInternelDescr, sbyte4 numBytesRead)
	Set an sftp file descriptor's $numBytesRead value to the number of bytes read from the incoming socket. More...
MOC_EXTERN sbyte *	SSH_sftpReadBuffer (void *sftpInternelDescr)
	Get a pointer to a buffer containing a file's read data. More...
MOC_EXTERN sbyte4	SSH_sftpReadBufferSize (void *sftpInternelDescr)
	Get the number of read bytes a client is requesting. More...
MOC_EXTERN sbyte4	SSH_sftpReadLocation (void *sftpInternelDescr)
	Get a file's read byte position. More...
MOC_EXTERN void	SSH_sftpSetCookie (void *sftpInternelDescr, void *sftpCookie)
	Save a cookie containing custom information about a context connection. More...
MOC_EXTERN sbyte4	SSH_sftpSetHomeDirectory (sbyte4 connectionInstance, sbyte *pHomeDirectory)
	Define an SFTP client's default home directory. More...
MOC_EXTERN sbyte4	SSH_sftpSetMemberOfGroups (sbyte4 connectionInstance, ubyte4 memberGroups)
	Set an individual SFTP user's permissions. More...
MOC_EXTERN sftpSettings *	SSH_sftpSettings (void)
	Get a pointer to NanoSSH SFTP server settings. More...
MOC_EXTERN sbyte *	SSH_sftpWriteBuffer (void *sftpInternelDescr)
	Get a pointer to a buffer (received from an SFTP client) containing data to write to a file. More...
MOC_EXTERN sbyte4	SSH_sftpWriteBufferSize (void *sftpInternelDescr)
	Get the number of bytes written to a file by an SFTP write upcall handler. More...
MOC_EXTERN sbyte4	SSH_sftpWriteLocation (void *sftpInternelDescr)
	Get a file's write byte position. More...

Detailed Description

This header file contains definitions, structures, and function declarations used by the NanoSSH SFTP server.

Since

1.41

Version

2.02 and later

To build products using this header file, the following flag must be defined in moptions.h:

• __ENABLE_MOCANA_SSH_FTP_SERVER__

sftp.h