• Start Visual Basic 6.0
• Create a new project or open an existing one.
• Select Components… from the Project menu.
• Entries named "BigSpeed File Client" and "BigSpeed File Server" should appear in the components list.
• In the Components dialog, make sure the "BigSpeed File Client" and "BigSpeed File Server" items are checked in the components list. This will make them available for use in your applications.
• Click the OK button. The BigSpeed File Sharing Client/Server icon should now appear in the components toolbox.

• Start Delphi
• Open an existing project or create a new project
• From the Component menu, select the Import ActiveX control item
• Select the "BigSpeed File Client" or "BigSpeed File Server" item from the list of installed ActiveX controls
• Click on the Install button that's on the Import ActiveX dialog
• The Install dialog will appear. Click on the "Into new package" tab.
• Enter a filename and path for the new package in the "File Name" field.
• Click OK in the Install dialog
• Delphi will then ask you to confirm the rebuild – click Yes in the Confirm dialog.
• If everything was successful, you should get a message that the package has been updated and that the new components have been registered.
• Close the package dialog
• Click Yes when you are prompted to confirm the changes
The component should appear in your component toolbar (ActiveX tab).

• Start Visual Basic .NET
• Create a new project or open an existing one.
• Select Toolbox view, Components tab.
• Right-click the tab and choose "Add/Remove Items..."
• In the Customize Toolbox dialog, click the tab named "COM Components" .
• Entries named "BigSpeed File Client" and "BigSpeed File Server" should appear in the components list.
• In the Components dialog, make sure the "BigSpeed File Client" and "BigSpeed File Server" are checked in the components list. This will make them available for use in your applications.
• Click the OK button. The BigSpeed File Sharing Client/Server icons should now appear in the components toolbox.

• Start Visual C++ .NET
• Create a new project or open an existing one.
• Click the ResourceView tab to choose the resource edit.
• Double-click the dialog's name to edit the dialog.
• Right-click the dialog and choose Insert ActiveX Control from the pop-up menu.
• Choose "BigSpeed File Client" or "BigSpeed File Server" from the ActiveX control list and click OK.

Integer    (Read-only)

None

LastError property returns the error code for the last method invocation. Zero indicates no error (success).

Integer

Zero

SecurityMode property specifies what security mode to be used for the next connectuon sessions.
There are three possible values:

0 - Plain mode. No encryption is used.

1 - Symmetric encryption. The SecretKey property will be used by the component to calculate a unique session key for each connection. The incomming connections will be limited only to the peers which have assigned the same SecretKey.

2 - Asymmetric encryption. The PublicKey/PrivateKey properties will be used by the component to calculate a unique session key for each connection. The incomming connections can be limited only to a predefined list of peers by assigning the correct digital fingerprints to the property Fingerprints.

String

Empty

SecretKey property holds the cryptographic key used to calculate the session key when a symmetric encyption is used. Only peers with the same secret key will be able to communicate to each other.

String

Empty

PublicKey property holds the public key used to calculate the session key in the asymmetric encryption mode. It should be previously generated by the method GenerateKeypair.

String

Empty

PrivateKey property holds the private key used to calculate the session key in the asymmetric encryption mode. It should be previously generated by the method GenerateKeypair.

String

Empty

Fingerprints property optionally can be used to restrict the incomming connection only to certain peers. The expected format is a comma-delimited list of digital fingerprints, as calculated by the method TakeFingerprint.

String

Empty

If the local machine has multiple network interfaces, this property can specify which one to be used. If the value is empty, the default IP address will be used.

Boolean (Read-only)

False

This property indicates if the agent is in a connecting state. There are three possible states: closed (the default), connecting, and connected. The component stays in a connecting state after the method OpenSession is called until either of the events OnSessionOpen or OnSessionRejected is fired.

Boolean (Read-only)

False

This property indicates if the agent is in a connected state. There are three possible states: closed (the default), connecting, and connected. The component stays in a connected state after the event OnSessionOpen is fired until the event OnSessionClosed is fired.

String

Empty

Username property specifies the sign-in ID of the user. If it's empty, a default (Guest) user will be used from the peers when they determine the access rights for local agent.

Boolean

True

If set to True, the method "Download" will check automatically for available partially downloaded file from previous operation. If it's found, the existing part will be verified by calculating MD5 control sum, and duplicated transfer will be avoided.

Boolean

Empty

If set to True, the method "Upload" will check automatically for available partially downloaded file from previous operation. If it's found, the existing part will be verified by calculating MD5 control sum, and duplicated transfer will be avoided.

String

Empty

This property holds the IP address of the hub, when the session is open.

