Package io.objectbox.sync.server
Interface SyncServer
-
- All Superinterfaces:
java.lang.AutoCloseable,java.io.Closeable
- All Known Implementing Classes:
SyncServerImpl
@Experimental public interface SyncServer extends java.io.CloseableObjectBox sync server. Build a server withSync.server(io.objectbox.BoxStore, java.lang.String, io.objectbox.sync.SyncCredentials).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclose()Closes and cleans up all resources used by this sync server.intgetPort()Gets the port the server has bound to.java.lang.StringgetStatsString()Gets some statistics from the sync server.java.lang.StringgetUrl()Gets the URL the server is running at.booleanisRunning()Returns if the server is up and running.voidsetSyncChangeListener(SyncChangeListener listener)Sets aSyncChangeListener.voidstart()Starts the server (e.g.voidstop()Stops the server.
-
-
-
Method Detail
-
getUrl
java.lang.String getUrl()
Gets the URL the server is running at.
-
getPort
int getPort()
Gets the port the server has bound to.
-
isRunning
boolean isRunning()
Returns if the server is up and running.
-
getStatsString
java.lang.String getStatsString()
Gets some statistics from the sync server.
-
setSyncChangeListener
void setSyncChangeListener(@Nullable SyncChangeListener listener)Sets aSyncChangeListener. Replaces a previously set listener. Set tonullto remove the listener.
-
start
void start()
Starts the server (e.g. bind to port) and gets everything operational.
-
stop
void stop()
Stops the server.
-
close
void close()
Closes and cleans up all resources used by this sync server. It can no longer be used afterwards, build a new sync server instead. Does nothing if this sync server has already been closed.- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.io.Closeable
-
-