QtsHttp  0.9.0
Classes | Macros | Typedefs | Enumerations
QtsHttpFileStation.h File Reference
#include "QtsHttpComm.h"

Go to the source code of this file.

Classes

struct  _QTS_HTTP_FILE_STATION_ASYNC_RESPONSE_CTX_
 Context for file station response callback. More...
 
class  CQtsHttpShareLinkInfo
 Share link information class. More...
 
class  CQtsHttpFileEntry
 File or folder information class. More...
 
class  CQtsHttpFileStatus
 File or folder status class. More...
 
class  CQtsHttpShareLink
 Share link class. More...
 
class  CQtsHttpExtractEntry
 Each file/folder entry in extracted file. More...
 
class  CQtsHttpNASInfo
 Domain IP list of QNAP Turbo NAS. More...
 
class  IQtsHttpFileStationRequestBase
 Interface for file station request base. More...
 
class  IQtsHttpFileStation
 Interface for Qts Http file station API. More...
 

Macros

#define QTSHTTPDLL_API   __declspec(dllimport)
 
#define EXPIMP_TEMPLATE   extern
 

Typedefs

typedef enum
_QTS_HTTP_FILE_STATION_API_VERSION_ 
QTS_HTTP_FILE_STATION_API_VERSION
 
typedef enum
_QTS_HTTP_FILE_STATION_COMPRESS_FORMAT_TYPE_ 
QTS_HTTP_FILE_STATION_COMPRESS_FORMAT_TYPE
 
typedef enum
_QTS_HTTP_FILE_STATION_COMPRESS_LEVEL_ 
QTS_HTTP_FILE_STATION_COMPRESS_LEVEL
 
typedef enum
_QTS_HTTP_FILE_STATION_COMPRESS_ENCRYPT_TYPE_ 
QTS_HTTP_FILE_STATION_COMPRESS_ENCRYPT_TYPE
 
typedef enum
_QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE_ 
QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE
 
typedef enum
_QTS_HTTP_FILE_STATION_EXTRACT_MODE_ 
QTS_HTTP_FILE_STATION_EXTRACT_MODE
 
typedef enum
_QTS_HTTP_FILE_STATION_EXTRACT_PATH_MODE_ 
QTS_HTTP_FILE_STATION_EXTRACT_PATH_MODE
 
typedef enum
_QTS_HTTP_FILE_STATION_OVERWRITE_ 
QTS_HTTP_FILE_STATION_OVERWRITE
 
typedef enum
_QTS_HTTP_FILE_STATION_API_TYPE_ 
QTS_HTTP_FILE_STATION_API_TYPE
 
typedef void(__stdcall * PFQTS_HTTP_FILE_STATION_SYNC_PROGRESSRATE_CALLBACK )(LPVOID lpData, int nProgressRate)
 File station callback function for sync mode API callback progress rate. More...
 
typedef void(__stdcall * PFQTS_HTTP_FILE_STATION_SYNC_PROGRESSBYTES_CALLBACK )(LPVOID lpData, LONGLONG llTotalBytesTransferred)
 File station callback function for sync mode API callback progress bytes. More...
 
typedef struct
_QTS_HTTP_FILE_STATION_ASYNC_RESPONSE_CTX_ 
QTS_HTTP_FILE_STATION_ASYNC_RESPONSE_CTX
 Context for file station response callback. More...
 
typedef struct
_QTS_HTTP_FILE_STATION_ASYNC_RESPONSE_CTX_
PQTS_HTTP_FILE_STATION_ASYNC_RESPONSE_CTX
 
typedef void(__stdcall * PFQTS_HTTP_FILE_STATION_ASYNC_RESPONSE_CALLBACK )(PQTS_HTTP_FILE_STATION_ASYNC_RESPONSE_CTX)
 File station callback function for async mode API. More...
 

Enumerations

enum  _QTS_HTTP_FILE_STATION_API_VERSION_ { QTS_HTTP_FILE_STATION_API_VERSION_UNKNOW = 0, QTS_HTTP_FILE_STATION_API_V1 = 1 }
 