Integer

0

This property holds the port of the hub, when the session is open.

Integer

4

This property specifies the version of the SOCKS protocol to be used. Valid values are "4" and "5".

String

Empty

SocksServer property sets the address of the proxy server. It accepts dotted decimal format or domain name.

Long

0

SocksPort property indicates the port of the proxy server.

String

Empty

SocksUsername property specifies the user name to be used for proxy server authentication.

String

Empty

SocksPassword property specifies the password to be used for proxy server authentication.

String

"_bsfilelib_transfer"

TransferSuffix property holds the string constant to be appended to the name of the transferred upload files during the operation is in progress.

GenerateKeypair( ByRef aPublicKey As String, ByRef aPrivateKey As String ) As Boolean

This method generates a new random key pair of public and private keys. They can be used for the properties PublicKey and PrivateKey.

aPublicKey	The Base64 encoded value of the generated public key is returned here
aPublicKey	The Base64 encoded value of the generated private key is returned here

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Ok = GenerateKeypair( PubKey, PvtKey )

TakeFingerprint( aPublicKey As String ) As String

This method calculates a digital fingerprint (MD5 checksum) of a public key.

aPublicKey

Base64 encode value of the public key.

The return value is the Base64 encoded MD5 checksum. It can be used in the property Fingerprints on the remote peers.

FP = TakeFingerprint( PubKey )

GetMoniker( ByVal aHandle As Long ) As Long

GetMoniker method provides the moniker ID associated with the peer object. It should be previously set with SetMoniker method.

aHandle

Handle of the desired peer object.

Integer value representing the moniker ID.

SetMoniker( ByVal aHandle As Long ,ByVal aMoniker As Long )

SetMoniker method assigns a moniker ID (4 byte integer) to a peer object. This could be helpful for easy reference to some application data associated with the client.

aHandle	Handle of the desired peer object.
aMoniker	The moniker ID value

None.

OpenSession( ByVal aAddr As String , ByVal aPort As Long , ByVal aUsername As String , ByVal aPassword As String ) As Boolean

OpenSession method issues a request to establish a connection to the hub. The agent moves from closed to the connecting state. The application will be notified later on for the result of the operation. If the agent is connected successfully the event OnSessionOpen will be fired, otherwise the event OnSessionRejected will be fired.

aPort	The address of the hub. It can be in dotted decimal format or domain name.
aPort	The listening port number of the hub.
aUsername	The username for logging in to the hub. If it's empty, the default (Guest) account will be used
aPassword	The password needed for the login operation. Should be empty for Guest login.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Ok = P2pAgent.OpenSession(edHost.Text, Val(edHubPort.Text), edUsername.Text, edPassword.Text)

CloseSession As Boolean

CloseSession method issues a reguest to the agent to break the connection with the hub. The event OnSessionClosed will notify the application about the result of the operation.

None

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

GetSessionStatus() As Long

GetSessionStatus method provides information about the current status of the connection to the server.

None

An integer code with the following meaning:

0	Disconnected
1	Connecting
2	Connected

DisconnectPeer( ByVal aHandle As Long ) As Boolean

DisconnectPeer method disconnects and destroys a peer object.

aHandle

Handle of the desired peer object.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

GetPeerName( ByVal aHandle As Long ) As String

GetPeerName method provides the user name associated with a peer object.

aHandle

Handle of the desired peer object.

Name of the logged in user.

GetIncomingBandwidth( ) As Long

GetIncomingBandwidth method gives the maiximum bandwidth for incoming traffic.

The maximum bandwidth in bytes per second. Zero means unlimited.

SetIncomingBandwidth( ByVal aValue As Long )

SetIncomingBandwidth method sets the maiximum bandwidth for incoming traffic.

aValue

The desired maximum bandwidth in bytes per second.

N/A

GetOutgoingBandwidth( ) As Long

GetOutgoingBandwidth method gives the maiximum bandwidth for Outgoing traffic.

The maximum bandwidth in bytes per second. Zero means unlimited.

SetOutgoingBandwidth( ByVal aValue As Long )

SetOutgoingBandwidth method sets the maiximum bandwidth for outgoing traffic.

aValue

The desired maximum bandwidth in bytes per second.

N/A

SendAlertMessage( ByVal aHandle As Long , ByVal aMessage As String ) As Boolean

SendAlertMessage method sends an alert message to a connected peer.

aHandle	Handle of the desired peer object.
aMessage	Text of the message to be sent

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

SendChatMessage( ByVal aHandle As Long , ByVal aMessage As String ) As Boolean

SendChatMessage method sends a chat message to a connected peer.

