OFTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The OFTPServer class implements the server side of the Odette File Transfer Protocol.

Syntax

OFTPServer

Remarks

The OFTPServer component implements an OFTP server. It is a lightweight server that supports version 1.2, 1.3, 1.4, and 2.0 of OFTP.

Sending and Receiving Files

To use the class first decide if you will support TLS/SSL connections or not. If UseSSL is set to true, all clients will be expected to connect in TLS/SSL. If UseSSL is set to false (default), all clients are expected to connect in plaintext. If UseSSL is true, only clients that support Version 2.0 of the protocol can connect.

Once you have decided whether or not to support TLS/SSL, specify the port you wish the server to listen on in LocalPort. By default this value is 3305.

Next, specify values for ServerSSIDCode, ServerSFIDCode, ServerPassword.

Then set Listening to true to start listening for incoming requests.

When a client connects, you will have an opportunity to authenticate the client before continuing the connection. This is done when the AcceptConnection event fires. Within this event you can validate that the connecting client has access based on rules you determine. If you wish to reject the connection set the Accept parameter to false. Within this event you can also specify the directory to which files sent by the client to the server are saved. It is necessary to specify the directory within this event, as the client can start sending files as soon as the connection is complete. To specify the download directory set the OFTPConnectionDownloadDirectory property. For instance: oftpserver1.SetOFTPConnectionDownloadDirectory(e->ConnectionId, "C:\\Downloads");

When the connection is complete, the client may send files. If the client does send a file the AcceptFile event will fire and you will have the opportunity to reject the file by setting the Accept parameter of the event. In addition you will have a chance to change the filename by setting the Filename parameter if desired.

After the client has sent all the files it is configured to send, it will pass control to the server. At that time the ReadyToSend event will fire, and the OFTPConnectionReadyToSend property will be set to true. After this, you can either end the session with the client by calling Logoff or send files to the client. To send files to the client simply call the SendFile method with the specified parameters.

TLS/SSL Notes

When UseSSL is set to true, the server must be configured with a TLS/SSL certificate before it is started. Set SSLCert to a valid certificate with corresponding private key before setting Listening to true. This may be a PFX file, PEM key, or a certificate in a windows certificate store. See the SSLCert property for more information.

After SSLCert is set to a valid certificate and Listening is set to true, when a client connects the SSLStatus event will fire during the TLS/SSL negotiation. This is purely informational, if there is an error the Error event will fire.

If you want to require TLS/SSL client authentication, set SSLAuthenticateClients to true before setting Listening to true. This will force clients to present a certificate during TLS/SSL negotiation to be used for authorization. In this case the SSLClientAuthentication event will fire and you must set the Accept parameter within the event to true in order to accept the client's certificate and proceed with the connection.

Example Code

MyOftpserver server; server.SetServerSSIDCode("SERVERSSID"); server.SetServerSFIDCode("SERVERSFID"); server.SetServerPassword("SERVER"); server.SetListening(true); ... //Within the main loop of the application call server.DoEvents() in a loop //to process events. //When the ReadyToSend event fires the server can then send files to the client. To do this call the SendFile method. //Alternatively, monitor server.GetOFTPConnectionReadyToSend(<ConnectionId>) to determine when files can be sent. class MyOFTPServer : public OFTPServer { public: MyOFTPServer() {} virtual int FireAcceptConnection(OFTPServerAcceptConnectionEventParams* e) { clientConnectionId = e->ConnectionId; clientSSIDCode = strdup(e->ClientSSIDCode); this->SetOFTPConnectionDownloadDirectory(e->ConnectionId, INCOMING_DIR); return 0; } virtual int FireAcceptFile(OFTPServerAcceptFileEventParams* e) { //e->Accept = False; //To reject a file set e->Accept to false return 0; } virtual int FirePITrail(OFTPServerPITrailEventParams* e) { char logmsg[MAX_PATH]; if (e->Direction == 0) { sprintf(logmsg, "CLIENT: %s : %s", e->CommandId, e->CommandDescription); } else { sprintf(logmsg, "SERVER: %s : %s", e->CommandId, e->CommandDescription); } printf(logmsg); return 0; } virtual int FireError(OFTPServerErrorEventParams* e) { printf("[%d] %s\n", e->ErrorCode,strdup(e->Description)); return 0; } };

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