enum  _QTS_HTTP_FILE_STATION_COMPRESS_FORMAT_TYPE_ { QTS_HTTP_FILE_STATION_COMPRESS_FORMAT_TYPE_ZIP = 0, QTS_HTTP_FILE_STATION_COMPRESS_FORMAT_TYPE_7Z = 1 }
 
enum  _QTS_HTTP_FILE_STATION_COMPRESS_LEVEL_ { QTS_HTTP_FILE_STATION_COMPRESS_LEVEL_NORMAL = 0, QTS_HTTP_FILE_STATION_COMPRESS_LEVEL_LARGE, QTS_HTTP_FILE_STATION_COMPRESS_LEVEL_FAST }
 
enum  _QTS_HTTP_FILE_STATION_COMPRESS_ENCRYPT_TYPE_ { QTS_HTTP_FILE_STATION_COMPRESS_ENCRYPT_TYPE_AES256 = 0, QTS_HTTP_FILE_STATION_COMPRESS_ENCRYPT_TYPE_ZIPCRYPTO }
 
enum  _QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE_ { QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE_ADD_REPLACE = 0, QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE_UPDATE_ADD, QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE_UPDATE_EXISTING, QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE_UPDATE_SYNCHRONIZE }
 
enum  _QTS_HTTP_FILE_STATION_EXTRACT_MODE_ { QTS_HTTP_FILE_STATION_EXTRACT_MODE_ALL = 0, QTS_HTTP_FILE_STATION_EXTRACT_MODE_PART }
 
enum  _QTS_HTTP_FILE_STATION_EXTRACT_PATH_MODE_ { QTS_HTTP_FILE_STATION_EXTRACT_PATH_MODE_NONE = 0, QTS_HTTP_FILE_STATION_EXTRACT_PATH_MODE_FULL }
 
enum  _QTS_HTTP_FILE_STATION_OVERWRITE_ { QTS_HTTP_FILE_STATION_OVERWRITE_SKIP = 0, QTS_HTTP_FILE_STATION_OVERWRITE_OVERWRITE }
 
enum  _QTS_HTTP_FILE_STATION_API_TYPE_ {
  QTS_HTTP_FILE_STATION_API_TYPE_UNKNOW = 0, QTS_HTTP_FILE_STATION_API_TYPE_GETFILELISTCOUNT, QTS_HTTP_FILE_STATION_API_TYPE_GETFILELIST, QTS_HTTP_FILE_STATION_API_TYPE_GETSHAREFOLDERLIST,
  QTS_HTTP_FILE_STATION_API_TYPE_CREATESHARELINK, QTS_HTTP_FILE_STATION_API_TYPE_GETSHARELINKLIST, QTS_HTTP_FILE_STATION_API_TYPE_DELETESHARELINK, QTS_HTTP_FILE_STATION_API_TYPE_CREATEFOLDER,
  QTS_HTTP_FILE_STATION_API_TYPE_COPYFILE, QTS_HTTP_FILE_STATION_API_TYPE_MOVEFILE, QTS_HTTP_FILE_STATION_API_TYPE_DELETEFILE, QTS_HTTP_FILE_STATION_API_TYPE_UPLOADFILE,
  QTS_HTTP_FILE_STATION_API_TYPE_DOWNLOADFILE, QTS_HTTP_FILE_STATION_API_TYPE_GETFILESTATUS, QTS_HTTP_FILE_STATION_API_TYPE_SEARCH, QTS_HTTP_FILE_STATION_API_TYPE_RENAME,
  QTS_HTTP_FILE_STATION_API_TYPE_UPDATE_MODIFY_DATE, QTS_HTTP_FILE_STATION_API_TYPE_COMPRESSFILES, QTS_HTTP_FILE_STATION_API_TYPE_LISTCONTENTS_EXTRACTEDFILE, QTS_HTTP_FILE_STATION_API_TYPE_EXTRACTEDFILE,
  QTS_HTTP_FILE_STATION_API_TYPE_GETDOMAINIPLIST, QTS_HTTP_FILE_STATION_API_TYPE_ADDVIDEOTRANSCODEFILE, QTS_HTTP_FILE_STATION_API_TYPE_DELETEVIDEOTRANSCODEFILE, QTS_HTTP_FILE_STATION_API_TYPE_CREATECHUNKEDUPLOADID,
  QTS_HTTP_FILE_STATION_API_TYPE_CHUNKEDUPLOAD, QTS_HTTP_FILE_STATION_API_TYPE_DELETECHUNKEDUPLOADFILE
}
 

