io.objectbox.sync

Class SyncClientImpl

java.lang.Object

io.objectbox.sync.SyncClientImpl

All Implemented Interfaces:

SyncClient, java.io.Closeable, java.lang.AutoCloseable

@Internal
public class SyncClientImpl
extends java.lang.Object
implements SyncClient

Internal sync client implementation. Use SyncClient to access functionality, this class may change without notice.

Method Summary

Modifier and Type	Method and Description
boolean	awaitFirstLogin(long millisToWait) Waits until the sync client receives a response to its first (connection and) login attempt or until the given time has expired.
boolean	cancelUpdates() Asks the server to pause sync updates.
void	close() Closes and cleans up all resources used by this sync client.
protected void	finalize() Users of this class should explicitly call close() instead to avoid expensive finalization.
long	getLastLoginCode() Response code of last login attempt.
java.lang.String	getServerUrl() Gets the sync server URL this client is connected to.
SyncState	getSyncState() Gets the current state of this sync client.
boolean	isLoggedIn() Flag indicating if the sync client was started.
boolean	isStarted() Flag indicating if the sync client was started.
void	notifyConnectionAvailable() Lets the sync client know that a working network connection is available.
boolean	requestFullSync() Temporary only, try not to use it.
boolean	requestFullSyncAndUpdates() Temporary only, try not to use it.
boolean	requestUpdates() Asks the sync server to resume sync updates.
boolean	requestUpdatesOnce() Asks the server to send sync updates until this sync client is up-to-date, then pauses sync updates again.
void	setLoginCredentials(SyncCredentials credentials) Updates the login credentials.
void	setSyncChangeListener(SyncChangeListener changesListener) Sets a SyncChangeListener.
void	setSyncCompletedListener(SyncCompletedListener listener) Sets a listener to observe Sync completed events.
void	setSyncConnectionListener(SyncConnectionListener listener) Sets a listener to observe Sync connection events.
void	setSyncListener(SyncListener listener) Sets a listener to observe all Sync events.
void	setSyncLoginListener(SyncLoginListener listener) Sets a listener to observe login events.
void	start() Starts the client.
void	stop() Stops the client.

Methods inherited from class java.lang.Object

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

Method Detail

getServerUrl

public java.lang.String getServerUrl()

Description copied from interface: SyncClient

Gets the sync server URL this client is connected to.

Specified by:

getServerUrl in interface SyncClient

getLastLoginCode

public long getLastLoginCode()

Description copied from interface: SyncClient

Response code of last login attempt. One of SyncLoginCodes.

Specified by:

getLastLoginCode in interface SyncClient

isLoggedIn

public boolean isLoggedIn()

Description copied from interface: SyncClient

Flag indicating if the sync client was started. Logged in clients can sync with the sync destination to exchange data.

Specified by:

isLoggedIn in interface SyncClient

getSyncState

public SyncState getSyncState()

Gets the current state of this sync client. Throws if close() was called.

setSyncLoginListener

public void setSyncLoginListener(@Nullable
                                 SyncLoginListener listener)

Description copied from interface: SyncClient

Sets a listener to observe login events. Replaces a previously set listener. Set to null to remove the listener.

Specified by:

setSyncLoginListener in interface SyncClient

setSyncCompletedListener

public void setSyncCompletedListener(@Nullable
                                     SyncCompletedListener listener)

Description copied from interface: SyncClient

Sets a listener to observe Sync completed events. Replaces a previously set listener. Set to null to remove the listener.

Specified by:

setSyncCompletedListener in interface SyncClient

setSyncChangeListener

public void setSyncChangeListener(@Nullable
                                  SyncChangeListener changesListener)

Description copied from interface: SyncClient

Sets a SyncChangeListener. Replaces a previously set listener. Set to null to remove the listener.

Specified by:

setSyncChangeListener in interface SyncClient

setSyncConnectionListener

public void setSyncConnectionListener(@Nullable
                                      SyncConnectionListener listener)

Description copied from interface: SyncClient

Sets a listener to observe Sync connection events. Replaces a previously set listener. Set to null to remove the listener.

Specified by:

setSyncConnectionListener in interface SyncClient

setSyncListener

public void setSyncListener(@Nullable
                            SyncListener listener)

Description copied from interface: SyncClient

Sets a listener to observe all Sync events. Replaces all other previously set listeners, except a SyncChangeListener. Set to null to remove the listener.

Specified by:

setSyncListener in interface SyncClient

setLoginCredentials

public void setLoginCredentials(SyncCredentials credentials)

Description copied from interface: SyncClient

Updates the login credentials. This should not be required during regular use. The original credentials were passed when building sync client.

Specified by:

setLoginCredentials in interface SyncClient

awaitFirstLogin

public boolean awaitFirstLogin(long millisToWait)

Description copied from interface: SyncClient

Waits until the sync client receives a response to its first (connection and) login attempt or until the given time has expired. Use SyncClient.isLoggedIn() or SyncClient.getLastLoginCode() afterwards to determine if login was successful. Starts the sync if it is not already.

Specified by:

awaitFirstLogin in interface SyncClient

Returns:

true if a response was received in the given time window.

start

public void start()

Description copied from interface: SyncClient

Starts the client. It will connect to the server, log in (authenticate) and start syncing.

Specified by:

start in interface SyncClient

isStarted

public boolean isStarted()

Description copied from interface: SyncClient

Flag indicating if the sync client was started. Started clients try to connect, login, and sync with the sync destination.

Specified by:

isStarted in interface SyncClient

stop

public void stop()

Description copied from interface: SyncClient

Stops the client. Does nothing if the sync client is already stopped or closed.

Specified by:

stop in interface SyncClient

close

public void close()

Description copied from interface: SyncClient

Closes and cleans up all resources used by this sync client. It can no longer be used afterwards, build a new sync client instead. Does nothing if this sync client has already been closed.

Specified by:

close in interface SyncClient

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

finalize

protected void finalize()
                 throws java.lang.Throwable

Users of this class should explicitly call close() instead to avoid expensive finalization.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

requestFullSync

@Experimental
public boolean requestFullSync()

Temporary only, try not to use it.

Specified by:

requestFullSync in interface SyncClient

Returns:

'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future).

requestFullSyncAndUpdates

@Experimental
public boolean requestFullSyncAndUpdates()

Temporary only, try not to use it.

requestUpdates

public boolean requestUpdates()

Description copied from interface: SyncClient

Asks the sync server to resume sync updates. This is useful if sync updates were turned off with requestUpdatesMode(MANUAL).

Specified by:

requestUpdates in interface SyncClient

Returns:

'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future)

See Also:

SyncClient.cancelUpdates()

requestUpdatesOnce

public boolean requestUpdatesOnce()

Description copied from interface: SyncClient

Asks the server to send sync updates until this sync client is up-to-date, then pauses sync updates again. This is useful if sync updates were turned off with requestUpdatesMode(MANUAL).

Specified by:

requestUpdatesOnce in interface SyncClient

Returns:

'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future)

cancelUpdates

public boolean cancelUpdates()

Description copied from interface: SyncClient

Asks the server to pause sync updates.

Specified by:

cancelUpdates in interface SyncClient

Returns:

'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future)

See Also:

SyncClient.requestUpdates()

notifyConnectionAvailable

public void notifyConnectionAvailable()

Description copied from interface: SyncClient

Lets the sync client know that a working network connection is available.

This can help speed up reconnecting to the sync server.

Specified by:

notifyConnectionAvailable in interface SyncClient