aHandle	Handle of the desired peer object.
aMessage	Text of the message to be sent

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

SendBinaryMessage( ByVal aHandle As Long , ByRef aMessage As Variant ) As Boolean

SendBinaryMessage method sends a binary message (byte array) to a peer or the hub.

aHandle	Handle of the desired peer object. If it's zero, the message is sent to the hub.
aMessage	Variant array of bytes holding the message data

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

ListFiles( ByVal aHandle As Long , ByVal aFolder As String ) As Boolean

ListFiles method sends a request for a folder content. The response will be delivered via the events OnHaveFileItem and OnListFolderDone.

aHandle	Handle of the desired peer object.
aFolder	Path to the remote folder which content is requested

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

CreateFolder( ByVal aHandle As Long , ByVal aFolder As String ) As Boolean

CreateFolder method sends a request for folder creation. The response will be delivered with the event OnCreateFolderDone.

aHandle	Handle of the desired peer object.
aFolder	Path to the remote folder which content is requested

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

DeleteFolder( ByVal aHandle As Long , ByVal aFolder As String ) As Boolean

DeleteFolder method sends a request for folder deletion. The response will be delivered with the event OnDeleteFolderDone.

aHandle	Handle of the desired peer object.
aFolder	Path to the remote folder

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

DeleteFile( ByVal aHandle As Long , ByVal aFile As String ) As Boolean

DeleteFile method sends a request for file deletion. The response will be delivered with the event OnDeleteFileDone.

aHandle	Handle of the desired peer object.
aFile	Path to the remote File

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

RenameFolder( ByVal aHandle As Long , ByVal aFolder As String ) As Boolean

RenameFolder method sends a request for folder renaming. The response will be delivered with the event OnRenameFolderDone.

aHandle	Handle of the desired peer object.
aFolder	Path to the remote folder

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

RenameFile( ByVal aHandle As Long , ByVal aFile As String ) As Boolean

RenameFile method sends a request for file renaming. The response will be delivered with the event OnRenameFileDone.

aHandle	Handle of the desired peer object.
aFile	Path to the remote file

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Download( ByVal aHandle As Long ,ByVal aFile As String ,ByVal aFolder As String ) As Boolean

Download method starts a download operation. The event OnDownloadProgress will provide progress information. The event OnClientDownloadDone will report the completion status.

aHandle	Handle of the desired peer object.
aFile	Pathname of an existing file on the peer.
aFolder	Pathname of a folder on the local system, where the downloaded file will be placed.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

CancelClientDownload( ByVal aHandle As Long ) As Boolean

CancelClientDownload method aborts the currently running download operation (client module).

aHandle

Handle of the desired peer object.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Upload( ByVal aHandle As Long ,ByVal aFile As String ,ByVal aFolder As String ) As Boolean

Upload method starts an upload operation. The event OnUploadProgress will provide progress information. The event OnClientUploadDone will report the completion status.

aHandle	Handle of the desired peer object.
aFile	Pathname of an existing file on local system.
aFolder	Pathname of a folder on the remote system, where the uploaded file will be placed.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

CancelClientUpload( ByVal aHandle As Long ) As Boolean

CancelClientUpload method aborts the currently running upload operation (client module).

aHandle

Handle of the desired peer object.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Search( ByVal aHandle As Long ,ByVal aFolder As String ,ByVal aFiles As String ,ByVal aText As String ) As Boolean

Search method starts a search operation. The event OnHaveFindFile will report the found items. The event OnSearchProgress will provide progress information. The event OnClientSearchDone will notify about the completion status.

aHandle	Handle of the desired peer object.
aFolder	Pathname of start folder on the server.
aFiles	A file name mask (wildcards *.*) to be applied
aText	A word or phrase contained in the file

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

StopSearch( ByVal aHandle As Long ) As Boolean

StopSearch method aborts the currently running search operation (client module)

aHandle

Handle of the desired peer object.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Zip( ByVal aHandle As Long ,ByVal aArchive As String ,ByVal aFiles As String ) As Boolean

Zip method starts a compression operation. The event OnZipProgress will provide progress information. The event onZipDone will report the completion status.

aHandle	Handle of the desired peer object.
aArchive	Pathname of an existing zip file on the server.
aFiles	Pathname and file name mask (wildcard) of the files to be archived.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Zip(Peer, "DestDir\archive.zip", "SrcDir\*.txt")

CancelZip( ByVal aHandle As Long ) As Boolean

CancelZip method aborts the currently running zip operation (client module).

aHandle

Handle of the desired peer object.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Unzip( ByVal aHandle As Long ,ByVal aArchive As String ,ByVal aFolder As String ) As Boolean