Macro Definition Documentation

#define EXPIMP_TEMPLATE   extern
#define QTSHTTPDLL_API   __declspec(dllimport)

Typedef Documentation

typedef void(__stdcall * PFQTS_HTTP_FILE_STATION_ASYNC_RESPONSE_CALLBACK)(PQTS_HTTP_FILE_STATION_ASYNC_RESPONSE_CTX)

File station callback function for async mode API.

Parameters
[OUT]PQTS_HTTP_FILE_STATION_ASYNC_RESPONSE_CTX : Context for file station response.
Returns
n/a
typedef void(__stdcall * PFQTS_HTTP_FILE_STATION_SYNC_PROGRESSBYTES_CALLBACK)(LPVOID lpData, LONGLONG llTotalBytesTransferred)

File station callback function for sync mode API callback progress bytes.

Parameters
[OUT]lpData : Callback function owner.
[OUT]llTotalBytesTransferred : Total bytes transferred.
Returns
n/a
typedef void(__stdcall * PFQTS_HTTP_FILE_STATION_SYNC_PROGRESSRATE_CALLBACK)(LPVOID lpData, int nProgressRate)

File station callback function for sync mode API callback progress rate.

Parameters
[OUT]lpData : Callback function owner.
[OUT]nProgressRate : Progress rate.
Returns
n/a

File station API type for async mode response context

File station map to SDK version.

Context for file station response callback.

Compressed encrypt type for CompressFiles/CompressFilesAsync parameters

Compressed format for CompressFiles/CompressFilesAsync parameters

Compressed level for CompressFiles/CompressFilesAsync parameters

Compressed update mode for CompressFiles/CompressFilesAsync parameters

Extract mode for ExtractFiles/ExtractFilesAsync parameters

Extract path mode for ExtractFiles/ExtractFilesAsync parameters

File overwrite mode for ExtractFiles/ExtractFilesAsync parameters

Enumeration Type Documentation

File station API type for async mode response context

Enumerator
QTS_HTTP_FILE_STATION_API_TYPE_UNKNOW 

Unknow API

QTS_HTTP_FILE_STATION_API_TYPE_GETFILELISTCOUNT 

GetFileListCountAsync API

QTS_HTTP_FILE_STATION_API_TYPE_GETFILELIST 

GetFileListAsync API

QTS_HTTP_FILE_STATION_API_TYPE_GETSHAREFOLDERLIST 

GetShareFolderListAsync API

QTS_HTTP_FILE_STATION_API_TYPE_CREATESHARELINK 

CreateShareLinkAsync API

QTS_HTTP_FILE_STATION_API_TYPE_GETSHARELINKLIST 

GetShareLinkListAsync API

QTS_HTTP_FILE_STATION_API_TYPE_DELETESHARELINK 

DeleteShareLinkAsync API

QTS_HTTP_FILE_STATION_API_TYPE_CREATEFOLDER 

CreateFolderAsync API

QTS_HTTP_FILE_STATION_API_TYPE_COPYFILE 

CopyFileAsync API

QTS_HTTP_FILE_STATION_API_TYPE_MOVEFILE 

MoveFileAsync API

QTS_HTTP_FILE_STATION_API_TYPE_DELETEFILE 

DeleteFileAsync API

QTS_HTTP_FILE_STATION_API_TYPE_UPLOADFILE 

UploadFileAsync API

QTS_HTTP_FILE_STATION_API_TYPE_DOWNLOADFILE 

DownloadFileAsync API

QTS_HTTP_FILE_STATION_API_TYPE_GETFILESTATUS 

GetFileStatusAsync API

QTS_HTTP_FILE_STATION_API_TYPE_SEARCH 

SearchFileAsync API

