Package io.objectbox.sync

Class 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 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

      • 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

      • getServerTimeNanos

        public long getServerTimeNanos()
        Description copied from interface: SyncClient
        Estimates the current server timestamp in nanoseconds based on the last known server time.
        Specified by:
        getServerTimeNanos in interface SyncClient
        Returns:
        unix timestamp in nanoseconds (since epoch); or 0 if there has not been a server contact yet and thus the server's time is unknown

      • getServerTimeDiffNanos

        public long getServerTimeDiffNanos()
        Description copied from interface: SyncClient
        Returns the estimated difference in nanoseconds between the server time and the local timestamp. urns the difference in nanoseconds between the current local time of this client Equivalent to calculating SyncClient.getServerTimeNanos() - "current time" (nanos since epoch), except for when the server time is unknown, then the result is zero.
        Specified by:
        getServerTimeDiffNanos in interface SyncClient
        Returns:
        time difference in nanoseconds; e.g. positive if server time is ahead of local time; or 0 if there has not been a server contact yet and thus the server's time is unknown

      • getRoundtripTimeNanos

        public long getRoundtripTimeNanos()
        Description copied from interface: SyncClient
        Returns the estimated roundtrip time in nanoseconds to the server and back. This is measured during login.
        Specified by:
        getRoundtripTimeNanos in interface SyncClient
        Returns:
        roundtrip time in nanoseconds; or 0 if there has not been a server contact yet and thus the roundtrip time could not be estimated

      • 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

      • 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.
        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 java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in interface SyncClient

      • 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

      • startObjectsMessage

        public ObjectsMessageBuilder startObjectsMessage​(long flags,
                                                 @Nullable
                                                 java.lang.String topic)
        Description copied from interface: SyncClient
        Experimental. This API might change or be removed in the future.

        Start building a message of Objects with optional flags (set to 0) and topic (set to null).

        Use like 

         syncClient.startObjectsMessage(0, "some-topic")
     .addString(1, "Hello!")
     .addBytes(2, "Hello!".getBytes(StandardCharsets.UTF_8), false)
     .send();
        Specified by:
        startObjectsMessage in interface SyncClient