Unzip method starts a decompression operation. The event OnUnzipProgress will provide progress information. The event OnClientUnzipDone will report the completion status.

aHandle	Handle of the desired peer object.
aArchive	Pathname of an existing zip file on the server.
aFolder	Pathname of an existing folder on the server, where the content of the zip archive will be extracted.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

CancelUnzip( ByVal aHandle As Long ) As Boolean

CancelUnzip method aborts the currently running unzip operation (client module).

aHandle

Handle of the desired peer object.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

OnSessionOpen

OnSessionOpen event is generated when the agent has just been connected to the hub after a call to "OpenSession()". At this moment the agent is ready to accept connections from other peers. The component moves from connecting to connected state.

None

OnSessionClosed()

This event is generated when the connection to the hub has just been broken. All currently connected peers are automatically disconnected. The agent moves from connected to the closed state.

None

OnSessionRejected

OnSessionRejected event is generated when a connection attempt to the hub (call to OpenSession() method) has been failed. The agent moves from connecting to the closed state. The LastError property holds the error code.

None

OnPeerConnected(ByVal aHandle As Long)

OnPeerConnected event is generated when a new peer object has just been created. It is fired when the peer information is received from the server.

aHandle

The handle of the newly created peer. It should be stored for future references.

OnPeerDisconnected(ByVal aHandle As Long)

OnPeerDisconnected event is generated when a connected peer has just been disconnected from the agent.

aHandle

The handle of the peer firing the event

OnAlertMessage( ByVal aHandle As Long ,ByVal aMessage As String )

OnAlertMessage event delivers an alert message from a peer.

aHandle	The handle of the peer firing the event
aMessage	The text of the message

OnChatMessage( ByVal aHandle As Long ,ByVal aMessage As String )

OnChatMessage event delivers a chat message from a peer.

aHandle	The handle of the peer firing the event
aMessage	The text of the message

OnBinaryMessage( ByVal aHandle As Long ,ByRef aMessage As Variant)

OnBinaryMessage event delivers binary message received from a peer or the hub.

aHandle	The handle of the peer firing the event. If it's zero, sender is the hub
aMessage	Byte array holding the message data

OnNeedListFolder( ByVal aHandle As Long ,ByVal aPath As String ,ByRef aOkay As Boolean ,ByRef aRoot As String )

OnNeedListFolder event notifies about a peer's request and asks for permission to start a list operation. The application should check the user's access rights here and needs to take a decision whether to permit the operation or not.

aHandle	Handle of the peer object firing the event.
aPath	Relative pathname of the starting folder.
aOkay	If the operation may be performed, the aplication must set this variable to TRUE
aRoot	If there is a permission for the operation, the application must write here the root folder assigned to the signed-in user.

OnListFolderDone( ByVal aHandle As Long ,ByVal aCode As Long )

OnListFolderDone event reports the completion status of the operation previously signaled by the event OnNeedListFolder.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnHaveFileItem( ByVal aHandle As Long ,ByVal aName As String ,ByVal aSizeLo As Long ,ByVal aSizeHi As Long ,ByVal aTimeLo As Long ,ByVal aTimeHi As Long )

OnHaveFileItem event reports an idividual file or folder produced by a list operation started with the method ListFiles.

aHandle	Handle of the peer object firing the event.
aName	Pathname of the file/folder.
aFolder	Indicates if the item is a file or folder.
aSizeLo	The low 32 bits of the file size.
aSizeHi	The high 32 bits of the file size.
aTimeLo	The low 32 bits of the file time.
aTimeHi	The high 32 bits of the file time.

OnNeedCreateFolder( ByVal aHandle As Long ,ByVal aPath As String ,ByRef aOkay As Boolean ,ByRef aRoot As String )

OnNeedCreateFolder event notifies about a peer's request and asks for permission to create a new folder. The application should check the user's access rights here and needs to take a decision whether to permit the operation or not.

aHandle	Handle of the peer object firing the event.
aPath	Relative pathname of the requested folder.
aOkay	If the operation may be performed, the aplication must set this variable to TRUE
aRoot	If there is a permission for the operation, the application must write here the root folder assigned to the signed-in user.

OnCreateFolderDone( ByVal aHandle As Long ,ByVal aCode As Long)

OnCreateFolderDone event reports the result of the operation previously started with the method CreateFolder.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnNeedRenameFolder( ByVal aHandle As Long ,ByVal aPath As String ,ByRef aOkay As Boolean ,ByRef aRoot As String )

OnNeedRenameFolder event notifies about a peer's request and asks for permission to rename a folder. The application should check the user's access rights here and needs to take a decision whether to permit the operation or not.