QTS_HTTP_FILE_STATION_API_TYPE_RENAME 

RenameFileAsync API

QTS_HTTP_FILE_STATION_API_TYPE_UPDATE_MODIFY_DATE 

UpdateFileModifyDateAsync API

QTS_HTTP_FILE_STATION_API_TYPE_COMPRESSFILES 

CompressFilesAsync API

QTS_HTTP_FILE_STATION_API_TYPE_LISTCONTENTS_EXTRACTEDFILE 

ListContentsOfExtractedFileAsync API

QTS_HTTP_FILE_STATION_API_TYPE_EXTRACTEDFILE 

ExtractFilesAsync API

QTS_HTTP_FILE_STATION_API_TYPE_GETDOMAINIPLIST 

GetDomainIPListAsync API

QTS_HTTP_FILE_STATION_API_TYPE_ADDVIDEOTRANSCODEFILE 

AddVideoTranscodeAsync API

QTS_HTTP_FILE_STATION_API_TYPE_DELETEVIDEOTRANSCODEFILE 

DeleteVideoTranscodeAsync API

QTS_HTTP_FILE_STATION_API_TYPE_CREATECHUNKEDUPLOADID 

CreateChunkedUploadIDAsync API

QTS_HTTP_FILE_STATION_API_TYPE_CHUNKEDUPLOAD 

ChunkedUploadFileAsync API

QTS_HTTP_FILE_STATION_API_TYPE_DELETECHUNKEDUPLOADFILE 

DeleteChunkedUploadFileAsync API

File station map to SDK version.

Enumerator
QTS_HTTP_FILE_STATION_API_VERSION_UNKNOW 

Unknow version

QTS_HTTP_FILE_STATION_API_V1 

File station API Version 1

Compressed encrypt type for CompressFiles/CompressFilesAsync parameters

Enumerator
QTS_HTTP_FILE_STATION_COMPRESS_ENCRYPT_TYPE_AES256 

AES256 encrypt

QTS_HTTP_FILE_STATION_COMPRESS_ENCRYPT_TYPE_ZIPCRYPTO 

ZIP encrypt

Compressed format for CompressFiles/CompressFilesAsync parameters

Enumerator
QTS_HTTP_FILE_STATION_COMPRESS_FORMAT_TYPE_ZIP 

ZIP compressed format

QTS_HTTP_FILE_STATION_COMPRESS_FORMAT_TYPE_7Z 

7Z compressed format

Compressed level for CompressFiles/CompressFilesAsync parameters

Enumerator
QTS_HTTP_FILE_STATION_COMPRESS_LEVEL_NORMAL 

Normal compressed level

QTS_HTTP_FILE_STATION_COMPRESS_LEVEL_LARGE 

The largest compressed level

QTS_HTTP_FILE_STATION_COMPRESS_LEVEL_FAST 

The fastest compressed level

Compressed update mode for CompressFiles/CompressFilesAsync parameters

Enumerator
QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE_ADD_REPLACE 

Add and replace if file exist

QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE_UPDATE_ADD 

Update and add if file exist

QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE_UPDATE_EXISTING 

Update exist file

QTS_HTTP_FILE_STATION_COMPRESS_UPDATE_MODE_UPDATE_SYNCHRONIZE 

Synchronize update file

Extract mode for ExtractFiles/ExtractFilesAsync parameters

Enumerator
QTS_HTTP_FILE_STATION_EXTRACT_MODE_ALL 

Extract all files

QTS_HTTP_FILE_STATION_EXTRACT_MODE_PART 

Extract partial files

Extract path mode for ExtractFiles/ExtractFilesAsync parameters

Enumerator
QTS_HTTP_FILE_STATION_EXTRACT_PATH_MODE_NONE 

No full path mode

QTS_HTTP_FILE_STATION_EXTRACT_PATH_MODE_FULL 

Full path mode

File overwrite mode for ExtractFiles/ExtractFilesAsync parameters

Enumerator
QTS_HTTP_FILE_STATION_OVERWRITE_SKIP 

Skip

QTS_HTTP_FILE_STATION_OVERWRITE_OVERWRITE 

Overwrite