Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SessionToken

    Token for a replication session, for guaranteeing that source replicated files will be kept safe until the replication completes.

    Inheritance
    object
    SessionToken
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Replicator
    Assembly: Lucene.Net.Replicator.dll
    Syntax
    public sealed class SessionToken
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Constructors

    SessionToken(IDataInput)

    Constructor which deserializes from the given J2N.IO.IDataInput.

    Declaration
    public SessionToken(IDataInput reader)
    Parameters
    Type Name Description
    IDataInput reader
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Exceptions
    Type Condition
    IOException
    See Also
    CheckForUpdate(string)
    Release(string)
    DEFAULT_SESSION_EXPIRATION_THRESHOLD

    SessionToken(string, IRevision)

    Constructor with the given id and revision.

    Declaration
    public SessionToken(string id, IRevision revision)
    Parameters
    Type Name Description
    string id
    IRevision revision
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Exceptions
    Type Condition
    IOException
    See Also
    CheckForUpdate(string)
    Release(string)
    DEFAULT_SESSION_EXPIRATION_THRESHOLD

    Properties

    Id

    Id of this session. Should be passed when releasing the session, thereby acknowledging the IReplicator that this session is no longer in use.

    Declaration
    public string Id { get; }
    Property Value
    Type Description
    string
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    See Also
    Release(string)

    SourceFiles

    SourceFiles

    Declaration
    public IDictionary<string, IList<RevisionFile>> SourceFiles { get; }
    Property Value
    Type Description
    IDictionary<string, IList<RevisionFile>>
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    See Also
    CheckForUpdate(string)
    Release(string)
    DEFAULT_SESSION_EXPIRATION_THRESHOLD

    Version

    Version

    Declaration
    public string Version { get; }
    Property Value
    Type Description
    string
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    See Also
    CheckForUpdate(string)
    Release(string)
    DEFAULT_SESSION_EXPIRATION_THRESHOLD

    Methods

    Serialize(DataOutputStream)

    Serialize the token data for communication between server and client.

    Declaration
    public void Serialize(DataOutputStream writer)
    Parameters
    Type Name Description
    DataOutputStream writer
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Exceptions
    Type Condition
    IOException
    See Also
    CheckForUpdate(string)
    Release(string)
    DEFAULT_SESSION_EXPIRATION_THRESHOLD

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string that represents the current object.

    Overrides
    object.ToString()
    Remarks

    Note

    This API is experimental and might change in incompatible ways in the next release.

    See Also
    CheckForUpdate(string)
    Release(string)
    DEFAULT_SESSION_EXPIRATION_THRESHOLD

    See Also

    CheckForUpdate(string)
    Release(string)
    DEFAULT_SESSION_EXPIRATION_THRESHOLD
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.