SFTP client context. More...
#include <sftp_client.h>
Data Fields | |
| SftpVersion | version |
| SFTP protocol version. More... | |
| SftpClientState | state |
| SFTP client state. More... | |
| NetInterface * | interface |
| Underlying network interface. More... | |
| SftpClientSshInitCallback | sshInitCallback |
| SSH initialization callback function. More... | |
| systime_t | timeout |
| Timeout value. More... | |
| systime_t | timestamp |
| Timestamp to manage timeout. More... | |
| uint8_t | buffer [SFTP_CLIENT_BUFFER_SIZE] |
| Memory buffer for input/output operations. More... | |
| SftpPacketType | requestType |
| Request type. More... | |
| uint32_t | requestId |
| Request identifier. More... | |
| size_t | requestLen |
| size_t | requestPos |
| size_t | responseLen |
| size_t | responsePos |
| size_t | responseTotalLen |
| size_t | dataLen |
| Length of the data payload. More... | |
| uint64_t | fileOffset |
| Offset within the file. More... | |
| uint32_t | statusCode |
| Status code returned by the server. More... | |
| char_t | currentDir [SFTP_CLIENT_MAX_PATH_LEN+1] |
| Current directory. More... | |
| uint8_t | handle [SFTP_CLIENT_MAX_HANDLE_SIZE] |
| File handle (opaque string) More... | |
| size_t | handleLen |
| Length of the file handle, in bytes. More... | |
| SshContext | sshContext |
| SSH context. More... | |
| SshConnection | sshConnection |
| SSH connection. More... | |
| SshChannel | sshChannel |
| SSH channel. More... | |
Detailed Description
SFTP client context.
Definition at line 148 of file sftp_client.h.
Field Documentation
◆ buffer
| uint8_t buffer[SFTP_CLIENT_BUFFER_SIZE] |
Memory buffer for input/output operations.
Definition at line 156 of file sftp_client.h.
◆ currentDir
| char_t currentDir[SFTP_CLIENT_MAX_PATH_LEN+1] |
Current directory.
Definition at line 167 of file sftp_client.h.
◆ dataLen
| size_t dataLen |
Length of the data payload.
Definition at line 164 of file sftp_client.h.
◆ fileOffset
| uint64_t fileOffset |
Offset within the file.
Definition at line 165 of file sftp_client.h.
◆ handle
| uint8_t handle[SFTP_CLIENT_MAX_HANDLE_SIZE] |
File handle (opaque string)
Definition at line 168 of file sftp_client.h.
◆ handleLen
| size_t handleLen |
Length of the file handle, in bytes.
Definition at line 169 of file sftp_client.h.
◆ interface
| NetInterface* interface |
Underlying network interface.
Definition at line 152 of file sftp_client.h.
◆ requestId
| uint32_t requestId |
Request identifier.
Definition at line 158 of file sftp_client.h.
◆ requestLen
| size_t requestLen |
Definition at line 159 of file sftp_client.h.
◆ requestPos
| size_t requestPos |
Definition at line 160 of file sftp_client.h.
◆ requestType
| SftpPacketType requestType |
Request type.
Definition at line 157 of file sftp_client.h.
◆ responseLen
| size_t responseLen |
Definition at line 161 of file sftp_client.h.
◆ responsePos
| size_t responsePos |
Definition at line 162 of file sftp_client.h.
◆ responseTotalLen
| size_t responseTotalLen |
Definition at line 163 of file sftp_client.h.
◆ sshChannel
| SshChannel sshChannel |
SSH channel.
Definition at line 172 of file sftp_client.h.
◆ sshConnection
| SshConnection sshConnection |
SSH connection.
Definition at line 171 of file sftp_client.h.
◆ sshContext
| SshContext sshContext |
SSH context.
Definition at line 170 of file sftp_client.h.
◆ sshInitCallback
| SftpClientSshInitCallback sshInitCallback |
SSH initialization callback function.
Definition at line 153 of file sftp_client.h.
◆ state
| SftpClientState state |
SFTP client state.
Definition at line 151 of file sftp_client.h.
◆ statusCode
| uint32_t statusCode |
Status code returned by the server.
Definition at line 166 of file sftp_client.h.
◆ timeout
| systime_t timeout |
Timeout value.
Definition at line 154 of file sftp_client.h.
◆ timestamp
| systime_t timestamp |
Timestamp to manage timeout.
Definition at line 155 of file sftp_client.h.
◆ version
| SftpVersion version |
SFTP protocol version.
Definition at line 150 of file sftp_client.h.
The documentation for this struct was generated from the following file:
- cyclone_ssh/sftp/sftp_client.h