CertEncoded Property (OFTPServer Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertEncoded(char* &lpCertEncoded, int &lenCertEncoded);
int SetCertEncoded(const char* lpCertEncoded, int lenCertEncoded);

Unicode (Windows)
INT GetCertEncoded(LPSTR &lpCertEncoded, INT &lenCertEncoded);
INT SetCertEncoded(LPCSTR lpCertEncoded, INT lenCertEncoded);

int ipworksedi_oftpserver_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksedi_oftpserver_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

CertStore Property (OFTPServer Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStore(char* &lpCertStore, int &lenCertStore);
int SetCertStore(const char* lpCertStore, int lenCertStore);

Unicode (Windows)
INT GetCertStore(LPSTR &lpCertStore, INT &lenCertStore);
INT SetCertStore(LPCSTR lpCertStore, INT lenCertStore);

int ipworksedi_oftpserver_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksedi_oftpserver_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

CertStorePassword Property (OFTPServer Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertStorePassword();
int SetCertStorePassword(const char* lpszCertStorePassword);

Unicode (Windows)
LPWSTR GetCertStorePassword();
INT SetCertStorePassword(LPCWSTR lpszCertStorePassword);

char* ipworksedi_oftpserver_getcertstorepassword(void* lpObj);
int ipworksedi_oftpserver_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

CertStoreType Property (OFTPServer Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

Unicode (Windows)
INT GetCertStoreType();
INT SetCertStoreType(INT iCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_oftpserver_getcertstoretype(void* lpObj);
int ipworksedi_oftpserver_setcertstoretype(void* lpObj, int iCertStoreType);

int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

CertSubject Property (OFTPServer Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSubject();
int SetCertSubject(const char* lpszCertSubject);

Unicode (Windows)
LPWSTR GetCertSubject();
INT SetCertSubject(LPCWSTR lpszCertSubject);

char* ipworksedi_oftpserver_getcertsubject(void* lpObj);
int ipworksedi_oftpserver_setcertsubject(void* lpObj, const char* lpszCertSubject);

QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ConnectionBacklog Property (OFTPServer Class)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog);

Unicode (Windows)
INT GetConnectionBacklog();
INT SetConnectionBacklog(INT iConnectionBacklog);

int ipworksedi_oftpserver_getconnectionbacklog(void* lpObj);
int ipworksedi_oftpserver_setconnectionbacklog(void* lpObj, int iConnectionBacklog);

int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog);

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

This property is not available at design time.

Data Type

Integer

OFTPConnectionCount Property (OFTPServer Class)

The number of records in the OFTPConnection arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionCount();

Unicode (Windows)
INT GetOFTPConnectionCount();

int ipworksedi_oftpserver_getoftpconnectioncount(void* lpObj);

int GetOFTPConnectionCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• OFTPConnectionCompress
• OFTPConnectionConnected
• OFTPConnectionConnectionId
• OFTPConnectionDownloadDirectory
• OFTPConnectionEncryptionAlgorithm
• OFTPConnectionLocalAddress
• OFTPConnectionMaxRecordSize
• OFTPConnectionReadyToSend
• OFTPConnectionRecipientCertStore
• OFTPConnectionRecipientCertStorePassword
• OFTPConnectionRecipientCertStoreType
• OFTPConnectionRecipientCertSubject
• OFTPConnectionRemoteHost
• OFTPConnectionRemotePort
• OFTPConnectionSFIDCode
• OFTPConnectionSignedReceipt
• OFTPConnectionSSIDCode
• OFTPConnectionTimeout
• OFTPConnectionVersion
• OFTPConnectionVirtualFileDate
• OFTPConnectionVirtualFileFormat
• OFTPConnectionVirtualFileSecurityLevel

The array indices start at 0 and end at OFTPConnectionCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

OFTPConnectionCompress Property (OFTPServer Class)

Whether or not compression is used on the outgoing or incoming file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionCompress(int iConnectionId);
int SetOFTPConnectionCompress(int iConnectionId, int bOFTPConnectionCompress);

Unicode (Windows)
BOOL GetOFTPConnectionCompress(INT iConnectionId);
INT SetOFTPConnectionCompress(INT iConnectionId, BOOL bOFTPConnectionCompress);

int ipworksedi_oftpserver_getoftpconnectioncompress(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectioncompress(void* lpObj, int connectionid, int bOFTPConnectionCompress);

bool GetOFTPConnectionCompress(int iConnectionId);
int SetOFTPConnectionCompress(int iConnectionId, bool bOFTPConnectionCompress);

Default Value

FALSE

Remarks

Whether or not compression is used on the outgoing or incoming file.

When sending files to the client, if Compress is true the file will be compressed.

When receiving files, query this property to determine whether the file received from the client was compressed or not.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Boolean

OFTPConnectionConnected Property (OFTPServer Class)

This property is used to disconnect individual connections or to show their status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionConnected(int iConnectionId);
int SetOFTPConnectionConnected(int iConnectionId, int bOFTPConnectionConnected);

Unicode (Windows)
BOOL GetOFTPConnectionConnected(INT iConnectionId);
INT SetOFTPConnectionConnected(INT iConnectionId, BOOL bOFTPConnectionConnected);

int ipworksedi_oftpserver_getoftpconnectionconnected(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionconnected(void* lpObj, int connectionid, int bOFTPConnectionConnected);

bool GetOFTPConnectionConnected(int iConnectionId);
int SetOFTPConnectionConnected(int iConnectionId, bool bOFTPConnectionConnected);

Default Value

FALSE

Remarks

This property is used to disconnect individual connections or to show their status.

The OFTPConnectionConnected property may be set to false to close the connection.

OFTPConnectionConnected also shows the status of a particular connection (connected/disconnected).

How and when the connection is closed is controlled by the Linger property. Please refer to its description for more information.

Note: It is recommended to use the Disconnect method instead of setting this property.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Boolean

OFTPConnectionConnectionId Property (OFTPServer Class)

This property contains an identifier generated by the class to identify each connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFTPConnectionConnectionId(int iConnectionId);

Unicode (Windows)
LPWSTR GetOFTPConnectionConnectionId(INT iConnectionId);

char* ipworksedi_oftpserver_getoftpconnectionconnectionid(void* lpObj, int connectionid);

QString GetOFTPConnectionConnectionId(int iConnectionId);

Default Value

""

Remarks

This property contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

OFTPConnectionDownloadDirectory Property (OFTPServer Class)

The directory to which files will be saved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFTPConnectionDownloadDirectory(int iConnectionId);
int SetOFTPConnectionDownloadDirectory(int iConnectionId, const char* lpszOFTPConnectionDownloadDirectory);

Unicode (Windows)
LPWSTR GetOFTPConnectionDownloadDirectory(INT iConnectionId);
INT SetOFTPConnectionDownloadDirectory(INT iConnectionId, LPCWSTR lpszOFTPConnectionDownloadDirectory);

char* ipworksedi_oftpserver_getoftpconnectiondownloaddirectory(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectiondownloaddirectory(void* lpObj, int connectionid, const char* lpszOFTPConnectionDownloadDirectory);

QString GetOFTPConnectionDownloadDirectory(int iConnectionId);
int SetOFTPConnectionDownloadDirectory(int iConnectionId, QString qsOFTPConnectionDownloadDirectory);

Default Value

""

Remarks

The directory to which files will be saved.

This specifies the directory where files received by the server will be saved. This must be set before the client begins sending files. Set this in the Connected, AcceptConnection, or ConnectionRequest events, for instance: oftpserver1.SetOFTPConnectionDownloadDirectory(123456789, "C:\\Downloads");

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionEncryptionAlgorithm Property (OFTPServer Class)

The encryption algorithm used when sending files to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionEncryptionAlgorithm(int iConnectionId);
int SetOFTPConnectionEncryptionAlgorithm(int iConnectionId, int iOFTPConnectionEncryptionAlgorithm);

Unicode (Windows)
INT GetOFTPConnectionEncryptionAlgorithm(INT iConnectionId);
INT SetOFTPConnectionEncryptionAlgorithm(INT iConnectionId, INT iOFTPConnectionEncryptionAlgorithm);

CONENCRA_3DES(0), 
CONENCRA_AES(1)

int ipworksedi_oftpserver_getoftpconnectionencryptionalgorithm(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionencryptionalgorithm(void* lpObj, int connectionid, int iOFTPConnectionEncryptionAlgorithm);

int GetOFTPConnectionEncryptionAlgorithm(int iConnectionId);
int SetOFTPConnectionEncryptionAlgorithm(int iConnectionId, int iOFTPConnectionEncryptionAlgorithm);

Default Value

0

Remarks

The encryption algorithm used when sending files to the client.

In order to use encryption, you must set the OFTPConnectionVirtualFileSecurityLevel property. The supported algorithms for encryption are:

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

OFTPConnectionLocalAddress Property (OFTPServer Class)

This property shows the IP address of the interface through which the connection is passing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFTPConnectionLocalAddress(int iConnectionId);

Unicode (Windows)
LPWSTR GetOFTPConnectionLocalAddress(INT iConnectionId);

char* ipworksedi_oftpserver_getoftpconnectionlocaladdress(void* lpObj, int connectionid);

QString GetOFTPConnectionLocalAddress(int iConnectionId);

Default Value

""

Remarks

This property shows the IP address of the interface through which the connection is passing.

OFTPConnectionLocalAddress is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

OFTPConnectionMaxRecordSize Property (OFTPServer Class)

This value determines the maximum length for a record in the outgoing virtual file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionMaxRecordSize(int iConnectionId);
int SetOFTPConnectionMaxRecordSize(int iConnectionId, int iOFTPConnectionMaxRecordSize);

Unicode (Windows)
INT GetOFTPConnectionMaxRecordSize(INT iConnectionId);
INT SetOFTPConnectionMaxRecordSize(INT iConnectionId, INT iOFTPConnectionMaxRecordSize);

int ipworksedi_oftpserver_getoftpconnectionmaxrecordsize(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionmaxrecordsize(void* lpObj, int connectionid, int iOFTPConnectionMaxRecordSize);

int GetOFTPConnectionMaxRecordSize(int iConnectionId);
int SetOFTPConnectionMaxRecordSize(int iConnectionId, int iOFTPConnectionMaxRecordSize);

Default Value

0

Remarks

This value determines the maximum length for a record in the outgoing virtual file. When OFTPConnectionVirtualFileFormat has been set to ffUnstructured or ffText, this value must be zero. When ffFixed or ffVariable, this must be set to a value greater than 0, containing the maximum line length of the outgoing file.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

OFTPConnectionReadyToSend Property (OFTPServer Class)

Specifies whether or not the server can send to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionReadyToSend(int iConnectionId);

Unicode (Windows)
BOOL GetOFTPConnectionReadyToSend(INT iConnectionId);

int ipworksedi_oftpserver_getoftpconnectionreadytosend(void* lpObj, int connectionid);

bool GetOFTPConnectionReadyToSend(int iConnectionId);

Default Value

FALSE

Remarks

Specifies whether or not the server can send to the client.

When the client passes control to the server, this property will be true. Additionally the ReadyToSend event will fire at this time. This must be true before sending files to the client.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

OFTPConnectionRecipientCertStore Property (OFTPServer Class)

The name of the certificate store for the recipient certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionRecipientCertStore(int iConnectionId, char* &lpOFTPConnectionRecipientCertStore, int &lenOFTPConnectionRecipientCertStore);
int SetOFTPConnectionRecipientCertStore(int iConnectionId, const char* lpOFTPConnectionRecipientCertStore, int lenOFTPConnectionRecipientCertStore);

Unicode (Windows)
INT GetOFTPConnectionRecipientCertStore(INT iConnectionId, LPSTR &lpOFTPConnectionRecipientCertStore, INT &lenOFTPConnectionRecipientCertStore);
INT SetOFTPConnectionRecipientCertStore(INT iConnectionId, LPCSTR lpOFTPConnectionRecipientCertStore, INT lenOFTPConnectionRecipientCertStore);

int ipworksedi_oftpserver_getoftpconnectionrecipientcertstore(void* lpObj, int connectionid, char** lpOFTPConnectionRecipientCertStore, int* lenOFTPConnectionRecipientCertStore);
int ipworksedi_oftpserver_setoftpconnectionrecipientcertstore(void* lpObj, int connectionid, const char* lpOFTPConnectionRecipientCertStore, int lenOFTPConnectionRecipientCertStore);

QByteArray GetOFTPConnectionRecipientCertStore(int iConnectionId);
int SetOFTPConnectionRecipientCertStore(int iConnectionId, QByteArray qbaOFTPConnectionRecipientCertStore);

Default Value

"MY"

Remarks

The name of the certificate store for the recipient certificate.

The OFTPConnectionRecipientCertStoreType property specifies the type of the certificate store specified by OFTPConnectionRecipientCertStore. If the store is password protected, specify the password in OFTPConnectionRecipientCertStorePassword.

OFTPConnectionRecipientCertStore is used in conjunction with the OFTPConnectionRecipientCertSubject property in order to specify client certificates. If OFTPConnectionRecipientCertStore has a value, and OFTPConnectionRecipientCertSubject is set, a search for a certificate is initiated. Please refer to the OFTPConnectionRecipientCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Binary String

OFTPConnectionRecipientCertStorePassword Property (OFTPServer Class)

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFTPConnectionRecipientCertStorePassword(int iConnectionId);
int SetOFTPConnectionRecipientCertStorePassword(int iConnectionId, const char* lpszOFTPConnectionRecipientCertStorePassword);

Unicode (Windows)
LPWSTR GetOFTPConnectionRecipientCertStorePassword(INT iConnectionId);
INT SetOFTPConnectionRecipientCertStorePassword(INT iConnectionId, LPCWSTR lpszOFTPConnectionRecipientCertStorePassword);

char* ipworksedi_oftpserver_getoftpconnectionrecipientcertstorepassword(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionrecipientcertstorepassword(void* lpObj, int connectionid, const char* lpszOFTPConnectionRecipientCertStorePassword);

QString GetOFTPConnectionRecipientCertStorePassword(int iConnectionId);
int SetOFTPConnectionRecipientCertStorePassword(int iConnectionId, QString qsOFTPConnectionRecipientCertStorePassword);

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionRecipientCertStoreType Property (OFTPServer Class)

The type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionRecipientCertStoreType(int iConnectionId);
int SetOFTPConnectionRecipientCertStoreType(int iConnectionId, int iOFTPConnectionRecipientCertStoreType);

Unicode (Windows)
INT GetOFTPConnectionRecipientCertStoreType(INT iConnectionId);
INT SetOFTPConnectionRecipientCertStoreType(INT iConnectionId, INT iOFTPConnectionRecipientCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_oftpserver_getoftpconnectionrecipientcertstoretype(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionrecipientcertstoretype(void* lpObj, int connectionid, int iOFTPConnectionRecipientCertStoreType);

int GetOFTPConnectionRecipientCertStoreType(int iConnectionId);
int SetOFTPConnectionRecipientCertStoreType(int iConnectionId, int iOFTPConnectionRecipientCertStoreType);

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

OFTPConnectionRecipientCertSubject Property (OFTPServer Class)

The subject of the recipient certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFTPConnectionRecipientCertSubject(int iConnectionId);
int SetOFTPConnectionRecipientCertSubject(int iConnectionId, const char* lpszOFTPConnectionRecipientCertSubject);

Unicode (Windows)
LPWSTR GetOFTPConnectionRecipientCertSubject(INT iConnectionId);
INT SetOFTPConnectionRecipientCertSubject(INT iConnectionId, LPCWSTR lpszOFTPConnectionRecipientCertSubject);

char* ipworksedi_oftpserver_getoftpconnectionrecipientcertsubject(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionrecipientcertsubject(void* lpObj, int connectionid, const char* lpszOFTPConnectionRecipientCertSubject);

QString GetOFTPConnectionRecipientCertSubject(int iConnectionId);
int SetOFTPConnectionRecipientCertSubject(int iConnectionId, QString qsOFTPConnectionRecipientCertSubject);

Default Value

""

Remarks

The subject of the recipient certificate.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionRemoteHost Property (OFTPServer Class)

This property shows the IP address of the remote host through which the connection is coming.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFTPConnectionRemoteHost(int iConnectionId);

Unicode (Windows)
LPWSTR GetOFTPConnectionRemoteHost(INT iConnectionId);

char* ipworksedi_oftpserver_getoftpconnectionremotehost(void* lpObj, int connectionid);

QString GetOFTPConnectionRemoteHost(int iConnectionId);

Default Value

""

Remarks

This property shows the IP address of the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

OFTPConnectionRemotePort Property (OFTPServer Class)

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionRemotePort(int iConnectionId);

Unicode (Windows)
INT GetOFTPConnectionRemotePort(INT iConnectionId);

int ipworksedi_oftpserver_getoftpconnectionremoteport(void* lpObj, int connectionid);

int GetOFTPConnectionRemotePort(int iConnectionId);

Default Value

0

Remarks

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

Integer

OFTPConnectionSFIDCode Property (OFTPServer Class)

The connected client's SFID code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFTPConnectionSFIDCode(int iConnectionId);
int SetOFTPConnectionSFIDCode(int iConnectionId, const char* lpszOFTPConnectionSFIDCode);

Unicode (Windows)
LPWSTR GetOFTPConnectionSFIDCode(INT iConnectionId);
INT SetOFTPConnectionSFIDCode(INT iConnectionId, LPCWSTR lpszOFTPConnectionSFIDCode);

char* ipworksedi_oftpserver_getoftpconnectionsfidcode(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionsfidcode(void* lpObj, int connectionid, const char* lpszOFTPConnectionSFIDCode);

QString GetOFTPConnectionSFIDCode(int iConnectionId);
int SetOFTPConnectionSFIDCode(int iConnectionId, QString qsOFTPConnectionSFIDCode);

Default Value

""

Remarks

The connected client's SFID code.

The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.

When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionSignedReceipt Property (OFTPServer Class)

Indicates whether a signed receipt is requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionSignedReceipt(int iConnectionId);
int SetOFTPConnectionSignedReceipt(int iConnectionId, int bOFTPConnectionSignedReceipt);

Unicode (Windows)
BOOL GetOFTPConnectionSignedReceipt(INT iConnectionId);
INT SetOFTPConnectionSignedReceipt(INT iConnectionId, BOOL bOFTPConnectionSignedReceipt);

int ipworksedi_oftpserver_getoftpconnectionsignedreceipt(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionsignedreceipt(void* lpObj, int connectionid, int bOFTPConnectionSignedReceipt);

bool GetOFTPConnectionSignedReceipt(int iConnectionId);
int SetOFTPConnectionSignedReceipt(int iConnectionId, bool bOFTPConnectionSignedReceipt);

Default Value

FALSE

Remarks

Indicates whether a signed receipt is requested.

When sending files, if this is set to true a signed receipt will be requested. In that case OFTPConnectionRecipientCertStoreType, OFTPConnectionRecipientCertStore, and OFTPConnectionRecipientCertSubject must be set to specify the public certificate that will be used to verify the signature on the receipt returned by the client after SendFile is called. The class will automatically verify the signature on the returned receipt.

When receiving files, query this property to determine if the client requested a signed receipt. If true, the Certificate property must be set to a certificate with private key in order to sign the receipt that will be returned to the client. The class will sign and deliver the receipt automatically.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Boolean

OFTPConnectionSSIDCode Property (OFTPServer Class)

The connected client's SSID code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFTPConnectionSSIDCode(int iConnectionId);
int SetOFTPConnectionSSIDCode(int iConnectionId, const char* lpszOFTPConnectionSSIDCode);

Unicode (Windows)
LPWSTR GetOFTPConnectionSSIDCode(INT iConnectionId);
INT SetOFTPConnectionSSIDCode(INT iConnectionId, LPCWSTR lpszOFTPConnectionSSIDCode);

char* ipworksedi_oftpserver_getoftpconnectionssidcode(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionssidcode(void* lpObj, int connectionid, const char* lpszOFTPConnectionSSIDCode);

QString GetOFTPConnectionSSIDCode(int iConnectionId);
int SetOFTPConnectionSSIDCode(int iConnectionId, QString qsOFTPConnectionSSIDCode);

Default Value

""

Remarks

The connected client's SSID code.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionTimeout Property (OFTPServer Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionTimeout(int iConnectionId);
int SetOFTPConnectionTimeout(int iConnectionId, int iOFTPConnectionTimeout);

Unicode (Windows)
INT GetOFTPConnectionTimeout(INT iConnectionId);
INT SetOFTPConnectionTimeout(INT iConnectionId, INT iOFTPConnectionTimeout);

int ipworksedi_oftpserver_getoftpconnectiontimeout(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectiontimeout(void* lpObj, int connectionid, int iOFTPConnectionTimeout);

int GetOFTPConnectionTimeout(int iConnectionId);
int SetOFTPConnectionTimeout(int iConnectionId, int iOFTPConnectionTimeout);

Default Value

0

Remarks

A timeout for the class.

If the OFTPConnectionTimeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If OFTPConnectionTimeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for OFTPConnectionTimeout is specified by the DefaultTimeout property.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

OFTPConnectionVersion Property (OFTPServer Class)

This holds the version of OFTP supported by the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionVersion(int iConnectionId);

Unicode (Windows)
INT GetOFTPConnectionVersion(INT iConnectionId);

OFTP_VER_12(0), 
OFTP_VER_13(1), 
OFTP_VER_14(2), 
OFTP_VER_20(3)

int ipworksedi_oftpserver_getoftpconnectionversion(void* lpObj, int connectionid);

int GetOFTPConnectionVersion(int iConnectionId);

Default Value

0

Remarks

This holds the version of OFTP supported by the client. This value cannot be changed. All communication with the client is performed using the version returned by this property. Possible values are:

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

Integer

OFTPConnectionVirtualFileDate Property (OFTPServer Class)

Set this to the date/time stamp for the virtual file before sending.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFTPConnectionVirtualFileDate(int iConnectionId);
int SetOFTPConnectionVirtualFileDate(int iConnectionId, const char* lpszOFTPConnectionVirtualFileDate);

Unicode (Windows)
LPWSTR GetOFTPConnectionVirtualFileDate(INT iConnectionId);
INT SetOFTPConnectionVirtualFileDate(INT iConnectionId, LPCWSTR lpszOFTPConnectionVirtualFileDate);

char* ipworksedi_oftpserver_getoftpconnectionvirtualfiledate(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionvirtualfiledate(void* lpObj, int connectionid, const char* lpszOFTPConnectionVirtualFileDate);

QString GetOFTPConnectionVirtualFileDate(int iConnectionId);
int SetOFTPConnectionVirtualFileDate(int iConnectionId, QString qsOFTPConnectionVirtualFileDate);

Default Value

""

Remarks

Set this to the date/time stamp for the virtual file before sending. If this is not set when sending a file, the current date/time will be used. This property will accept various date formats, but will return the following format only: "MM/dd/yyyy HH:mm:ss".

Supported date formats:

• ddd, d MMM yy HH:mm:ss zzz
• ddd, d MMM yyyy HH:mm:ss zzz
• d MMM yy HH:mm:ss zzz
• d MMM yyyy HH:mm:ss zzz
• dd-MMM-yyyy HH:mm:ss
• ddd, d MMM yy HH:mm:ss zz
• ddd, d MMM yyyy HH:mm:ss zz
• ddd, d MMM yy HH:mm:ss zzz
• ddd, d MMM yyyy HH:mm:ss zzz
• ddd, d MMM yy HH:mm:ss z
• ddd, d MMM yyyy HH:mm:ss z
• ddd, dd MMM yyyy HH:mm:ss 'GMT'
• dddd, MMMM dd, yyyy h:mm:ss tt
• dddd, MMMM dd yyyy h:mm tt
• yyMMddHHmmssZ
• yyyyMMddHHmmssZ
• yyMMddHHmmsszzzz
• yyyyMMddHHmmsszzzz
• yyyyMMddHHmmssffff
• MM/dd/yyyy HH:mm:ss

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionVirtualFileFormat Property (OFTPServer Class)

The structure of the outgoing or incoming file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionVirtualFileFormat(int iConnectionId);
int SetOFTPConnectionVirtualFileFormat(int iConnectionId, int iOFTPConnectionVirtualFileFormat);

Unicode (Windows)
INT GetOFTPConnectionVirtualFileFormat(INT iConnectionId);
INT SetOFTPConnectionVirtualFileFormat(INT iConnectionId, INT iOFTPConnectionVirtualFileFormat);

FF_UNSTRUCTURED(0), 
FF_TEXT(1), 
FF_FIXED(2), 
FF_VARIABLE(3)

int ipworksedi_oftpserver_getoftpconnectionvirtualfileformat(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionvirtualfileformat(void* lpObj, int connectionid, int iOFTPConnectionVirtualFileFormat);

int GetOFTPConnectionVirtualFileFormat(int iConnectionId);
int SetOFTPConnectionVirtualFileFormat(int iConnectionId, int iOFTPConnectionVirtualFileFormat);

Default Value

0

Remarks

The structure of the outgoing or incoming file.

When sending files, set this property to specify the format to apply to outgoing files.

When receiving files, query this property to determine the structure of the file received from the client.

The following values are valid file formats for outgoing virtual files:

Note: When either OFTPConnectionVirtualFileSecurityLevel has been set to a value other than slNone or OFTPConnectionCompress has been set to true, all files become ffUnstructured except ffVariable files.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

OFTPConnectionVirtualFileSecurityLevel Property (OFTPServer Class)

Specifies security options for the outgoing or incoming file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOFTPConnectionVirtualFileSecurityLevel(int iConnectionId);
int SetOFTPConnectionVirtualFileSecurityLevel(int iConnectionId, int iOFTPConnectionVirtualFileSecurityLevel);

Unicode (Windows)
INT GetOFTPConnectionVirtualFileSecurityLevel(INT iConnectionId);
INT SetOFTPConnectionVirtualFileSecurityLevel(INT iConnectionId, INT iOFTPConnectionVirtualFileSecurityLevel);

SL_NONE(0), 
SL_ENCRYPTED(1), 
SL_SIGNED(2), 
SL_ENCRYPTED_AND_SIGNED(3)

int ipworksedi_oftpserver_getoftpconnectionvirtualfilesecuritylevel(void* lpObj, int connectionid);
int ipworksedi_oftpserver_setoftpconnectionvirtualfilesecuritylevel(void* lpObj, int connectionid, int iOFTPConnectionVirtualFileSecurityLevel);

int GetOFTPConnectionVirtualFileSecurityLevel(int iConnectionId);
int SetOFTPConnectionVirtualFileSecurityLevel(int iConnectionId, int iOFTPConnectionVirtualFileSecurityLevel);

Default Value

0

Remarks

Specifies security options for the outgoing or incoming file.

When receiving files, query this property to determine the security level of the file received from the client.

When sending files to the client, this property will be used to determine what security options apply to the outgoing file. Possible values are:

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by OFTPConnectionVersion.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

DefaultTimeout Property (OFTPServer Class)

An initial timeout value to be used by incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);

Unicode (Windows)
INT GetDefaultTimeout();
INT SetDefaultTimeout(INT iDefaultTimeout);

int ipworksedi_oftpserver_getdefaulttimeout(void* lpObj);
int ipworksedi_oftpserver_setdefaulttimeout(void* lpObj, int iDefaultTimeout);

int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);

Default Value

60

Remarks

If the DefaultTimeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If DefaultTimeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the DefaultTimeout property is 60 (seconds).

Data Type

Integer

Listening Property (OFTPServer Class)

If set to True, the class accepts incoming connections on LocalPort.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListening();
int SetListening(int bListening);

Unicode (Windows)
BOOL GetListening();
INT SetListening(BOOL bListening);

int ipworksedi_oftpserver_getlistening(void* lpObj);
int ipworksedi_oftpserver_setlistening(void* lpObj, int bListening);

bool GetListening();
int SetListening(bool bListening);

Default Value

FALSE

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property.

Note: Use the StartListening and StopListening methods to control whether the class is listening.

This property is not available at design time.

Data Type

Boolean

LocalHost Property (OFTPServer Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksedi_oftpserver_getlocalhost(void* lpObj);
int ipworksedi_oftpserver_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (OFTPServer Class)

The TCP port in the local host where the class listens.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworksedi_oftpserver_getlocalport(void* lpObj);
int ipworksedi_oftpserver_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

3305

Remarks

This property must be set before OFTPServer starts listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after OFTPServer is in listening mode (after successfully assigning True to the Listening property).

The service port is not shared among servers (i.e. there can be only one OFTPServer 'listening' on a particular port at one time).

The default value for plaintext communication is 3305. If UseSSL is set to true, set this value to 6619 (the default port for SSL communication).

Data Type

Integer

ServerPassword Property (OFTPServer Class)

The server's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerPassword();
int SetServerPassword(const char* lpszServerPassword);

Unicode (Windows)
LPWSTR GetServerPassword();
INT SetServerPassword(LPCWSTR lpszServerPassword);

char* ipworksedi_oftpserver_getserverpassword(void* lpObj);
int ipworksedi_oftpserver_setserverpassword(void* lpObj, const char* lpszServerPassword);

QString GetServerPassword();
int SetServerPassword(QString qsServerPassword);

Default Value

""

Remarks

The password assigned to the server in the bilateral agreement. This property must be a string of no more than 8 characters long.

Data Type

String

ServerSFIDCode Property (OFTPServer Class)

Server's SFID code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerSFIDCode();
int SetServerSFIDCode(const char* lpszServerSFIDCode);

Unicode (Windows)
LPWSTR GetServerSFIDCode();
INT SetServerSFIDCode(LPCWSTR lpszServerSFIDCode);

char* ipworksedi_oftpserver_getserversfidcode(void* lpObj);
int ipworksedi_oftpserver_setserversfidcode(void* lpObj, const char* lpszServerSFIDCode);

QString GetServerSFIDCode();
int SetServerSFIDCode(QString qsServerSFIDCode);

Default Value

""

Remarks

The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.

When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.

Data Type

String

ServerSSIDCode Property (OFTPServer Class)

The server's SSID code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerSSIDCode();
int SetServerSSIDCode(const char* lpszServerSSIDCode);

Unicode (Windows)
LPWSTR GetServerSSIDCode();
INT SetServerSSIDCode(LPCWSTR lpszServerSSIDCode);

char* ipworksedi_oftpserver_getserverssidcode(void* lpObj);
int ipworksedi_oftpserver_setserverssidcode(void* lpObj, const char* lpszServerSSIDCode);

QString GetServerSSIDCode();
int SetServerSSIDCode(QString qsServerSSIDCode);

Default Value

""

Remarks

The identification code of the server. This code may be less than, but no more than 25 characters long. Generally, SSID codes have the following format as specified in RFC 2204 that is based on ISO 6523:

Data Type

String

SSLAuthenticateClients Property (OFTPServer Class)

If set to True, the server asks the client(s) for a certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(int bSSLAuthenticateClients);

Unicode (Windows)
BOOL GetSSLAuthenticateClients();
INT SetSSLAuthenticateClients(BOOL bSSLAuthenticateClients);

int ipworksedi_oftpserver_getsslauthenticateclients(void* lpObj);
int ipworksedi_oftpserver_setsslauthenticateclients(void* lpObj, int bSSLAuthenticateClients);

bool GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(bool bSSLAuthenticateClients);

Default Value

FALSE

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

Data Type

Boolean

SSLCertEncoded Property (OFTPServer Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksedi_oftpserver_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksedi_oftpserver_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (OFTPServer Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksedi_oftpserver_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksedi_oftpserver_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (OFTPServer Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksedi_oftpserver_getsslcertstorepassword(void* lpObj);
int ipworksedi_oftpserver_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (OFTPServer Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_oftpserver_getsslcertstoretype(void* lpObj);
int ipworksedi_oftpserver_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (OFTPServer Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksedi_oftpserver_getsslcertsubject(void* lpObj);
int ipworksedi_oftpserver_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

TrustedCertCount Property (OFTPServer Class)

The number of records in the TrustedCert arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

Unicode (Windows)
INT GetTrustedCertCount();
INT SetTrustedCertCount(INT iTrustedCertCount);

int ipworksedi_oftpserver_gettrustedcertcount(void* lpObj);
int ipworksedi_oftpserver_settrustedcertcount(void* lpObj, int iTrustedCertCount);

int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertEncoded
• TrustedCertStore
• TrustedCertStorePassword
• TrustedCertStoreType
• TrustedCertSubject

The array indices start at 0 and end at TrustedCertCount - 1.

This property is not available at design time.

Data Type

Integer

TrustedCertEncoded Property (OFTPServer Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTrustedCertEncoded(int iTrustedCertIndex, char* &lpTrustedCertEncoded, int &lenTrustedCertEncoded);
int SetTrustedCertEncoded(int iTrustedCertIndex, const char* lpTrustedCertEncoded, int lenTrustedCertEncoded);

Unicode (Windows)
INT GetTrustedCertEncoded(INT iTrustedCertIndex, LPSTR &lpTrustedCertEncoded, INT &lenTrustedCertEncoded);
INT SetTrustedCertEncoded(INT iTrustedCertIndex, LPCSTR lpTrustedCertEncoded, INT lenTrustedCertEncoded);

int ipworksedi_oftpserver_gettrustedcertencoded(void* lpObj, int trustedcertindex, char** lpTrustedCertEncoded, int* lenTrustedCertEncoded);
int ipworksedi_oftpserver_settrustedcertencoded(void* lpObj, int trustedcertindex, const char* lpTrustedCertEncoded, int lenTrustedCertEncoded);

QByteArray GetTrustedCertEncoded(int iTrustedCertIndex);
int SetTrustedCertEncoded(int iTrustedCertIndex, QByteArray qbaTrustedCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The TrustedCertStore and TrustedCertSubject properties also may be used to specify a certificate.

When TrustedCertEncoded is set, a search is initiated in the current TrustedCertStore for the private key of the certificate. If the key is found, TrustedCertSubject is updated to reflect the full subject of the selected certificate; otherwise, TrustedCertSubject is set to an empty string.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Binary String

TrustedCertStore Property (OFTPServer Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTrustedCertStore(int iTrustedCertIndex, char* &lpTrustedCertStore, int &lenTrustedCertStore);
int SetTrustedCertStore(int iTrustedCertIndex, const char* lpTrustedCertStore, int lenTrustedCertStore);

Unicode (Windows)
INT GetTrustedCertStore(INT iTrustedCertIndex, LPSTR &lpTrustedCertStore, INT &lenTrustedCertStore);
INT SetTrustedCertStore(INT iTrustedCertIndex, LPCSTR lpTrustedCertStore, INT lenTrustedCertStore);

int ipworksedi_oftpserver_gettrustedcertstore(void* lpObj, int trustedcertindex, char** lpTrustedCertStore, int* lenTrustedCertStore);
int ipworksedi_oftpserver_settrustedcertstore(void* lpObj, int trustedcertindex, const char* lpTrustedCertStore, int lenTrustedCertStore);

QByteArray GetTrustedCertStore(int iTrustedCertIndex);
int SetTrustedCertStore(int iTrustedCertIndex, QByteArray qbaTrustedCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The TrustedCertStoreType property denotes the type of the certificate store specified by TrustedCertStore. If the store is password protected, specify the password in TrustedCertStorePassword.

TrustedCertStore is used in conjunction with the TrustedCertSubject property to specify client certificates. If TrustedCertStore has a value, and TrustedCertSubject or TrustedCertEncoded is set, a search for a certificate is initiated. Please see the TrustedCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Binary String

TrustedCertStorePassword Property (OFTPServer Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrustedCertStorePassword(int iTrustedCertIndex);
int SetTrustedCertStorePassword(int iTrustedCertIndex, const char* lpszTrustedCertStorePassword);

Unicode (Windows)
LPWSTR GetTrustedCertStorePassword(INT iTrustedCertIndex);
INT SetTrustedCertStorePassword(INT iTrustedCertIndex, LPCWSTR lpszTrustedCertStorePassword);

char* ipworksedi_oftpserver_gettrustedcertstorepassword(void* lpObj, int trustedcertindex);
int ipworksedi_oftpserver_settrustedcertstorepassword(void* lpObj, int trustedcertindex, const char* lpszTrustedCertStorePassword);

QString GetTrustedCertStorePassword(int iTrustedCertIndex);
int SetTrustedCertStorePassword(int iTrustedCertIndex, QString qsTrustedCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

String

TrustedCertStoreType Property (OFTPServer Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTrustedCertStoreType(int iTrustedCertIndex);
int SetTrustedCertStoreType(int iTrustedCertIndex, int iTrustedCertStoreType);

Unicode (Windows)
INT GetTrustedCertStoreType(INT iTrustedCertIndex);
INT SetTrustedCertStoreType(INT iTrustedCertIndex, INT iTrustedCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksedi_oftpserver_gettrustedcertstoretype(void* lpObj, int trustedcertindex);
int ipworksedi_oftpserver_settrustedcertstoretype(void* lpObj, int trustedcertindex, int iTrustedCertStoreType);

int GetTrustedCertStoreType(int iTrustedCertIndex);
int SetTrustedCertStoreType(int iTrustedCertIndex, int iTrustedCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Integer

TrustedCertSubject Property (OFTPServer Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrustedCertSubject(int iTrustedCertIndex);
int SetTrustedCertSubject(int iTrustedCertIndex, const char* lpszTrustedCertSubject);

Unicode (Windows)
LPWSTR GetTrustedCertSubject(INT iTrustedCertIndex);
INT SetTrustedCertSubject(INT iTrustedCertIndex, LPCWSTR lpszTrustedCertSubject);

char* ipworksedi_oftpserver_gettrustedcertsubject(void* lpObj, int trustedcertindex);
int ipworksedi_oftpserver_settrustedcertsubject(void* lpObj, int trustedcertindex, const char* lpszTrustedCertSubject);

QString GetTrustedCertSubject(int iTrustedCertIndex);
int SetTrustedCertSubject(int iTrustedCertIndex, QString qsTrustedCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

String

UseSSL Property (OFTPServer Class)

Use SSL to access the RemoteHost .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseSSL();
int SetUseSSL(int bUseSSL);

Unicode (Windows)
BOOL GetUseSSL();
INT SetUseSSL(BOOL bUseSSL);

int ipworksedi_oftpserver_getusessl(void* lpObj);
int ipworksedi_oftpserver_setusessl(void* lpObj, int bUseSSL);

bool GetUseSSL();
int SetUseSSL(bool bUseSSL);

Default Value

FALSE

Remarks

Use this property to determine whether the class uses SSL when clients connect.

This property is only valid when using version 2.0 of the protocol. If set to true, all clients that connect must use version 2.0.

This property is not available at design time.

Data Type

Boolean

ChangeDirection Method (OFTPServer Class)

Sends a Change Direction (CD) command.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ChangeDirection(int iConnectionId);

Unicode (Windows)
INT ChangeDirection(INT iConnectionId);

int ipworksedi_oftpserver_changedirection(void* lpObj, int iConnectionId);

int ChangeDirection(int iConnectionId);

Remarks

This method sends a Change Direction (CD) command to the client when called. In normal operation this should not be used. This should only be used if a condition arises where you must manually change the speaker when communicating with the client. For instance: component.ChangeDirection(MyConnectionId);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (OFTPServer Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksedi_oftpserver_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Disconnect Method (OFTPServer Class)

This method disconnects the specified client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect(int iConnectionId);

Unicode (Windows)
INT Disconnect(INT iConnectionId);

int ipworksedi_oftpserver_disconnect(void* lpObj, int iConnectionId);

int Disconnect(int iConnectionId);

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (OFTPServer Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksedi_oftpserver_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ExchangeCertificate Method (OFTPServer Class)

Exchange a certificate with the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExchangeCertificate(int iConnectionId, const char* lpszClientSFIDCode, const char* lpszCertificateStore, int iCertificateExchangeType);

Unicode (Windows)
INT ExchangeCertificate(INT iConnectionId, LPCWSTR lpszClientSFIDCode, LPCWSTR lpszCertificateStore, INT iCertificateExchangeType);

int ipworksedi_oftpserver_exchangecertificate(void* lpObj, int iConnectionId, const char* lpszClientSFIDCode, const char* lpszCertificateStore, int iCertificateExchangeType);

int ExchangeCertificate(int iConnectionId, const QString& qsClientSFIDCode, const QString& qsCertificateStore, int iCertificateExchangeType);

Remarks

If the remote host supports the certificate exchange feature of OFTP 2.0 this method may be used to send and/or request certificates.

The CertificateStore parameter specifies the location of the certificate to be exchanged. In most cases this will be the path to a .cer file on disk. If the certificate is in another format or is installed to the Windows certificate store please see ExchangeCertStoreType and ExchangeCertSubject for more information.

The CertificateExchangeType parameter determines the type of request. Possible values are:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ImportTrustedCerts Method (OFTPServer Class)

Imports a list of trusted CA certificates.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportTrustedCerts();

Unicode (Windows)
INT ImportTrustedCerts();

int ipworksedi_oftpserver_importtrustedcerts(void* lpObj);

int ImportTrustedCerts();

Remarks

When ImportTrustedCerts is called the class will import the CA certificates from the source specified by TrustedCertsData into the TrustedCerts collection.

The class will then validate the trust of certificates when they are loaded.

If trusted CA certificates are not imported no validation will occur (default).

See also FailOnUntrustedCert.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (OFTPServer Class)

This method interrupts a synchronous send to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt(int iConnectionId);

Unicode (Windows)
INT Interrupt(INT iConnectionId);

int ipworksedi_oftpserver_interrupt(void* lpObj, int iConnectionId);

int Interrupt(int iConnectionId);

Remarks

This property is called using the Connection Id if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the class. If you use SendFile to upload a file, the class will run synchronously on that Connection Id until it is completed.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Logoff Method (OFTPServer Class)

Ends a session with the connection client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Logoff(int iConnectionId);

Unicode (Windows)
INT Logoff(INT iConnectionId);

int ipworksedi_oftpserver_logoff(void* lpObj, int iConnectionId);

int Logoff(int iConnectionId);

Remarks

This method will attempt to end the session with the client if the client has acknowledged it is finished sending files to the server. If the client still wishes to process commands, the method will give control back to the client and OFTPConnectionReadyToSend will be false. When OFTPConnectionReadyToSend is true, calling this method will end the session.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (OFTPServer Class)

Resets the state of the control.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksedi_oftpserver_reset(void* lpObj);

int Reset();

Remarks

Reset resets the state of the class. All properties will be set to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendEndResponse Method (OFTPServer Class)

Sends an EERP/NERP asynchronously.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendEndResponse(int iConnectionId, const char* lpszVirtualFileName, const char* lpszVirtualFileDate, const char* lpszDestination, const char* lpszOriginator, const char* lpszCreator, int iReasonCode, const char* lpszReasonText, const char* lpszFileHash, const char* lpszSignature);

Unicode (Windows)
INT SendEndResponse(INT iConnectionId, LPCWSTR lpszVirtualFileName, LPCWSTR lpszVirtualFileDate, LPCWSTR lpszDestination, LPCWSTR lpszOriginator, LPCWSTR lpszCreator, INT iReasonCode, LPCWSTR lpszReasonText, LPCWSTR lpszFileHash, LPCWSTR lpszSignature);

int ipworksedi_oftpserver_sendendresponse(void* lpObj, int iConnectionId, const char* lpszVirtualFileName, const char* lpszVirtualFileDate, const char* lpszDestination, const char* lpszOriginator, const char* lpszCreator, int iReasonCode, const char* lpszReasonText, const char* lpszFileHash, const char* lpszSignature);

int SendEndResponse(int iConnectionId, const QString& qsVirtualFileName, const QString& qsVirtualFileDate, const QString& qsDestination, const QString& qsOriginator, const QString& qsCreator, int iReasonCode, const QString& qsReasonText, const QString& qsFileHash, const QString& qsSignature);

Remarks

This method sends an EERP/NERP. By default the class will automatically respond with an EERP/NERP when receiving a file. To respond asynchronously instead this method may be used.

To respond asynchronously first set the SendEndResponse parameter of the EndTransfer event to False. This instructs the class to not send a response automatically. Within the EndTransfer event you must also save the values that are required parameters for this method. This includes FileHash, VirtualFileDate, and VirtualFileName. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

Destination should be set to the SFID of the remote host.

Originator should be set to the SFID of the local system. In the case that the class is being used as part of a gateway process to forward traffic to another OFTP host this may be set to the SFID of that host instead.

Creator should be set to the SFID of the local system.

Signature is only applicable if the application is acting as a routing application. In all other cases this should be set to empty string. In the case where the application is acting as a routing application the end response is being forwarded to another entity for processing. The Signature should be set to the value received in the EndResponse event (if populated).

ReasonCode and ReasonText are used to specify error information. If ReasonCode is set to 0 the class will send an EERP. If ReasonCode is set to any non-zero value the class will send a NERP. Common values are:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendFile Method (OFTPServer Class)

Sends a file to the specified client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendFile(int iConnectionId, const char* lpszClientSFIDCode, const char* lpszFileName, const char* lpszVirtualFileName);

Unicode (Windows)
INT SendFile(INT iConnectionId, LPCWSTR lpszClientSFIDCode, LPCWSTR lpszFileName, LPCWSTR lpszVirtualFileName);

int ipworksedi_oftpserver_sendfile(void* lpObj, int iConnectionId, const char* lpszClientSFIDCode, const char* lpszFileName, const char* lpszVirtualFileName);

int SendFile(int iConnectionId, const QString& qsClientSFIDCode, const QString& qsFileName, const QString& qsVirtualFileName);

Remarks

This method sends a file to the client specified by the ConnectionId parameter.

After the ReadyToSend event fires or when the OFTPConnectionReadyToSend property is true, this method can be used to send a file to the connected client specified by the ConnectionId parameter.

The ClientSFIDCode corresponds to the destination.

FileName must be the full path to the file which will be sent.

VirtualFileName may be specified to indicate the name of the file that the client will see when receiving the file.

If ConnectionsUploadStream is set, pass empty string as the value for the FileName parameter.

When this method is called, the class will fire the StartTransfer, Transfer, and EndTransfer events that can be monitored to check the status of the send. The SendFile method will not return until either the transfer is complete or an error was encountered.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Shutdown Method (OFTPServer Class)

This method shuts down the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Shutdown();

Unicode (Windows)
INT Shutdown();

int ipworksedi_oftpserver_shutdown(void* lpObj);

int Shutdown();

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartListening Method (OFTPServer Class)

This method starts listening for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();

int ipworksedi_oftpserver_startlistening(void* lpObj);

int StartListening();

Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StopListening Method (OFTPServer Class)

This method stops listening for new connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();

int ipworksedi_oftpserver_stoplistening(void* lpObj);

int StopListening();

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ValidateCert Method (OFTPServer Class)

Validates the certificate with private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ValidateCert();

Unicode (Windows)
INT ValidateCert();

int ipworksedi_oftpserver_validatecert(void* lpObj);

bool ValidateCert();

Remarks

This method optionally validates the certificate specified by Certificate. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.

Before calling this method call ImportTrustedCerts to load the trusted certification information.

When this method is called the class:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the TrustedCerts collection. If the certificate is self-signed this step is skipped.
• Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ValidateRecipientCert Method (OFTPServer Class)

Validates the recipient certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ValidateRecipientCert(int iConnectionId);

Unicode (Windows)
INT ValidateRecipientCert(INT iConnectionId);

int ipworksedi_oftpserver_validaterecipientcert(void* lpObj, int iConnectionId);

bool ValidateRecipientCert(int iConnectionId);

Remarks

This method optionally validates the certificate specified by OFTPConnectionRecipientCertSubject. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.

Before calling this method call ImportTrustedCerts to load the trusted certification information.

When this method is called the class:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the TrustedCerts collection. If the certificate is self-signed this step is skipped.
• Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

AcceptConnection Event (OFTPServer Class)

Fired when a client connects.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAcceptConnection(OFTPServerAcceptConnectionEventParams *e);

typedef struct {
  int ConnectionId;
  const char *ClientSSIDCode;
  const char *ClientPassword;
  int ClientVersion;
  int ServerVersion;
  int Accept;
  int ErrorCode;
  char *ErrorDescription;
  int reserved;
} OFTPServerAcceptConnectionEventParams;


Unicode (Windows)
virtual INT FireAcceptConnection(OFTPServerAcceptConnectionEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR ClientSSIDCode;
  LPCWSTR ClientPassword;
  INT ClientVersion;
  INT ServerVersion;
  BOOL Accept;
  INT ErrorCode;
  LPWSTR ErrorDescription;
  INT reserved;
} OFTPServerAcceptConnectionEventParams;

#define EID_OFTPSERVER_ACCEPTCONNECTION 1

virtual INT IPWORKSEDI_CALL FireAcceptConnection(INT &iConnectionId, LPSTR &lpszClientSSIDCode, LPSTR &lpszClientPassword, INT &iClientVersion, INT &iServerVersion, BOOL &bAccept, INT &iErrorCode, LPSTR &lpszErrorDescription);

class OFTPServerAcceptConnectionEventParams {
public:
  int ConnectionId();

  const QString &ClientSSIDCode();

  const QString &ClientPassword();

  int ClientVersion();

  int ServerVersion();
  void SetServerVersion(int iServerVersion);

  bool Accept();
  void SetAccept(bool bAccept);

  int ErrorCode();
  void SetErrorCode(int iErrorCode);

  const QString &ErrorDescription();
  void SetErrorDescription(const QString &qsErrorDescription);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AcceptConnection(OFTPServerAcceptConnectionEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireAcceptConnection(OFTPServerAcceptConnectionEventParams *e) {...}

Remarks

This event fires when a new OFTP connection is made to the server. Use the parameters of this event to verify the identify of the client identified by the ConnectionId. By default the connection will be accepted. To reject the connection set Accept to false.

ClientVersion specifies the OFTP protocol version the client supports. By default the class will use the version requested by the client for the connection. If you wish to restrict connections to a specific OFTP protocol version use this value when determining whether or not to accept the connection. When rejecting the connection based on the OFTP protocol version use ErrorCode 10. Possible values are:

ServerVersion specifies the OFTP protocol version the server will use for the connection. By default this will be the same as ClientVersion. This may be set to a different version which will be sent back to the client. Possible values are:

When rejecting a connection the ErrorCode and ErrorDescription may optionally be set. Possible common values are:

AcceptFile Event (OFTPServer Class)

Fired when the client sends a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAcceptFile(OFTPServerAcceptFileEventParams *e);

typedef struct {
  int ConnectionId;
  const char *VirtualFileName;
  const char *VirtualFileDate;
  const char *Destination;
  const char *Originator;
  int Accept;
  char *Filename;
  int Overwrite;
  int ErrorCode;
  char *ErrorDescription;
  int reserved;
} OFTPServerAcceptFileEventParams;


Unicode (Windows)
virtual INT FireAcceptFile(OFTPServerAcceptFileEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR VirtualFileName;
  LPCWSTR VirtualFileDate;
  LPCWSTR Destination;
  LPCWSTR Originator;
  BOOL Accept;
  LPWSTR Filename;
  BOOL Overwrite;
  INT ErrorCode;
  LPWSTR ErrorDescription;
  INT reserved;
} OFTPServerAcceptFileEventParams;

#define EID_OFTPSERVER_ACCEPTFILE 2

virtual INT IPWORKSEDI_CALL FireAcceptFile(INT &iConnectionId, LPSTR &lpszVirtualFileName, LPSTR &lpszVirtualFileDate, LPSTR &lpszDestination, LPSTR &lpszOriginator, BOOL &bAccept, LPSTR &lpszFilename, BOOL &bOverwrite, INT &iErrorCode, LPSTR &lpszErrorDescription);

class OFTPServerAcceptFileEventParams {
public:
  int ConnectionId();

  const QString &VirtualFileName();

  const QString &VirtualFileDate();

  const QString &Destination();

  const QString &Originator();

  bool Accept();
  void SetAccept(bool bAccept);

  const QString &Filename();
  void SetFilename(const QString &qsFilename);

  bool Overwrite();
  void SetOverwrite(bool bOverwrite);

  int ErrorCode();
  void SetErrorCode(int iErrorCode);

  const QString &ErrorDescription();
  void SetErrorDescription(const QString &qsErrorDescription);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AcceptFile(OFTPServerAcceptFileEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireAcceptFile(OFTPServerAcceptFileEventParams *e) {...}

Remarks

This event controls the behavior when the client sends a file to the server.

VirtualFileName holds the name of the file being received.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Destination identifies the receiver (SFID) code in the send file request. If the file was intended for this server this will match the value in ServerSFIDCode

Originator identifies the sender (SFID) code in the send file request.

Accept is true by default, and must be set to False in order to reject the file.

Filename will be populated with the full path and filename that will be written. It may be changed within this event to specify a new location. The Filename is determined by combining the path specified in OFTPConnectionDownloadDirectory and the name received from the client.

Overwrite is false by default, but may be set to true to overwrite existing files on disk.

ErrorCode controls the error returned to the client when Accept is set to False. If this is not set the class will use a value of 99 to indicate a general error.

ErrorDescription may also be set to include an error message. If this is not set the class will automatically include an error message based on the ErrorCode specified. Common error codes and their corresponding error messages are listed below.

CertificateReceived Event (OFTPServer Class)

Fired when a certificate is received from the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCertificateReceived(OFTPServerCertificateReceivedEventParams *e);

typedef struct {
  int ConnectionId;
  const char *CertificateFileName;
  int CertificateExchangeType;
  int reserved;
} OFTPServerCertificateReceivedEventParams;


Unicode (Windows)
virtual INT FireCertificateReceived(OFTPServerCertificateReceivedEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR CertificateFileName;
  INT CertificateExchangeType;
  INT reserved;
} OFTPServerCertificateReceivedEventParams;

#define EID_OFTPSERVER_CERTIFICATERECEIVED 3

virtual INT IPWORKSEDI_CALL FireCertificateReceived(INT &iConnectionId, LPSTR &lpszCertificateFileName, INT &iCertificateExchangeType);

class OFTPServerCertificateReceivedEventParams {
public:
  int ConnectionId();

  const QString &CertificateFileName();

  int CertificateExchangeType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CertificateReceived(OFTPServerCertificateReceivedEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireCertificateReceived(OFTPServerCertificateReceivedEventParams *e) {...}

Remarks

This event provides information about the certificate file that was sent by the remote host.

When the remote host sends a certificate using the Certificate Exchange feature of OFTP 2.0, this event provides information about it. The certificate file will be written to the DownloadDirectory. After the file is written to DownloadDirectory this event will fire.

The CertificateFilemame parameter holds the filename of the received certificate.

The CertificateExchangeType parameter identifies the type of request associated with the certificate. Possible values are:

ConnectionId identifies the connected client.

Connected Event (OFTPServer Class)

This event is fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(OFTPServerConnectedEventParams *e);

typedef struct {
  int ConnectionId;
  int StatusCode;
  const char *Description;
  int reserved;
} OFTPServerConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(OFTPServerConnectedEventParams *e);

typedef struct {
  INT ConnectionId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} OFTPServerConnectedEventParams;

#define EID_OFTPSERVER_CONNECTED 4

virtual INT IPWORKSEDI_CALL FireConnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);

class OFTPServerConnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(OFTPServerConnectedEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireConnected(OFTPServerConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (OFTPServer Class)

This event is fired when a request for connection comes from a remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionRequest(OFTPServerConnectionRequestEventParams *e);

typedef struct {
  const char *Address;
  int Port;
  int Accept;
  int reserved;
} OFTPServerConnectionRequestEventParams;


Unicode (Windows)
virtual INT FireConnectionRequest(OFTPServerConnectionRequestEventParams *e);

typedef struct {
  LPCWSTR Address;
  INT Port;
  BOOL Accept;
  INT reserved;
} OFTPServerConnectionRequestEventParams;

#define EID_OFTPSERVER_CONNECTIONREQUEST 5

virtual INT IPWORKSEDI_CALL FireConnectionRequest(LPSTR &lpszAddress, INT &iPort, BOOL &bAccept);

class OFTPServerConnectionRequestEventParams {
public:
  const QString &Address();

  int Port();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionRequest(OFTPServerConnectionRequestEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireConnectionRequest(OFTPServerConnectionRequestEventParams *e) {...}

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

Disconnected Event (OFTPServer Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(OFTPServerDisconnectedEventParams *e);

typedef struct {
  int ConnectionId;
  int StatusCode;
  const char *Description;
  int reserved;
} OFTPServerDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(OFTPServerDisconnectedEventParams *e);

typedef struct {
  INT ConnectionId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} OFTPServerDisconnectedEventParams;

#define EID_OFTPSERVER_DISCONNECTED 6

virtual INT IPWORKSEDI_CALL FireDisconnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);

class OFTPServerDisconnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(OFTPServerDisconnectedEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireDisconnected(OFTPServerDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

EndResponse Event (OFTPServer Class)

Fired every time an end response is received from the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndResponse(OFTPServerEndResponseEventParams *e);

typedef struct {
  int ConnectionId;
  const char *VirtualFileName;
  const char *VirtualFileDate;
  const char *Destination;
  const char *Originator;
  const char *Creator;
  int ReasonCode;
  const char *ReasonText;
  char *FileHash;
  const char *Signature;
  int Direction;
  int reserved;
} OFTPServerEndResponseEventParams;


Unicode (Windows)
virtual INT FireEndResponse(OFTPServerEndResponseEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR VirtualFileName;
  LPCWSTR VirtualFileDate;
  LPCWSTR Destination;
  LPCWSTR Originator;
  LPCWSTR Creator;
  INT ReasonCode;
  LPCWSTR ReasonText;
  LPWSTR FileHash;
  LPCWSTR Signature;
  INT Direction;
  INT reserved;
} OFTPServerEndResponseEventParams;

#define EID_OFTPSERVER_ENDRESPONSE 7

virtual INT IPWORKSEDI_CALL FireEndResponse(INT &iConnectionId, LPSTR &lpszVirtualFileName, LPSTR &lpszVirtualFileDate, LPSTR &lpszDestination, LPSTR &lpszOriginator, LPSTR &lpszCreator, INT &iReasonCode, LPSTR &lpszReasonText, LPSTR &lpszFileHash, LPSTR &lpszSignature, INT &iDirection);

class OFTPServerEndResponseEventParams {
public:
  int ConnectionId();

  const QString &VirtualFileName();

  const QString &VirtualFileDate();

  const QString &Destination();

  const QString &Originator();

  const QString &Creator();

  int ReasonCode();

  const QString &ReasonText();

  const QString &FileHash();
  void SetFileHash(const QString &qsFileHash);

  const QString &Signature();

  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndResponse(OFTPServerEndResponseEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireEndResponse(OFTPServerEndResponseEventParams *e) {...}

Remarks

This event contains information received from an either an End-To-End Response or a Negative End Response received from the server.

An End-To-End Response will not contain values for the ReasonCode, ReasonText, or Creator parameters.

VirtualFileName specifies the name of the file.

VirtualFileDate holds the VirtualFileDate value in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Destination is the SFID of the destination system (this class).

Originator identifies the system that originated the end response. This is typically the same as Creator and holds the remote system's SFID.

Creator is the SFID of the remote system.

Direction specifies whether the end response is being received or sent. Possible values are:

FileHash is populated if the OFTP Version is 2.0 and a signed receipt was originally requested. FileHash may also be specified with the expected value in the case where an asynchronous EndResponse is received. The expected value may be obtained from the EndTransfer event when initially sending the file.

Signature is only applicable when the OFTP version is 2.0 and the application is acting as a routing application where the end response will be forwarded on to another entity. In this case Signature will be populated if the end response is signed. This should be stored and supplied when forwarding the response with the SendEndResponse method.

ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:

ConnectionId identifies the connected client.

EndTransfer Event (OFTPServer Class)

Fired when a file finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(OFTPServerEndTransferEventParams *e);

typedef struct {
  int ConnectionId;
  int Direction;
  const char *LocalFile;
  const char *VirtualFileName;
  const char *VirtualFileDate;
  const char *Destination;
  const char *Originator;
  int ReasonCode;
  const char *ReasonText;
  int64 FileSize;
  const char *FileHash;
  int SendEndResponse;
  int reserved;
} OFTPServerEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(OFTPServerEndTransferEventParams *e);

typedef struct {
  INT ConnectionId;
  INT Direction;
  LPCWSTR LocalFile;
  LPCWSTR VirtualFileName;
  LPCWSTR VirtualFileDate;
  LPCWSTR Destination;
  LPCWSTR Originator;
  INT ReasonCode;
  LPCWSTR ReasonText;
  LONG64 FileSize;
  LPCWSTR FileHash;
  BOOL SendEndResponse;
  INT reserved;
} OFTPServerEndTransferEventParams;

#define EID_OFTPSERVER_ENDTRANSFER 8

virtual INT IPWORKSEDI_CALL FireEndTransfer(INT &iConnectionId, INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszVirtualFileName, LPSTR &lpszVirtualFileDate, LPSTR &lpszDestination, LPSTR &lpszOriginator, INT &iReasonCode, LPSTR &lpszReasonText, LONG64 &lFileSize, LPSTR &lpszFileHash, BOOL &bSendEndResponse);

class OFTPServerEndTransferEventParams {
public:
  int ConnectionId();

  int Direction();

  const QString &LocalFile();

  const QString &VirtualFileName();

  const QString &VirtualFileDate();

  const QString &Destination();

  const QString &Originator();

  int ReasonCode();

  const QString &ReasonText();

  qint64 FileSize();

  const QString &FileHash();

  bool SendEndResponse();
  void SetSendEndResponse(bool bSendEndResponse);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(OFTPServerEndTransferEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireEndTransfer(OFTPServerEndTransferEventParams *e) {...}

Remarks

The EndTransfer event is fired when a file is sent or received by the class.

The FileSize parameter gives the size of the file that was sent or received.

The Direction parameter shows whether the client or the server is sending the data.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

SendEndResponse indicates whether the EERP/NERP for this request should be sent synchronously or asynchronously. When this parameter is True (default) the class will automatically respond with an EERP/NERP synchronously. To respond asynchronously set this parameter to False. You may then use the SendEndResponse method to send the response at a later time. See SendEndResponse for more details. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

FileHash holds the hash of the file being transmitted. This is only applicable when the OFTP version is 2.0 and the sender requested a signed receipt. When receiving files this value should be saved if you wish to respond asynchronously using SendEndResponse. See SendEndResponse for more details.

LocalFile holds the full path to the file that will be written.

ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:

ConnectionId identifies the connected client.

Error Event (OFTPServer Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(OFTPServerErrorEventParams *e);

typedef struct {
  int ConnectionId;
  int ErrorCode;
  const char *Description;
  int reserved;
} OFTPServerErrorEventParams;


Unicode (Windows)
virtual INT FireError(OFTPServerErrorEventParams *e);

typedef struct {
  INT ConnectionId;
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} OFTPServerErrorEventParams;

#define EID_OFTPSERVER_ERROR 9

virtual INT IPWORKSEDI_CALL FireError(INT &iConnectionId, INT &iErrorCode, LPSTR &lpszDescription);

class OFTPServerErrorEventParams {
public:
  int ConnectionId();

  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(OFTPServerErrorEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireError(OFTPServerErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ConnectionId contains the Id of the connection to which this error applies.

Log Event (OFTPServer Class)

Fires once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(OFTPServerLogEventParams *e);

typedef struct {
  int ConnectionId;
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} OFTPServerLogEventParams;


Unicode (Windows)
virtual INT FireLog(OFTPServerLogEventParams *e);

typedef struct {
  INT ConnectionId;
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} OFTPServerLogEventParams;

#define EID_OFTPSERVER_LOG 10

virtual INT IPWORKSEDI_CALL FireLog(INT &iConnectionId, INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class OFTPServerLogEventParams {
public:
  int ConnectionId();

  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(OFTPServerLogEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireLog(OFTPServerLogEventParams *e) {...}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

ConnectionId identifies the connected client.

LogLevel indicates the level of message. Possible values are:

Message is the log entry.

LogType identifies the type of log entry. Possible values are:

• "Info"
• "OFTP"

PITrail Event (OFTPServer Class)

Fired when any protocol level communication occurs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePITrail(OFTPServerPITrailEventParams *e);

typedef struct {
  int ConnectionId;
  int Direction;
  const char *Data;
  int lenData;
  int CommandId;
  const char *CommandDescription;
  int reserved;
} OFTPServerPITrailEventParams;


Unicode (Windows)
virtual INT FirePITrail(OFTPServerPITrailEventParams *e);

typedef struct {
  INT ConnectionId;
  INT Direction;
  LPCSTR Data;
  INT lenData;
  INT CommandId;
  LPCWSTR CommandDescription;
  INT reserved;
} OFTPServerPITrailEventParams;

#define EID_OFTPSERVER_PITRAIL 11

virtual INT IPWORKSEDI_CALL FirePITrail(INT &iConnectionId, INT &iDirection, LPSTR &lpData, INT &lenData, INT &iCommandId, LPSTR &lpszCommandDescription);

class OFTPServerPITrailEventParams {
public:
  int ConnectionId();

  int Direction();

  const QByteArray &Data();

  int CommandId();

  const QString &CommandDescription();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PITrail(OFTPServerPITrailEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FirePITrail(OFTPServerPITrailEventParams *e) {...}

Remarks

This event provides information about the protocol level communication between the client and server.

The Direction parameter specifies who sent the command.

The CommandId and CommandDescription parameters specify which command was sent. The table below shows possible values.

The Data parameter contains the raw OFTP packet.

ReadyToSend Event (OFTPServer Class)

Fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReadyToSend(OFTPServerReadyToSendEventParams *e);

typedef struct {
  int ConnectionId;
  int reserved;
} OFTPServerReadyToSendEventParams;


Unicode (Windows)
virtual INT FireReadyToSend(OFTPServerReadyToSendEventParams *e);

typedef struct {
  INT ConnectionId;
  INT reserved;
} OFTPServerReadyToSendEventParams;

#define EID_OFTPSERVER_READYTOSEND 12

virtual INT IPWORKSEDI_CALL FireReadyToSend(INT &iConnectionId);

class OFTPServerReadyToSendEventParams {
public:
  int ConnectionId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReadyToSend(OFTPServerReadyToSendEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireReadyToSend(OFTPServerReadyToSendEventParams *e) {...}

Remarks

The ReadyToSend event indicates that the connected client is in a state where it can accept files sent from the server. When a client connects initially it will not be ready to receive files. After the client sends files (if any) to the server it will pass control to the server. At that time the ReadyToSend event will fire. In addition the OFTPConnectionReadyToSend property will be set to true for the connection.

After this event fires SendFile can be called to send files to the connected client.

SSLClientAuthentication Event (OFTPServer Class)

This event is fired when the client presents its credentials to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLClientAuthentication(OFTPServerSSLClientAuthenticationEventParams *e);

typedef struct {
  int ConnectionId;
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} OFTPServerSSLClientAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLClientAuthentication(OFTPServerSSLClientAuthenticationEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} OFTPServerSSLClientAuthenticationEventParams;

#define EID_OFTPSERVER_SSLCLIENTAUTHENTICATION 13

virtual INT IPWORKSEDI_CALL FireSSLClientAuthentication(INT &iConnectionId, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class OFTPServerSSLClientAuthenticationEventParams {
public:
  int ConnectionId();

  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLClientAuthentication(OFTPServerSSLClientAuthenticationEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireSSLClientAuthentication(OFTPServerSSLClientAuthenticationEventParams *e) {...}

Remarks

This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

SSLConnectionRequest Event (OFTPServer Class)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLConnectionRequest(OFTPServerSSLConnectionRequestEventParams *e);

typedef struct {
  int ConnectionId;
  const char *SupportedCipherSuites;
  const char *SupportedSignatureAlgs;
  int CertStoreType;
  char *CertStore;
  char *CertPassword;
  char *CertSubject;
  int reserved;
} OFTPServerSSLConnectionRequestEventParams;


Unicode (Windows)
virtual INT FireSSLConnectionRequest(OFTPServerSSLConnectionRequestEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR SupportedCipherSuites;
  LPCWSTR SupportedSignatureAlgs;
  INT CertStoreType;
  LPWSTR CertStore;
  LPWSTR CertPassword;
  LPWSTR CertSubject;
  INT reserved;
} OFTPServerSSLConnectionRequestEventParams;

#define EID_OFTPSERVER_SSLCONNECTIONREQUEST 14

virtual INT IPWORKSEDI_CALL FireSSLConnectionRequest(INT &iConnectionId, LPSTR &lpszSupportedCipherSuites, LPSTR &lpszSupportedSignatureAlgs, INT &iCertStoreType, LPSTR &lpszCertStore, LPSTR &lpszCertPassword, LPSTR &lpszCertSubject);

class OFTPServerSSLConnectionRequestEventParams {
public:
  int ConnectionId();

  const QString &SupportedCipherSuites();

  const QString &SupportedSignatureAlgs();

  int CertStoreType();
  void SetCertStoreType(int iCertStoreType);

  const QString &CertStore();
  void SetCertStore(const QString &qsCertStore);

  const QString &CertPassword();
  void SetCertPassword(const QString &qsCertPassword);

  const QString &CertSubject();
  void SetCertSubject(const QString &qsCertSubject);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLConnectionRequest(OFTPServerSSLConnectionRequestEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireSSLConnectionRequest(OFTPServerSSLConnectionRequestEventParams *e) {...}

Remarks

This event fires when an SSL connection is requested and SSLProvider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to Platform.

This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

ConnectionId is the connection Id of the client requesting the connection.

SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.

SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.

CertStoreType is the store type of the alternate certificate to use for this connection. The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

CertStore is the store name or location of the alternate certificate to use for this connection.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

SSLStatus Event (OFTPServer Class)

This event is fired to show the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(OFTPServerSSLStatusEventParams *e);

typedef struct {
  int ConnectionId;
  const char *Message;
  int reserved;
} OFTPServerSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(OFTPServerSSLStatusEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR Message;
  INT reserved;
} OFTPServerSSLStatusEventParams;

#define EID_OFTPSERVER_SSLSTATUS 15

virtual INT IPWORKSEDI_CALL FireSSLStatus(INT &iConnectionId, LPSTR &lpszMessage);

class OFTPServerSSLStatusEventParams {
public:
  int ConnectionId();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(OFTPServerSSLStatusEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireSSLStatus(OFTPServerSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

StartTransfer Event (OFTPServer Class)

Fired when a document starts transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(OFTPServerStartTransferEventParams *e);

typedef struct {
  int ConnectionId;
  int Direction;
  char *LocalFile;
  const char *VirtualFileName;
  const char *VirtualFileDate;
  const char *Destination;
  const char *Originator;
  int reserved;
} OFTPServerStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(OFTPServerStartTransferEventParams *e);

typedef struct {
  INT ConnectionId;
  INT Direction;
  LPWSTR LocalFile;
  LPCWSTR VirtualFileName;
  LPCWSTR VirtualFileDate;
  LPCWSTR Destination;
  LPCWSTR Originator;
  INT reserved;
} OFTPServerStartTransferEventParams;

#define EID_OFTPSERVER_STARTTRANSFER 16

virtual INT IPWORKSEDI_CALL FireStartTransfer(INT &iConnectionId, INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszVirtualFileName, LPSTR &lpszVirtualFileDate, LPSTR &lpszDestination, LPSTR &lpszOriginator);

class OFTPServerStartTransferEventParams {
public:
  int ConnectionId();

  int Direction();

  const QString &LocalFile();
  void SetLocalFile(const QString &qsLocalFile);

  const QString &VirtualFileName();

  const QString &VirtualFileDate();

  const QString &Destination();

  const QString &Originator();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(OFTPServerStartTransferEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireStartTransfer(OFTPServerStartTransferEventParams *e) {...}

Remarks

This event fires when a file transfer begins.

Direction specifies if the client or server sent the file.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.

ConnectionId identifies the connected client.

Transfer Event (OFTPServer Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(OFTPServerTransferEventParams *e);

typedef struct {
  int ConnectionId;
  int Direction;
  const char *LocalFile;
  const char *VirtualFileName;
  const char *VirtualFileDate;
  const char *Destination;
  const char *Originator;
  int64 BytesTransferred;
  const char *Text;
  int lenText;
  int reserved;
} OFTPServerTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(OFTPServerTransferEventParams *e);

typedef struct {
  INT ConnectionId;
  INT Direction;
  LPCWSTR LocalFile;
  LPCWSTR VirtualFileName;
  LPCWSTR VirtualFileDate;
  LPCWSTR Destination;
  LPCWSTR Originator;
  LONG64 BytesTransferred;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} OFTPServerTransferEventParams;

#define EID_OFTPSERVER_TRANSFER 17

virtual INT IPWORKSEDI_CALL FireTransfer(INT &iConnectionId, INT &iDirection, LPSTR &lpszLocalFile, LPSTR &lpszVirtualFileName, LPSTR &lpszVirtualFileDate, LPSTR &lpszDestination, LPSTR &lpszOriginator, LONG64 &lBytesTransferred, LPSTR &lpText, INT &lenText);

class OFTPServerTransferEventParams {
public:
  int ConnectionId();

  int Direction();

  const QString &LocalFile();

  const QString &VirtualFileName();

  const QString &VirtualFileDate();

  const QString &Destination();

  const QString &Originator();

  qint64 BytesTransferred();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(OFTPServerTransferEventParams *e);

// Or, subclass OFTPServer and override this emitter function.
virtual int FireTransfer(OFTPServerTransferEventParams *e) {...}

Remarks

The Text parameter contains the portion of the document text being retrieved. It is empty if data is being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.

ConnectionId identifies the connected client.

Config Settings (OFTPServer Class)

OFTPServer Config Settings