Interface IStreamingCollectionEndpoint<TEntity, TElementEndpoint>

Namespace

TypedRest.Endpoints.Reactive

Assembly

TypedRest.Reactive.dll

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

public interface IStreamingCollectionEndpoint<TEntity, out TElementEndpoint> : ICollectionEndpoint<TEntity, TElementEndpoint>, IIndexerEndpoint<TElementEndpoint>, IEndpoint where TEntity : class where TElementEndpoint : IElementEndpoint<TEntity>

Type Parameters

TEntity

The type of individual elements in the collection.

TElementEndpoint

The type of IEndpoint to provide for individual TEntitys.

Inherited Members

ICollectionEndpoint<TEntity, TElementEndpoint>.this[TEntity]

ICollectionEndpoint<TEntity, TElementEndpoint>.ReadAllAllowed

ICollectionEndpoint<TEntity, TElementEndpoint>.ReadAllAsync(CancellationToken)

ICollectionEndpoint<TEntity, TElementEndpoint>.ReadRangeAllowed

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

ICollectionEndpoint<TEntity, TElementEndpoint>.CreateAllowed

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

ICollectionEndpoint<TEntity, TElementEndpoint>.CreateAllAllowed

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

ICollectionEndpoint<TEntity, TElementEndpoint>.SetAllAllowed

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

IIndexerEndpoint<TElementEndpoint>.this[string]

IEndpoint.Uri

IEndpoint.HttpClient

IEndpoint.Serializers

IEndpoint.ErrorHandler

IEndpoint.LinkExtractor

IEndpoint.GetLinks(string)

IEndpoint.Link(string)

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

IEndpoint.LinkTemplate(string, 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)

Remarks

Use the more constrained IStreamingCollectionEndpoint<TEntity> when possible.

Properties

PollingInterval

The interval in which to send requests to the server. The server can modify this value using the Retry-After header.

TimeSpan PollingInterval { get; set; }

Property Value

TimeSpan

Methods

GetObservable(long)

Provides an observable stream of elements.

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>

A cold observable. HTTP communication only starts on Subscribe(IObserver<T>).