TsgcWSPClient_sgcメソッド › GetLastOffset

GetLastOffset メソッド

クライアントがチャンネルで最後に確認したメッセージオフセットを返します。

構文

function GetLastOffset(const aChannel: String): Int64;

パラメータ

名前タイプ説明
aChannelconst String追跡されているオフセットが返されるチャンネルの名前。

戻り値

チャンネルで受信した最後のオフセット。クライアントがチャンネルでまだメッセージを受信していない場合(またはサーバーでメッセージ履歴が有効になっていない場合)は 0 を返します。

解説

クライアントは、サーバーでメッセージ履歴が有効になっている間に受信した最後のメッセージのオフセットを、チャンネルごとのカーソルとして保持します。このカーソルは、再接続時に通常の Subscribe が送信するものであり、サーバーはクライアントが見逃したメッセージのみをリプレイします。GetLastOffset を使用してこのカーソルを確認します。たとえば、アプリケーションの再起動をまたいで永続化したり、明示的な Subscribe(aChannel, aSinceOffset) リプレイを駆動したりするために使用します。

.NET では、対応する SetLastOffset および ClearOffsets メソッドを使用して、追跡されているカーソルを復元またはリセットできます。

使用例

LastOffset := oProtocol.GetLastOffset('news');

メソッドに戻る