クラスの同期

Atlas Device SDK は非推奨です。詳細については、の廃止ページを参照してください。

io.realm.mongodb.sync

java.lang.Object

io.realm.mongodb.sync.SyncSession

セッションは、デバイス上の単一の Realm と Realm オブジェクトサーバー上のサーバー Realm との間でデータを同期する方法を制御します。セッションは、 SyncConfigurationを使用して Realm インスタンスを開くことによって作成されます。セッションが作成されると、アプリが閉じられるか、このSyncConfigurationを使用するすべてのスレッドがそれぞれのRealmを閉じるまで、そのセッションは存在し続けます。

セッションは Realm によって制御されますが、エラーが発生した場合に追加情報を提供できます。これらのエラーはSyncSession.ErrorHandlerによって渡されます。

セッションを作成する際、Realm はサーバーへの接続を確立します。この接続は Realm によって制御され、複数のセッション間で共有される場合があります。 addConnectionchangeLister(ConnectionLister)とisConnected()を使用して、接続のインサイトを得ることが可能です。

セッション自体のライフサイクルは、基礎となる接続とは異なります。セッションの状態は、 getState()を使用して見つけることができます。

SyncSessionオブジェクトはスレッドセーフです。

ネストされたクラスの概要

修飾子と型	クラスと説明
`public static final`	SyncSession.State
`public static interface`	SyncSession.ErrorHandler
`public static interface`	SyncSession.ClientResetHandler

メソッドの概要

修飾子と型	メソッドと説明
public synchronized void	addConnectionChangeListener ( ConnectionListener listener ) このセッションをサポートする接続への変更を追跡するリスナーを追加します。
public synchronized void	addDownloadProgressListener ( ProgressMode mode, ProgressListener listener ) Realm Object Server からダウンロードする必要がある変更を追跡する進行状況リスナーを追加します。
public synchronized void	addUploadProgressListener ( ProgressMode mode, ProgressListener listener ) デバイスから Realm オブジェクトサーバーにアップロードする必要がある変更を追跡する進行状況リスナーを追加します。
パブリックブール値	downloadAllServerChanges ( long timeout, TimeUnit unit ) このメソッドを呼び出すと、既知のリモート変更がすべてダウンロードされ Realm に適用されるか、指定されたタイムアウトに達するまでブロックされます。
public void	downloadAllServerChanges () このメソッドを呼び出すと、既知のリモート変更がすべてダウンロードされ、Realm に適用されるまでブロックされます。
public SyncConfiguration	getConfiguration () セッションを制御する同期構成を返します。
public ConnectionState	getConnectionState () ConnectionStateで定義されている、セッションによって使用される接続の現在の状態を取得します。
公開 URI	getServerUrl () URI を返しますこのセッションが接続して変更を同期するリモート Realm を説明します。
public SyncSession.State	getState () SyncSession.Stateで定義されている現在のセッションの状態を取得します。
publicユーザー	getUser () MongoDB Realm への接続に使用される SyncConfiguration によって定義されたユーザーを返します。
パブリックブール値	isConnected () セッションがサーバーに接続され、データを同期できるかどうかを確認します。
public synchronized void	removeConnectionChangeListener ( ConnectionListener listener ) 以前に登録されたConnectionListerを削除します。
public synchronized void	removeProgressListener ( ProgressListener listener ) 進行状況リスナーを削除します。
public synchronized void	start () セッションを開始し、Realm Object Server との同期を有効にしようとします。
public synchronized void	stop () Realm が完全に閉じられた後、再度開かれるまで、Realm オブジェクトサーバーとの同期を停止します。
パブリックブール値	uploadAllLocalChanges ( long timeout, TimeUnit unit ) このメソッドを呼び出すと、既知のローカル変更がすべてサーバーにアップロードされるか、指定されたタイムアウトに達するまでブロックされます。
public void	uploadAllLocalChanges () このメソッドを呼び出すと、既知のローカル変更がすべてサーバーにアップロードされるまでブロックされます。

