oracle.lite.mSync

Class BGSyncControl

java.lang.Object

oracle.lite.mSync.BGSyncControl

public class BGSyncControl
extends java.lang.Object

BGSyncControl class is used to control automatic synchronization process. You can use it to start and stop the sync agent, get automatic synchronization status and receive messages send by the sync agent to the applications.

Field Summary

Fields

Modifier and Type	Field and Description
static int	STOP_TIMEOUT Default timeout for stopping sync agent.

Constructor Summary

Constructors

Constructor and Description
BGSyncControl() Create an instance of BGSyncControl class.
BGSyncControl(java.lang.String mu) Create an instance of BGSyncControl class.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelMessage() Cancel reading of messages from another thread (when called on the same BGSyncControl object used in the read loop).
void	close() Close BGSyncControl object.
void	createMsgQ() Create message queue inside the BGSyncControl object to allow receiving application messages from sync agent.
void	disable() Disable sync agent.
void	enable() Enable sync agent.
void	finalize()
BGSyncMsg	getMessage() Get application message from sync agent.
BGSyncStatus	getStatus() Get automatic synchronization status.
boolean	isEnabled() Tells whether sync agent is enabled.
void	kill() Terminate sync agent instead of stopping it gracefully.
void	start() Start sync agent.
void	stop() Stop sync agent.
void	stop(long timeout) Stop sync agent.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STOP_TIMEOUT

public static final int STOP_TIMEOUT

Default timeout for stopping sync agent.

See Also:

stop, Constant Field Values

Constructor Detail

BGSyncControl

public BGSyncControl()
              throws SyncException

Create an instance of BGSyncControl class. This is equivalent to the constructor above with mu = null.

Throws:

SyncException - - if internal error occurred.

BGSyncControl

public BGSyncControl(java.lang.String mu)
              throws SyncException

Create an instance of BGSyncControl class.

Parameters:

mu - - connection string to miniserver (if this instance is to control automatic sync remotely) in the format host:port, like "mymachine.oracle.com:1160". If port is omitted, default port for miniserver (1160) will be used. If mu is empty string or null, this instance will control automatic sync locally (on the same machine).

Throws:

SyncException - - if connection to the miniserver could not be established or internal error occurred.

Method Detail

cancelMessage

public void cancelMessage()

Cancel reading of messages from another thread (when called on the same BGSyncControl object used in the read loop). That's how the loop in the example of @link {#getMessage() getMessage} would exit.

close

public void close()

Close BGSyncControl object. This method will close the message queue if was created and also disconnect from the miniserver if this BGSyncControl object was used to control automatic sync remotely. It is recommended to call this method even though if not called, the tasks above will be done during finalization.

createMsgQ

public void createMsgQ()
                throws SyncException

Create message queue inside the BGSyncControl object to allow receiving application messages from sync agent.

Throws:

SyncExceptin - - if internal error occurred.

SyncException

disable

public void disable()
             throws SyncException

Disable sync agent. This call will not stop sync agent if it is running. You would need to call stop() explicitely.

Throws:

SyncException - - if the internal error occurred.

enable

public void enable()
            throws SyncException

Enable sync agent.

Throws:

SyncException - - if the internal error occurred.

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object

getMessage

public BGSyncMsg getMessage()
                     throws SyncException

Get application message from sync agent. This method blocks until the message is received or

Returns:

BGSyncMsg object or null if the message read was canceled.

Throws:

SyncException - - if internal error occurred.

getStatus

public BGSyncStatus getStatus()
                       throws SyncException

Get automatic synchronization status.

Returns:

BGSyncStatus object describing the status or null if the sync agent is not running.

Throws:

SyncException - - if the status could not be obtained due to internal error in sync agent.

isEnabled

public boolean isEnabled()
                  throws SyncException

Tells whether sync agent is enabled.

Returns:

true if enabled, false if disabled

Throws:

SyncException - - if internal error occurred.

kill

public void kill()
          throws SyncException

Terminate sync agent instead of stopping it gracefully. It is recommended you use this option only if the sync agent cannot be stopped in any other way.

Throws:

SyncException - - if the sync agent process could not be killed due to some system conditions.

start

public void start()
           throws SyncException

Start sync agent.

Throws:

SyncException - - if the sync agent could not be started.

stop

public void stop()
          throws SyncException

Stop sync agent. This function will use default timeout of @link {#STOP_TIMEOUT STOP_TIMEOUT}.

Throws:

SyncException

See Also:

stop

stop

public void stop(long timeout)
          throws SyncException

Stop sync agent.

Parameters:

timeout - - timeout in milliseconds to wait for sync agent to stop gracefully.

Throws:

SyncException - - if the timeout expired or internal error occurred.