_SftpServerContext Struct Reference

SFTP server context. More...

#include <sftp_server.h>

Data Fields

SshServerContextsshServerContext
 SSH server context. More...
 
uint_t numSessions
 Maximum number of SFTP sessions. More...
 
SftpServerSessionsessions
 SFTP sessions. More...
 
uint_t numFileObjects
 Maximum number of file objects. More...
 
SftpFileObjectfileObjects
 File objects. More...
 
char_t rootDir [SFTP_SERVER_MAX_ROOT_DIR_LEN+1]
 Root directory. More...
 
SftpServerCheckUserCallback checkUserCallback
 User verification callback function. More...
 
SftpServerGetFilePermCallback getFilePermCallback
 Callback used to retrieve file permissions. More...
 
bool_t running
 Operational state of the FTP server. More...
 
bool_t stop
 Stop request. More...
 
OsEvent event
 Event object used to poll the channels. More...
 
OsTaskParameters taskParams
 Task parameters. More...
 
OsTaskId taskId
 Task identifier. More...
 
SshChannelEventDesc eventDesc [SFTP_SERVER_MAX_SESSIONS]
 The events the application is interested in. More...
 
char_t path [SFTP_SERVER_MAX_PATH_LEN+1]
 Path name. More...
 

Detailed Description

SFTP server context.

Definition at line 244 of file sftp_server.h.

Field Documentation

◆ checkUserCallback

SftpServerCheckUserCallback checkUserCallback

User verification callback function.

Definition at line 252 of file sftp_server.h.

◆ event

OsEvent event

Event object used to poll the channels.

Definition at line 256 of file sftp_server.h.

◆ eventDesc

The events the application is interested in.

Definition at line 259 of file sftp_server.h.

◆ fileObjects

SftpFileObject* fileObjects

File objects.

Definition at line 250 of file sftp_server.h.

◆ getFilePermCallback

SftpServerGetFilePermCallback getFilePermCallback

Callback used to retrieve file permissions.

Definition at line 253 of file sftp_server.h.

◆ numFileObjects

uint_t numFileObjects

Maximum number of file objects.

Definition at line 249 of file sftp_server.h.

◆ numSessions

uint_t numSessions

Maximum number of SFTP sessions.

Definition at line 247 of file sftp_server.h.

◆ path

Path name.

Definition at line 260 of file sftp_server.h.

◆ rootDir

Root directory.

Definition at line 251 of file sftp_server.h.

◆ running

bool_t running

Operational state of the FTP server.

Definition at line 254 of file sftp_server.h.

◆ sessions

SftpServerSession* sessions

SFTP sessions.

Definition at line 248 of file sftp_server.h.

◆ sshServerContext

SshServerContext* sshServerContext

SSH server context.

Definition at line 246 of file sftp_server.h.

◆ stop

bool_t stop

Stop request.

Definition at line 255 of file sftp_server.h.

◆ taskId

OsTaskId taskId

Task identifier.

Definition at line 258 of file sftp_server.h.

◆ taskParams

OsTaskParameters taskParams

Task parameters.

Definition at line 257 of file sftp_server.h.


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