継承されたメソッド

クラス java.lang.Object から継承されたメソッド :getClass 、hashCode 、equals 、clone 、toString 、notify 、notifyAll 、wait 、wait 、wait 、finalize

メソッドの詳細

addConnection ChangeLister

public synchronized void addConnectionChangeListener ( ConnectionListener listener )
このセッションをサポートする接続への変更を追跡するリスナーを追加します。詳細については、「 ConnectionState 」を参照してください。パラメーター `listener` - 登録するリスナー。スロー IllialArgmentException - リスナーが`null` の場合。 Tip 以下も参照してください。 ConnectionState

addProgressLister

public synchronized void addDownloadProgressListener (

ProgressMode mode,

ProgressListener listener

)

Realm オブジェクトサーバーからダウンロードする必要がある変更を追跡する進行状況リスナーを追加します。プログレスリスナーは、登録されるとすぐにトリガーされ、その後は定期的にトリガーされます。

パラメーター

mode - 使用されるモードのタイプ。詳細については、「プログレスモード」を参照してください。
listener - 登録するリスナー。

addUploadProgressLister

public synchronized void addUploadProgressListener (

ProgressMode mode,

ProgressListener listener

)

デバイスから Realm オブジェクトサーバーにアップロードする必要がある変更を追跡する進行状況リスナーを追加します。ProgressLister は、登録されるとすぐにトリガーされ、その後は定期的にトリガーされます。

パラメーター

mode - 使用されるモードのタイプ。詳細については、「プログレスモード」を参照してください。
listener - 登録するリスナー。

ダウンロードAllServerChecks

public boolean downloadAllServerChanges (

long timeout,

TimeUnit unit

)

このメソッドを呼び出すと、既知のリモート変更がすべてダウンロードされ Realm に適用されるか、指定されたタイムアウトに達するまでブロックされます。これにはネットワークアクセスが含まれるため、このメソッドを呼び出す場合は UI 以外のスレッドからのみ実行する必要があります。このメソッドは、Realm が開かれる前は呼び出すことができません。

戻り値

true タイムアウト前にデータがダウンロードされた場合。操作がタイムアウトしたなどして失敗した場合は、 false 。

スロー

IllalStateException - Android のメインスレッドで呼び出された場合
InterrutedException - 指定されたタイムアウトよりもダウンロードに時間がかかった場合、またはダウンロードの進行中にスレッドが中断された場合。この例外がスローされた後でも、バックグラウンドでダウンロードは続行されます。
IllialArgmentException - がtimeout 0以下の場合、またはunit がnull の場合。

public void downloadAllServerChanges ()

このメソッドを呼び出すと、既知のリモート変更がすべてダウンロードされ、Realm に適用されるまでブロックされます。これにはネットワークアクセスが含まれるため、このメソッドを呼び出すには、非 UI スレッドからのみ実行する必要があります。デバイスがオフラインの場合、このメソッドは返されない可能性があります。

このメソッドは、セッションが開始される前に呼び出すことができません。

スロー

IllalStateException - Android のメインスレッドで呼び出された場合
InterrutedException - ダウンロードの進行中にスレッドが中断された場合。

getConfiguration

public SyncConfiguration getConfiguration ()
セッションを制御する同期構成を返します。戻り値このセッションを定義および制御する SyncConfiguration。

getConnectionState

public ConnectionState getConnectionState ()
ConnectionStateで定義されている、セッションによって使用される接続の現在の状態を取得します。戻り値セッションで使用される接続の状態 Tip 以下も参照してください。 ConnectionState

getServerUrl

public URI getServerUrl ()
URI を返しますこのセッションが接続して変更を同期するリモート Realm を説明します。戻り値 URI リモート Realm を説明します。

getState

