Class PollingEndpoint<TEntity>

Namespace

TypedRest.Endpoints.Reactive

Assembly

TypedRest.Reactive.dll

Endpoint for a resource that can be polled for state changes.

public class PollingEndpoint<TEntity> : ElementEndpoint<TEntity>, ICachingEndpoint, IPollingEndpoint<TEntity>, IElementEndpoint<TEntity>, IElementEndpoint, IEndpoint where TEntity : class

Type Parameters

TEntity

The type of entity the endpoint represents.

Inheritance

object

EndpointBase

CachingEndpointBase

ElementEndpoint<TEntity>

PollingEndpoint<TEntity>

Implements

ICachingEndpoint

IPollingEndpoint<TEntity>

IElementEndpoint<TEntity>

IElementEndpoint

IEndpoint

Inherited Members

ElementEndpoint<TEntity>.Response

ElementEndpoint<TEntity>.ReadAsync(CancellationToken)

ElementEndpoint<TEntity>.ExistsAsync(CancellationToken)

ElementEndpoint<TEntity>.SetAllowed

ElementEndpoint<TEntity>.SetAsync(TEntity, CancellationToken)

ElementEndpoint<TEntity>.MergeAllowed

ElementEndpoint<TEntity>.MergeAsync(TEntity, CancellationToken)

ElementEndpoint<TEntity>.DeleteAllowed

ElementEndpoint<TEntity>.DeleteAsync(CancellationToken)

ElementEndpoint<TEntity>.UpdateAsync(Action<TEntity>, int, CancellationToken)

ElementEndpoint<TEntity>.UpdateAsync(Action<JsonPatchDocument<TEntity>>, int, 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.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)

Constructors

PollingEndpoint(IEndpoint, string, Predicate<TEntity>?)

Creates a new polling endpoint.

public PollingEndpoint(IEndpoint referrer, string relativeUri, Predicate<TEntity>? endCondition = null)

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.

endCondition Predicate<TEntity>

A check to determine whether the entity has reached its final state an no further polling is required.

PollingEndpoint(IEndpoint, Uri, Predicate<TEntity>?)

Creates a new polling endpoint.

public PollingEndpoint(IEndpoint referrer, Uri relativeUri, Predicate<TEntity>? endCondition = null)

Parameters

referrer IEndpoint

The endpoint used to navigate to this one.

relativeUri Uri

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

endCondition Predicate<TEntity>

A check to determine whether the entity has reached its final state an no further polling is required.

Properties

PollingInterval

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

public TimeSpan PollingInterval { get; set; }

Property Value

TimeSpan

Methods

GetObservable()

Provides an observable stream of entity states. Compares entities using Equals(object) to detect changes.

public IObservable<TEntity> GetObservable()

Returns

IObservable<TEntity>

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

Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors.

protected override Task<HttpResponseMessage> HandleAsync(Func<Task<HttpResponseMessage>> request, string caller = "unknown")

Parameters

request Func<Task<HttpResponseMessage>>

A callback that performs the actual HTTP request.

caller string

The name of the method calling this method.

Returns

Task<HttpResponseMessage>

The resolved request.