Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class HttpReplicator

    An HTTP implementation of IReplicator. Assumes the API supported by ReplicationService.

    Inheritance
    object
    HttpClientBase
    HttpReplicator
    Implements
    IReplicator
    IDisposable
    Inherited Members
    HttpClientBase.DEFAULT_CONNECTION_TIMEOUT
    HttpClientBase.DEFAULT_TIMEOUT
    HttpClientBase.Url
    HttpClientBase.Timeout
    HttpClientBase.EnsureOpen()
    HttpClientBase.VerifyStatus(HttpResponseMessage)
    HttpClientBase.ThrowKnownError(HttpResponseMessage)
    HttpClientBase.ExecutePost(string, object, params string[])
    HttpClientBase.ExecuteGet(string, params string[])
    HttpClientBase.ResponseInputStream(HttpResponseMessage)
    HttpClientBase.ResponseInputStream(HttpResponseMessage, bool)
    HttpClientBase.GetResponseStream(HttpResponseMessage)
    HttpClientBase.GetResponseStream(HttpResponseMessage, bool)
    HttpClientBase.IsDisposed
    HttpClientBase.DoAction<T>(HttpResponseMessage, Func<T>)
    HttpClientBase.DoAction<T>(HttpResponseMessage, bool, Func<T>)
    HttpClientBase.Dispose(bool)
    HttpClientBase.Dispose()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Replicator.Http
    Assembly: Lucene.Net.Replicator.dll
    Syntax
    public class HttpReplicator : HttpClientBase, IReplicator, IDisposable
    Remarks

    Note

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

    Constructors

    HttpReplicator(string, int, string, HttpMessageHandler)

    Creates a new HttpReplicator with the given host, port and path. HttpClientBase(string, int, string, HttpMessageHandler) for more details.

    Declaration
    public HttpReplicator(string host, int port, string path, HttpMessageHandler messageHandler = null)
    Parameters
    Type Name Description
    string host
    int port
    string path
    HttpMessageHandler messageHandler
    Remarks

    Note

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

    HttpReplicator(string, HttpClient)

    Creates a new HttpReplicator with the given url and HttpClient. HttpClientBase(string, HttpClient) for more details.

    Declaration
    public HttpReplicator(string url, HttpClient client)
    Parameters
    Type Name Description
    string url
    HttpClient client
    Remarks

    Note

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

    HttpReplicator(string, HttpMessageHandler)

    Creates a new HttpReplicator with the given url. HttpClientBase(string, HttpMessageHandler) for more details.

    Declaration
    public HttpReplicator(string url, HttpMessageHandler messageHandler = null)
    Parameters
    Type Name Description
    string url
    HttpMessageHandler messageHandler
    Remarks

    Note

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

    Methods

    CheckForUpdate(string)

    Checks for updates at the remote host.

    Declaration
    public virtual SessionToken CheckForUpdate(string currentVersion)
    Parameters
    Type Name Description
    string currentVersion
    Returns
    Type Description
    SessionToken
    Remarks

    Note

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

    ObtainFile(string, string, string)

    Obtains the given file from it's source at the remote host.

    Declaration
    public virtual Stream ObtainFile(string sessionId, string source, string fileName)
    Parameters
    Type Name Description
    string sessionId
    string source
    string fileName
    Returns
    Type Description
    Stream
    Remarks

    Note

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

    Publish(IRevision)

    Not supported.

    Declaration
    public virtual void Publish(IRevision revision)
    Parameters
    Type Name Description
    IRevision revision
    Remarks

    Note

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

    Exceptions
    Type Condition
    NotSupportedException

    this replicator implementation does not support remote publishing of revisions

    Release(string)

    Releases a session obtained from the remote host.

    Declaration
    public virtual void Release(string sessionId)
    Parameters
    Type Name Description
    string sessionId
    Remarks

    Note

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

    Implements

    IReplicator
    IDisposable
    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.