aHandle	Handle of the peer object firing the event.
aPath	Relative pathname of the requested folder.
aOkay	If the operation may be performed, the aplication must set this variable to TRUE
aRoot	If there is a permission for the operation, the application must write here the root folder assigned to the signed-in user.

OnRenameFolderDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnRenameFolderDone event reports the result of the operation previously started with the method RenameFolder.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnNeedRenameFile( ByVal aHandle As Long ,ByVal aPath As String ,ByRef aOkay As Boolean ,ByRef aRoot As String )

OnNeedRenameFile event notifies about a peer's request and asks for permission to rename a file. The application should check the user's access rights here and needs to take a decision whether to permit the operation or not.

aHandle	Handle of the peer object firing the event.
aPath	Relative pathname of the requested file.
aOkay	If the operation may be performed, the aplication must set this variable to TRUE
aRoot	If there is a permission for the operation, the application must write here the root folder assigned to the signed-in user.

OnRenameFileDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnRenameFileDone event reports the result of the operation previously started with the method RenameFile.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnNeedDeleteFolder( ByVal aHandle As Long ,ByVal aPath As String ,ByRef aOkay As Boolean ,ByRef aRoot As String )

OnNeedDeleteFolder event notifies about a peer's request and asks for permission to delete a folder. The application should check the user's access rights here and needs to take a decision whether to permit the operation or not.

aHandle	Handle of the peer object firing the event.
aPath	Relative pathname of the requested folder.
aOkay	If the operation may be performed, the aplication must set this variable to TRUE
aRoot	If there is a permission for the operation, the application must write here the root folder assigned to the signed-in user.

OnDeleteFolderDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnDeleteFolderDone event reports the result of the operation previosly started with the method DeleteFolder.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnNeedDeleteFile( ByVal aHandle As Long ,ByVal aPath As String ,ByRef aOkay As Boolean ,ByRef aRoot As String )

OnNeedDeleteFile event notifies about a peer's request and asks for permission to delete a file. The application should check the user's access rights here and needs to take a decision whether to permit the operation or not.

aHandle	Handle of the peer object firing the event.
aPath	Relative pathname of the requested file.
aOkay	If the operation may be performed, the aplication must set this variable to TRUE
aRoot	If there is a permission for the operation, the application must write here the root folder assigned to the signed-in user.

OnDeleteFileDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnDeleteFileDone event reports the result of the operation previously started with the method DeleteFile.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnNeedDownload( ByVal aHandle As Long ,ByVal aPath As String ,ByRef aOkay As Boolean ,ByRef aRoot As String )

OnNeedDownload event notifies about a peer's request and asks for permission to start a download operation. The application should check the user's access rights here and needs to take a decision whether to permit the operation or not.

aHandle	Handle of the peer object firing the event.
aPath	Relative pathname of the downloaded file.
aOkay	If the operation may be performed, the aplication must set this variable to TRUE
aRoot	If there is a permission for the operation, the application must write here the root folder assigned to the signed-in user.

OnServerDownloadDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnServerDownloadDone event reports the result of the download operation (in server module) previously signaled with the event OnNeedDownload.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnDownloadProgress( ByVal aCountLo As Long ,ByVal aCountHi As Long ,ByVal aSizeLo As Long ,ByVal aSizeHi As Long )

OnDownloadProgress provides progress information (in client module) during download operation previously started with the method Download.

aCountLo	The low 32 bits of the current byte count.
aCountHi	The high 32 bits of the current byte count.
aSizeLo	The low 32 bits of the total byte size.
aSizeHi	The high 32 bits of the total byte size.

OnClientDownloadDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnClientDownloadDone event reports the result of the download operation (in client module) previously started with the method Download.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnNeedUpload( ByVal aHandle As Long ,ByVal aPath As String ,ByRef aOkay As Boolean ,ByRef aRoot As String )

OnNeedUpload event notifies about a peer's request and asks for permission to start a Upload operation. The application should check the user's access rights here and needs to take a decision whether to permit the operation or not.

aHandle	Handle of the peer object firing the event.
aPath	Relative pathname of the Uploaded file.
aOkay	If the operation may be performed, the aplication must set this variable to TRUE
aRoot	If there is a permission for the operation, the application must write here the root folder assigned to the signed-in user.

OnServerUploadDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnServerUploadDone event reports the result of the Upload operation (in server module) previously signaled with the event OnNeedUpload.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnUploadProgress( ByVal aCountLo As Long ,ByVal aCountHi As Long ,ByVal aSizeLo As Long ,ByVal aSizeHi As Long )

