Class StreamingCollectionEndpoint<TEntity, TElementEndpoint>

Namespace

TypedRest.Endpoints.Reactive

Assembly

TypedRest.Reactive.dll

Endpoint for a collection of TEntitys observable as an append-only stream using long-polling.

public class StreamingCollectionEndpoint<TEntity, TElementEndpoint> : CollectionEndpoint<TEntity, TElementEndpoint>, ICachingEndpoint, IStreamingCollectionEndpoint<TEntity, TElementEndpoint>, ICollectionEndpoint<TEntity, TElementEndpoint>, IIndexerEndpoint<TElementEndpoint>, IEndpoint where TEntity : class where TElementEndpoint : class, IElementEndpoint<TEntity>

Type Parameters

TEntity

The type of entity the endpoint represents.

TElementEndpoint

The type of IEndpoint to provide for individual TEntitys. Must have a public constructor with an IEndpoint and an Uri or string parameter.

Inheritance

object

EndpointBase

CachingEndpointBase

CollectionEndpoint<TEntity, TElementEndpoint>

StreamingCollectionEndpoint<TEntity, TElementEndpoint>

Implements

ICachingEndpoint

IStreamingCollectionEndpoint<TEntity, TElementEndpoint>

ICollectionEndpoint<TEntity, TElementEndpoint>

IIndexerEndpoint<TElementEndpoint>

IEndpoint

Derived

StreamingCollectionEndpoint<TEntity>

Inherited Members

CollectionEndpoint<TEntity, TElementEndpoint>.this[string]

CollectionEndpoint<TEntity, TElementEndpoint>.this[TEntity]

CollectionEndpoint<TEntity, TElementEndpoint>.ReadAllAllowed

CollectionEndpoint<TEntity, TElementEndpoint>.ReadAllAsync(CancellationToken)

CollectionEndpoint<TEntity, TElementEndpoint>.RangeUnit

CollectionEndpoint<TEntity, TElementEndpoint>.HandleCapabilities(HttpResponseMessage)

CollectionEndpoint<TEntity, TElementEndpoint>.ReadRangeAllowed

CollectionEndpoint<TEntity, TElementEndpoint>.ReadRangeAsync(RangeItemHeaderValue, CancellationToken)

CollectionEndpoint<TEntity, TElementEndpoint>.CreateAllowed

CollectionEndpoint<TEntity, TElementEndpoint>.CreateAsync(TEntity, CancellationToken)

CollectionEndpoint<TEntity, TElementEndpoint>.CreateAllAllowed

CollectionEndpoint<TEntity, TElementEndpoint>.CreateAllAsync(IEnumerable<TEntity>, CancellationToken)

CollectionEndpoint<TEntity, TElementEndpoint>.SetAllAllowed

CollectionEndpoint<TEntity, TElementEndpoint>.SetAllAsync(IEnumerable<TEntity>, CancellationToken)

CachingEndpointBase.ResponseCache

CachingEndpointBase.GetContentAsync(CancellationToken, string)

CachingEndpointBase.PutContentAsync(HttpContent, CancellationToken, string)

CachingEndpointBase.DeleteContentAsync(CancellationToken, string)

EndpointBase.Uri

EndpointBase.HttpClient

EndpointBase.Serializers

EndpointBase.Serializer

EndpointBase.ErrorHandler

EndpointBase.LinkExtractor

EndpointBase.HandleAsync(Func<Task<HttpResponseMessage>>, string)

EndpointBase.FinalizeAsync(Func<Task<HttpResponseMessage>>, string)

EndpointBase.StartActivity(string)

EndpointBase.SetDefaultLink(string, string)

EndpointBase.SetDefaultLinkTemplate(string, string)

EndpointBase.GetLinks(string)

EndpointBase.Link(string)

EndpointBase.GetLinkTemplate(string)

EndpointBase.LinkTemplate(string, IDictionary<string, object>)

EndpointBase.LinkTemplate(string, object)

EndpointBase.HandleCapabilities(HttpResponseMessage)

EndpointBase.IsMethodAllowed(HttpMethod)

EndpointBase.ToString()

EndpointBase.GetConstructor<TEndpoint>()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

CollectionEndpointExtensions.ContainsAsync<TEntity, TElementEndpoint>(ICollectionEndpoint<TEntity, TElementEndpoint>, TEntity, CancellationToken)

CollectionEndpointExtensions.DeleteAsync<TEntity, TElementEndpoint>(ICollectionEndpoint<TEntity, TElementEndpoint>, TEntity, CancellationToken)

CollectionEndpointExtensions.MergeAsync<TEntity, TElementEndpoint>(ICollectionEndpoint<TEntity, TElementEndpoint>, TEntity, CancellationToken)

CollectionEndpointExtensions.SetAsync<TEntity, TElementEndpoint>(ICollectionEndpoint<TEntity, TElementEndpoint>, TEntity, CancellationToken)

CollectionEndpointExtensions.ContainsAsync<TElementEndpoint>(IIndexerEndpoint<TElementEndpoint>, string, CancellationToken)

CollectionEndpointExtensions.DeleteAsync<TElementEndpoint>(IIndexerEndpoint<TElementEndpoint>, string, CancellationToken)

Constructors

StreamingCollectionEndpoint(IEndpoint, string)

Creates a new streaming collection endpoint.

public StreamingCollectionEndpoint(IEndpoint referrer, string relativeUri)

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.

StreamingCollectionEndpoint(IEndpoint, Uri)

Creates a new streaming collection endpoint.

public StreamingCollectionEndpoint(IEndpoint referrer, Uri relativeUri)

Parameters

referrer IEndpoint

The endpoint used to navigate to this one.

relativeUri Uri

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

Methods

GetObservable(long)

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

public IObservable<TEntity> GetObservable(long startIndex = 0)

Parameters

startIndex long

The index of the first element to return in the stream. Use negative values to start counting from the end of the stream.

Returns

IObservable<TEntity>