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
    System.Object
    SessionToken
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.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

    | Improve this Doc View Source

    SessionToken(IDataInput)

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

    Declaration
    public SessionToken(IDataInput reader)
    Parameters
    Type Name Description
    J2N.IO.IDataInput reader
    Exceptions
    Type Condition
    System.IO.IOException
    | Improve this Doc View Source

    SessionToken(String, IRevision)

    Constructor with the given id and revision.

    Declaration
    public SessionToken(string id, IRevision revision)
    Parameters
    Type Name Description
    System.String id
    IRevision revision
    Exceptions
    Type Condition
    System.IO.IOException

    Properties

    | Improve this Doc View Source

    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
    System.String
    See Also
    Release(System.String)
    | Improve this Doc View Source

    SourceFiles

    SourceFiles
    Declaration
    public IDictionary<string, IList<RevisionFile>> SourceFiles { get; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Collections.Generic.IList<RevisionFile>>
    | Improve this Doc View Source

    Version

    Version
    Declaration
    public string Version { get; }
    Property Value
    Type Description
    System.String

    Methods

    | Improve this Doc View Source

    Serialize(DataOutputStream)

    Serialize the token data for communication between server and client.

    Declaration
    public void Serialize(DataOutputStream writer)
    Parameters
    Type Name Description
    J2N.IO.DataOutputStream writer
    Exceptions
    Type Condition
    System.IO.IOException
    | Improve this Doc View Source

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    System.Object.ToString()

    See Also

    CheckForUpdate(System.String)
    Release(System.String)
    DEFAULT_SESSION_EXPIRATION_THRESHOLD
    • Improve this Doc
    • View Source
    Back to top Copyright © 2022 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.