public SyncSession.State getState ()
SyncSession.Stateで定義されている現在のセッションの状態を取得します。このメソッドが返した後に状態が変化する可能性があることに注意してください。戻り値セッションの状態 Tip 以下も参照してください。 SyncSession.State

getUser

public User getUser ()
MongoDB Realm への接続に使用される SyncConfiguration によって定義されたユーザーを返します。戻り値 MongoDB Realm でセッションを認証するために使用されるユーザー。

isConnected

public boolean isConnected ()

セッションがサーバーに接続され、データを同期できるかどうかを確認します。これは推測的結果です。消費量を節約するために、基礎の実装はハートビートを使用して接続がまだ利用可能かどうかを検出します。したがって、アクティブに同期されているデータがなく、最後のハートビートから時間が経過した場合、接続は切断された可能性がありますが、このメソッドは引き続きtrueを返します。

戻り値

true セッションが接続され、データを同期する準備ができている場合は、未接続の場合はfalse 、接続プロセス中の場合は 0}。

deleteConnection存在の変更リスナー

public synchronized void removeConnectionChangeListener ( ConnectionListener listener )
以前に登録されたConnectionListerを削除します。パラメーター `listener` - 削除するリスナースロー IllialArgmentException - リスナーが`null` の場合。

deleteProgressLister

public synchronized void removeProgressListener ( ProgressListener listener )
進行状況リスナーを削除します。リスナーが登録されていない場合、このメソッドは何も実行しません。パラメーター `listener` - 削除するリスナー。

始める

public synchronized void start ()

セッションを開始し、Realm オブジェクトサーバーとの同期を有効にしようとします。これは Realm インスタンスを開くと自動的に行われるため、セッションがstop()を使用して停止されている場合にのみ手動で実行する必要があります。

セッションがすでに開始されている場合は、このメソッドを呼び出しても何も行われません。

getState()がState.ACTIVEを返す場合、セッションは開始されたと見なされます。セッションが State.dying の場合、セッションはState.ACTIVEに移動されます。

Tip

停止

public synchronized void stop ()
Realm が完全に閉じられた後、再度開かれるまで、Realm オブジェクトサーバーとの同期を停止します。同期は、 start()を再度有効にすることで再度有効にできます。セッションがすでに停止している場合は、このメソッドを呼び出しても何も行われません。

アップロードAllLocalchanges

public boolean uploadAllLocalChanges (

long timeout,

TimeUnit unit

)

このメソッドを呼び出すと、既知のローカル変更がすべてサーバーにアップロードされるか、指定されたタイムアウトに達するまでブロックされます。これにはネットワークアクセスが含まれるため、このメソッドを呼び出す場合は UI 以外のスレッドからのみ実行する必要があります。このメソッドは、Realm が開かれる前は呼び出すことができません。

戻り値

true タイムアウト前にデータがアップロードされた場合。操作がタイムアウトしたなどして失敗した場合は、 false 。

スロー

IllalStateException - Android のメインスレッドで呼び出された場合
InterrutedException - アップロードに指定されたタイムアウトよりも長い時間がかかる場合、またはアップロードの進行中にスレッドが中断された場合。この例外がスローされた後でも、バックグラウンドでアップロードは続行されます。
IllialArgmentException - がtimeout 0以下の場合、またはunit がnull の場合。

public void uploadAllLocalChanges ()

このメソッドを呼び出すと、既知のローカル変更がすべてサーバーにアップロードされるまでブロックされます。これにはネットワークアクセスが含まれるため、このメソッドを呼び出すには、非 UI スレッドからのみ実行する必要があります。デバイスがオフラインの場合、このメソッドは返されない可能性があります。

このメソッドは、Realm が開かれる前に呼び出すことができません。

スロー

IllalStateException - Android のメインスレッドで呼び出された場合
InterrutedException - ダウンロードの進行中にスレッドが中断された場合。

戻る

SyncConfiguration.InitialFlexibleSyncSubscriptions

SyncSession.ClientResetHandler