DbmlsyncClient class

Communicates using TCP/IP with a separate process, dbmlsync server, which performs a synchronization by connecting to the MobiLink server and the remote database.

Syntax

public class DbmlsyncClient

Members

All members of DbmlsyncClient class, including all inherited members.

Name	Description
CancelSync method	Cancels a synchronization request.
Connect method	Opens a connection to a dbmlsync server that is already running on this computer.
Disconnect method	Breaks the dbmlsync server connection that was established with the Connect method.
Fini method	Frees all resources used by this class instance.
FreeEventInfo method	Frees memory associated with a DBSC_Event structure returned by the GetEvent method.
GetErrorInfo method	Retrieves additional information about the failure after a DbmlsyncClient class method returns a failed return code.
GetEvent method	Retrieves the next feedback event for synchronizations requested by the client.
GetProperty method	Retrieves the current value of a property.
Init method	Initializes a DbmlsyncClient class instance.
InstantiateClient method	Creates an instance of the dbmlsync client class that can be used to control synchronizations.
Ping method	Sends a ping request to the dbmlsync server to check if the server is active and responding to requests.
SetProperty method	Sets various properties to modify the behavior of the class instance.
ShutdownServer method	Shuts down the dbmlsync server to which the client is connected.
StartServer method	Starts a new dbmlsync server if one is not already listening on the specified port.
Sync method	Requests that the dbmlsync server perform a synchronization.
WaitForServerShutdown method	Returns when the server has shutdown or when the timeout expires, whichever comes first.

Multiple clients can share the same dbmlsync server. However, each dbmlsync server can only synchronize a single remote database. Each remote database can have only one dbmlsync server synchronizing it.

The dbmlsync server performs one synchronization at a time. If the server receives a synchronization request while performing a synchronization, it queues that request and satisfies it later.

Status information generated by synchronizations is communicated back to the client application through the GetEvent method.