Table of Contents

Class StreamingEndpoint<TEntity>

Namespace
TypedRest.Endpoints.Reactive
Assembly
TypedRest.Reactive.dll

Endpoint for a stream of TEntitys using a persistent HTTP connection.

public class StreamingEndpoint<TEntity> : EndpointBase, IStreamingEndpoint<TEntity>, IEndpoint

Type Parameters

TEntity

The type of individual elements in the stream.

Inheritance
StreamingEndpoint<TEntity>
Implements
Inherited Members

Constructors

StreamingEndpoint(IEndpoint, string, string)

Creates a new streaming endpoint.

public StreamingEndpoint(IEndpoint referrer, string relativeUri, string separator = "\n")

Parameters

referrer IEndpoint

The endpoint used to navigate to this one.

relativeUri string

The URI of this endpoint relative to the referrer's. Add a ./ prefix here to imply a trailing slash referrer's URI.

separator string

The character sequence used to detect that a new element starts in an HTTP stream.

StreamingEndpoint(IEndpoint, Uri, string)

Creates a new streaming endpoint.

public StreamingEndpoint(IEndpoint referrer, Uri relativeUri, string separator = "\n")

Parameters

referrer IEndpoint

The endpoint used to navigate to this one.

relativeUri Uri

The URI of this endpoint relative to the referrer's.

separator string

The character sequence used to detect that a new element starts in an HTTP stream.

Properties

BufferSize

The size of the buffer used to collect data for deserialization in bytes.

public int BufferSize { get; set; }

Property Value

int

Methods

GetObservable()

Provides an observable stream of entities. The observable is cold; HTTP communication only starts on Subscribe(IObserver<T>).

public virtual IObservable<TEntity> GetObservable()

Returns

IObservable<TEntity>