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.Closeable
ObjectBox 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 void
close()
Closes and cleans up all resources used by this sync server.int
getPort()
Gets the port the server has bound to.java.lang.String
getStatsString()
Gets some statistics from the sync server.java.lang.String
getUrl()
Gets the URL the server is running at.boolean
isRunning()
Returns if the server is up and running.void
setSyncChangeListener(SyncChangeListener listener)
Sets aSyncChangeListener
.void
start()
Starts the server (e.g.void
stop()
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 tonull
to 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:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
-
-