QtsHttp  0.9.0
Public Member Functions | List of all members
CQtsHttpServer Class Reference

QTS http server class. More...

#include <QtsHttp.h>

Public Member Functions

 CQtsHttpServer ()
 
 CQtsHttpServer (CQtsHttpServerInfo ServerInfo)
 Constructor with CQtsHttpServerInfo server info. More...
 
 ~CQtsHttpServer ()
 
BOOL SetAgentName (LPCTSTR strAgentName)
 Developers can change HTTP agent name before call QTS NAS system/file station API. More...
 
BOOL SetTimeouts (int nTimeOutMilliseconds)
 Developers can change HTTP time-out value before call QTS NAS system/file station API. More...
 
QTS_HTTP_API_RESULT Login (QTS_HTTP_STATION_TYPE loginStation)
 Login NAS system/file station of QNAP Turbo NAS Server. More...
 
BOOL SetFileStationPortNum (long lPortNumber)
 Set file station connection port number. More...
 
BOOL SetFileStationSSLPortNum (long lSSLPortNumber)
 Set file station SSL connection port number. More...
 
QTS_HTTP_FILE_STATION_API_VERSION QueryFileStationVersion ()
 Query file station SDK version. More...
 
IQtsHttpFileStationOpenFileStation ()
 OpenFileStation if QTS_FILESTATION_VERSION = QTS_FILESTATION to get file station object. More...
 
QTS_HTTP_API_RESULT CloseFileStation (IQtsHttpFileStation **pFileStation)
 CloseFileStation if QTS_FILESTATION_VERSION = QTS_FILESTATION to close and destroy file station object. More...
 
BOOL SetSystemPortNum (long lPortNumber)
 Set NAS system connection port number. More...
 
BOOL SetSystemSSLPortNum (long lSSLPortNumber)
 Set NAS system SSL connection port number. More...
 
QTS_HTTP_SYSTEM_API_VERSION QuerySystemVersion ()
 Query NAS system SDK version. More...
 
IQtsHttpSystemOpenSystem ()
 OpenSystem if QTS_SYSTEM_VERSION = QTS_SYSTEM to get NAS system object. More...
 
QTS_HTTP_API_RESULT CloseSystem (IQtsHttpSystem **pSystem)
 CloseSystem if QTS_SYSTEM_VERSION = QTS_SYSTEM to close and destroy NAS system object. More...
 

Detailed Description

QTS http server class.

  1. Support to login QNAP Turbo NAS system and file station.
  2. Open and close QNAP Turbo NAS system/file station.

Constructor & Destructor Documentation

CQtsHttpServer::CQtsHttpServer ( )

Default constructor

CQtsHttpServer::CQtsHttpServer ( CQtsHttpServerInfo  ServerInfo)

Constructor with CQtsHttpServerInfo server info.

Parameters
[IN]ServerInfo : Qts http server info.
Returns
n/a.
CQtsHttpServer::~CQtsHttpServer ( )

Deconstructor

Member Function Documentation

QTS_HTTP_API_RESULT CQtsHttpServer::CloseFileStation ( IQtsHttpFileStation **  pFileStation)

CloseFileStation if QTS_FILESTATION_VERSION = QTS_FILESTATION to close and destroy file station object.

Parameters
[IN]pFileStation : File station object.
Returns
QTS_HTTP_API_RESULT : API success or fail error code..
QTS_HTTP_API_RESULT CQtsHttpServer::CloseSystem ( IQtsHttpSystem **  pSystem)

CloseSystem if QTS_SYSTEM_VERSION = QTS_SYSTEM to close and destroy NAS system object.

Parameters
[IN]pSystem : NAS system object.
Returns
QTS_HTTP_API_RESULT : API success or fail error code..
QTS_HTTP_API_RESULT CQtsHttpServer::Login ( QTS_HTTP_STATION_TYPE  loginStation)

Login NAS system/file station of QNAP Turbo NAS Server.

Parameters
[IN]loginStation : Login station type.
Returns
QTS_HTTP_API_RESULT : API success or fail error code.
IQtsHttpFileStation* CQtsHttpServer::OpenFileStation ( )

OpenFileStation if QTS_FILESTATION_VERSION = QTS_FILESTATION to get file station object.

Parameters
n/a
Returns
IQtsHttpFileStation* : File station object pointer.
IQtsHttpSystem* CQtsHttpServer::OpenSystem ( )

OpenSystem if QTS_SYSTEM_VERSION = QTS_SYSTEM to get NAS system object.

Parameters
n/a
Returns
IQtsHttpSystem* : NAS system object pointer.
QTS_HTTP_FILE_STATION_API_VERSION CQtsHttpServer::QueryFileStationVersion ( )

Query file station SDK version.

Parameters
n/a
Returns
QTS_HTTP_FILE_STATION_API_VERSION : File station API version.
QTS_HTTP_SYSTEM_API_VERSION CQtsHttpServer::QuerySystemVersion ( )

Query NAS system SDK version.

Parameters
n/a
Returns
QTS_HTTP_SYSTEM_API_VERSION : NAS system API version.
BOOL CQtsHttpServer::SetAgentName ( LPCTSTR  strAgentName)

Developers can change HTTP agent name before call QTS NAS system/file station API.

Parameters
[IN]strAgentName : New HTTP agent name.
Returns
TRUE : set HTTP agent name success.
FALSE : set HTTP agent name fail.
Remarks
If no change HTTP agent name,
QTS HTTP API will use default agent name to sent QTS NAS system/file station request.
BOOL CQtsHttpServer::SetFileStationPortNum ( long  lPortNumber)

Set file station connection port number.

Parameters
[IN]lPortNumber : File station port number.
Returns
TRUE : Set success.
FALSE : Set fail.
Remarks
If no set port number,
QTS file station API will use QNAP default port number to connect.
Non-SSL : 8080
BOOL CQtsHttpServer::SetFileStationSSLPortNum ( long  lSSLPortNumber)

Set file station SSL connection port number.

Parameters
[IN]lSSLPortNumber : File station SSL port number.
Returns
TRUE : Set success.
FALSE : Set fail.
Remarks
If no set SSL port number,
QTS file station API will use QNAP default SSL port number to connect.
SSL : 443
BOOL CQtsHttpServer::SetSystemPortNum ( long  lPortNumber)

Set NAS system connection port number.

Parameters
[IN]lPortNumber : NAS system port number.
Returns
TRUE : Set success.
FALSE : Set fail.
Remarks
If no set port number,
QTS NAS system API will use QNAP default port number to connect.
Non-SSL : 8080
BOOL CQtsHttpServer::SetSystemSSLPortNum ( long  lSSLPortNumber)

Set NAS system SSL connection port number.

Parameters
[IN]lSSLPortNumber : NAS system SSL port number.
Returns
TRUE : Set success.
FALSE : Set fail.
Remarks
If no set SSL port number,
QTS NAS system API will use QNAP default SSL port number to connect.
SSL : 443
BOOL CQtsHttpServer::SetTimeouts ( int  nTimeOutMilliseconds)

Developers can change HTTP time-out value before call QTS NAS system/file station API.

Parameters
[IN]nTimeOutMilliseconds : HTTP time-out value, in milliseconds.
Returns
TRUE : set HTTP time-out value success.
FALSE : set HTTP time-out value fail.
Remarks
ConnectTimeout : nTimeOutMilliseconds
SendTimeout : nTimeOutMilliseconds
ReceiveTimeout : nTimeOutMilliseconds
If no change HTTP time-out value,
QTS HTTP API will use default time-out value (30000).

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