OnUploadProgress provides progress information (in client module) during Upload operation previously started with the method Upload.

aCountLo	The low 32 bits of the current byte count.
aCountHi	The high 32 bits of the current byte count.
aSizeLo	The low 32 bits of the total byte size.
aSizeHi	The high 32 bits of the total byte size.

OnClientUploadDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnClientUploadDone event reports the result of the Upload operation (in client module) previously started with the method Upload.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnNeedZip( ByVal aHandle As Long ,ByVal aPath As String ,ByRef aOkay As Boolean ,ByRef aRoot As String )

OnNeedZip event notifies about a peer's request and asks for permission to start a compression operation. The application should check the user's access rights here and needs to take a decision whether to permit the operation or not.

aHandle	Handle of the peer object firing the event.
aPath	Relative pathname of the zip archive.
aOkay	If the operation may be performed, the aplication must set this variable to TRUE
aRoot	If there is a permission for the operation, the application must write here the root folder assigned to the signed-in user.

OnZipDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnZipDone event reports the result of the operation previously started with the method Zip.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnServerZipDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnServerZipDone event reports the result of the zip operation (in server module) previously signaled with the event OnNeedZip.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnZipProgress( ByVal aHandle As Long ,ByVal aFileCount As Long ,ByVal aFileTotal As Long ,ByVal aByteCountLo As Long ,ByVal aByteCountHi As Long ,ByVal aByteTotalLo As Long ,ByVal aByteTotalHi As Long )

OnZipProgress provides progress information during compression operation previously started with the method Zip.

aHandle	Handle of the peer object firing the event.
aFileCount	Number of the files processed so far.
aFileTotal	Total number of the requested files.
aByteCountLo	The low 32 bits of the amount of bytes processed so far.
aByteCountHi	The high 32 bits of the amount of bytes processed so far.
aByteTotalLo	The low 32 bits of the total requested amount of bytes.
aByteTotalHi	The high 32 bits of the total requested amount of bytes.

OnClientZipDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnClientZipDone event reports the result of the zip operation (in client module) previously started with the method Zip.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnNeedUnzip( ByVal aHandle As Long ,ByVal aPath As String ,ByRef aOkay As Boolean ,ByRef aRoot As String )

OnNeedUnzip event notifies about a peer's request and asks for permission to start a decompression information. The application should check the user's access rights here and needs to take a decision whether to permit the operation or not.

aHandle	Handle of the peer object firing the event.
aPath	Relative pathname of the zip archive.
aOkay	If the operation may be performed, the aplication must set this variable to TRUE
aRoot	If there is a permission for the operation, the application must write here the root folder assigned to the signed-in user.

OnServerUnzipDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnServerUnzipDone event reports the result of the unzip operation (in the server module) previously signaled with the event OnNeedUnzip

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnUnzipProgress( ByVal aHandle As Long ,ByVal aFileCount As Long ,ByVal aFileTotal As Long ,ByVal aByteCountLo As Long ,ByVal aByteCountHi As Long ,ByVal aByteTotalLo As Long ,ByVal aByteTotalHi As Long )

OnUnzipProgress provides progress information (in the client module) during decompression operation previously started with the method Unzip.

aHandle	Handle of the peer object firing the event.
aFileCount	Number of the files processed so far.
aFileTotal	Total number of the requested files.
aByteCountLo	The low 32 bits of the amount of bytes processed so far.
aByteCountHi	The high 32 bits of the amount of bytes processed so far.
aByteTotalLo	The low 32 bits of the total requested amount of bytes.
aByteTotalHi	The high 32 bits of the total requested amount of bytes.

OnClientUnzipDone( ByVal aHandle As Long ,ByVal aCode As Long) )

OnClientUnzipDone event reports the result of the operation (in the client module) previously started with the method Unzip.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnNeedSearch( ByVal aHandle As Long ,ByVal aPath As String ,ByRef aOkay As Boolean ,ByRef aRoot As String )

OnNeedSearch event notifies about a peer's request and asks for permission to start a search operation. The application should check the user's access rights here and needs to take a decision whether to permit the operation or not.

aHandle	Handle of the peer object firing the event.
aPath	Relative pathname of the starting folder.
aOkay	If the operation may be performed, the aplication must set this variable to TRUE
aRoot	If there is a permission for the operation, the application must write here the root folder assigned to the signed-in user.

OnServerSearchDone( ByVal aHandle As Long ,ByVal aCode As Long )

OnServerSearchDone event reports the completion status of the search operation previously signaled by the event OnNeedSearch.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The error description is given in the LastError property specification.

OnSearchProgress( ByVal aHandle As Long ,ByVal aCount As Long )

OnSearchProgress provides progress information during search operation previously started with the method Search.

aHandle	Handle of the peer object firing the event.
aCode	Number of the files which are examined so far.

OnHaveFindFile( ByVal aHandle As Long ,ByVal aName As String ,ByVal aSizeLo As Long ,ByVal aSizeHi As Long ,ByVal aTimeLo As Long ,ByVal aTimeHi As Long )

OnHaveFindFile event reports an idividual file item found by the search operation started with the method Search.

aHandle	Handle of the peer object firing the event.
aName	Pathname of the file.
aSizeLo	The low 32 bits of the file size.
aSizeHi	The high 32 bits of the file size.
aTimeLo	The low 32 bits of the file time.
aTimeHi	The high 32 bits of the file time.

OnClientSearchDone( ByVal aHandle As Long ,ByVal aCode As Long )

OnClientSearchDone event reports the completion status of the search operation previously started with the method Search.

aHandle	Handle of the peer object firing the event.
aCode	If the value is 0, the operation is completed successfully. If the value is greater than 0, it indicates an error code. The text description is given in the LastError property specification.

String    (Read-only)

N/A

Returns a comma-delimited list of available IP addresses on the local machine.

Integer    (Read-only)

None

LastError property returns the error code for the last method invocation. Zero indicates no error (success).

0		No error
1		Unknown error
2		Invalid handle
3		Invalid data
4		There is no assigned event handler
5		Illegal operation
6		Event handler error
7		Bad encryption key
10		Connection is refused
11		Connection timeout
12		Broken connection
13		Not connected
14		Too many connections
20		Cannot start server
21		Cannot connect to SOCKS server
22		Wrong username or password
23		Access is denied
24		Client is not signed-in
30		User break
31		Operation is already running
32		Operation is not running
100		Cannot create folder
101		Cannot delete folder
102		Cannot delete file
103		Cannot rename folder
104		Cannot rename file
105		Cannot open file
106		Cannot create file
107		Cannot read from file
108		Cannot write to file
109		Cannot rename temporary file
110		Non-supported format
111		Error searching file
112		Wrong checksum

Integer

Zero

SecurityMode property specifies what security mode to be used for the next connectuon sessions.
There are three possible values:

0 - Plain mode. No encryption is used.

1 - Symmetric encryption. The SecretKey property will be used by the component to calculate a unique session key for each connection. The incomming connections will be limited only to the peers which have assigned the same SecretKey.

2 - Asymmetric encryption. The PublicKey/PrivateKey properties will be used by the component to calculate a unique session key for each connection. The incomming connections can be limited only to a predefined list of peers by assigning the correct digital fingerprints to the property Fingerprints.

String

Empty

SecretKey property holds the cryptographic key used to calculate the session key when a symmetric encyption is used. Only peers with the same secret key will be able to communicate to each other.

String

Empty

PublicKey property holds the public key used to calculate the session key in the asymmetric encryption mode. It should be previously generated by the method GenerateKeypair.

String

Empty

PrivateKey property holds the private key used to calculate the session key in the asymmetric encryption mode. It should be previously generated by the method GenerateKeypair.

String

Empty

Fingerprints property optionally can be used to restrict the incomming connection only to certain peers. The expected format is a comma-delimited list of digital fingerprints, as calculated by the method TakeFingerprint.

String

Empty

If the local machine has multiple network interfaces, this property can specify which one to be used. If the value is empty, the default IP address will be used.

Long

0

ListeningPort property holds the port number on which the hub is listening for incoming connections. If it's set to 0, the Hub will use a random value. If the PC is behind a firewall/NAT/router, you need to forward/open this port. The website www.portforward.com may help in that case.

String    (Read-only)

Empty

LocalIPList property holds a comma-delimited list of available IP addresses of the local machine.

Boolean (Read-only)

False

Running property indicates if the hub is currently listening for incoming connections.

Start( ) As Boolean

Start method instructs the hub to start listening for incoming connections.

None.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Stop( ) As Boolean

Stop method instructs the hub to stop listening for incoming connections. All currently connected clients will be disconnected as well.

None.

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

GetMoniker( ByVal aHandle As Long ) As Long

GetMoniker method provides the moniker ID associated with the client object. It should be previously set with SetMoniker method.

aHandle

Handle of the desired client object.

Integer value representing the moniker ID.

SetMoniker( ByVal aHandle As Long ,ByVal aMoniker As Long )

SetMoniker method assigns a moniker ID (4 byte integer) to a client object. This could be helpful for easy reference to some application data associated with the client.

aHandle	Handle of the desired client object.
aMoniker	The moniker ID value

None.

GenerateKeypair( ByRef aPublicKey As String, ByRef aPrivateKey As String ) As Boolean

This method generates a new random key pair of public and private keys. They can be used for the properties PublicKey and PrivateKey.

aPublicKey	The Base64 encoded value of the generated public key is returned here
aPublicKey	The Base64 encoded value of the generated private key is returned here

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

Ok = GenerateKeypair( PubKey, PvtKey )

TakeFingerprint( aPublicKey As String ) As String

This method calculates a digital fingerprint (MD5 checksum) of a public key.

aPublicKey

Base64 encode value of the public key.

The return value is the Base64 encoded MD5 checksum. It can be used in the property Fingerprints on the remote peers.

FP = TakeFingerprint( PubKey )

DisconnectPeer( ByVal aHandle As Long )

DisconnectPeer method disconnects and destroys a peer object.

aHandle

Handle of the desired peer object.

None.

GetPeerAddress( ByVal aHandle As Long ) As String

GetPeerAddress gives the peer IP address.

aHandle

Handle of the desired peer object.

Peer address in IP dotted format.

GetPeerPort( ByVal aHandle As Long ) As String

GetPeerPort method gives the peer's port number.

aHandle

Handle of the desired peer object.

Peer's port number.

GetPeerName( ByVal aHandle As Long ) As String

GetPeerName method provides the user name associated with a peer object.

aHandle

Handle of the desired peer object.

Name of the signed-in user.

SendBinaryMessage( ByVal aHandle As Long , ByRef aMessage As Variant ) As Boolean

SendBinaryMessage method sends a binary message (byte array) to a peer.

aHandle	Handle of the desired peer object.
aMessage	Variant array of bytes holding the message data

If the return value is TRUE the method invocation is successful. Otherwise the property LastError can be used to retrieve the error code.

OnConnectionRequest( ByVal aHandle As Long ,ByVal aUsername As String ,ByRef aPassword As String ,ByRef aAccept As Boolean )

OnConnectionRequest event notifies about a login request from a peer. The application should check the user profile and return the value of the password.

aHandle	Handle of the peer object firing the event.
aUsername	Name of the desired user.
aPassword	This is an out parameter. If the username is found in user profile, the application must pass here the password value set for the asked username previously by the administrator.
aAccept	If the aplication wants to grant an access to the peer, this value must be set to True

OnPeerConnected( ByVal aHandle As Long )

OnPeerConnected event is generated when a new peer has just been connected to the hub. The application should store the handle to the newly created peer object for later use.

aHandle

Handle of the peer object firing the event.

OnPeerDisconnected( ByVal aHandle As Long ,ByVal aCode As Long )

OnPeerDisconnected event is generated when a connected peer has just been disconnected from the Server. The handle of the peer is no more valid for future references.

aHandle	The handle of the peer firing the event
aCode	Indicates the error code.

OnPeerRejected( ByVal aUsername As String ,ByVal aAddress As String ,ByVal aPort As Long ,ByVal aCode As Long )

OnPeerRejected event is generated when a peer connection has just been refused.

aUsername	The username of the peer.
aAddress	The IP address of the peer.
aPort	The peer port.
aCode	Indicates the error code.

OnBinaryMessage( ByVal aHandle As Long ,ByRef aMessage As Variant)

OnBinaryMessage event delivers binary message received from a peer.

aHandle	Handle of the peer firing the event
aMessage	Byte array holding the message data

0		No error
1		User break
2		Unknown error
3		Invalid handle
4		Invalid data
5		There is no assigned event handler
6		Illegal operation
7		Event handler error
8		Bad encryption key
10		Connection is refused
11		Connection timeout
12		Broken connection
13		Not connected
14		Too many connections
20		Cannot start server
21		Cannot connect to SOCKS server
22		Wrong username or password
23		Access is denied
24		Client is not signed-in
30		Operation is already running
31		Operation is not running
100		Cannot create folder
101		Cannot delete folder
102		Cannot delete file
103		Cannot rename folder
104		Cannot rename file
105		Cannot open file
106		Cannot create file
107		Cannot read from file
108		Cannot write to file
109		Cannot rename temporary file
110		Non-supported format
111		Error searching file
112		Wrong checksum

Description

If the error code is negative, the cause is on the remote side.

• Windows 9x, Me, NT4 or Windows 2000, XP or higher version
• Pentium Processor recommended
• 16 MB RAM; 32 MB RAM under NT4 or Windows 2000 platforms, 128 MB for XP
• Any programming language supporting ActiveX controls