TypedRest for .NET 1.3.5
build type-safe fluent-style REST API clients
TypedRest.Endpoints.Reactive.StreamingEndpoint< TEntity > Class Template Reference

Endpoint for a stream of TEntity s using a persistent HTTP connection. More...

Inheritance diagram for TypedRest.Endpoints.Reactive.StreamingEndpoint< TEntity >:
TypedRest.Endpoints.EndpointBase TypedRest.Endpoints.Reactive.IStreamingEndpoint< TEntity > TypedRest.Endpoints.IEndpoint

Public Member Functions

 StreamingEndpoint (IEndpoint referrer, Uri relativeUri, string separator="\n")
 Creates a new streaming endpoint. More...
 
 StreamingEndpoint (IEndpoint referrer, string relativeUri, string separator="\n")
 Creates a new streaming endpoint. More...
 
virtual IObservable< TEntity > GetObservable ()
 
- Public Member Functions inherited from TypedRest.Endpoints.EndpointBase
void SetDefaultLink (string rel, string? href)
 Registers one or more default links for a specific relation type. These links are used when no links with this relation type are provided by the server. This should only be called during initial setup of the endpoint. More...
 
void SetDefaultLinkTemplate (string rel, string? href)
 Registers a default link template for a specific relation type. This template is used when no template with this relation type is provided by the server. This should only be called during initial setup of the endpoint. More...
 
IReadOnlyList<(Uri uri, string? title)> GetLinks (string rel)
 Resolves all links with a specific relation type. Uses cached data from last response. More...
 
Uri Link (string rel)
 Resolves a single link with a specific relation type. Uses cached data from last response if possible. Tries lazy lookup with HTTP HEAD on cache miss. More...
 
UriTemplate GetLinkTemplate (string rel)
 Retrieves a link template with a specific relation type. Prefer IEndpoint.LinkTemplate(string,object) when possible. More...
 
Uri LinkTemplate (string rel, IDictionary< string, object > variables)
 Resolves a link template with a specific relation type. Uses cached data from last response if possible. Tries lazy lookup with HTTP HEAD on cache miss. More...
 
Uri LinkTemplate (string rel, object variables)
 Resolves a link template with a specific relation type. More...
 
override string ToString ()
 
- Public Member Functions inherited from TypedRest.Endpoints.Reactive.IStreamingEndpoint< TEntity >
IObservable< TEntity > GetObservable ()
 Provides an observable stream of entities. The observable is cold; HTTP communication only starts on IObservable<T>.Subscribe.
 

Properties

int BufferSize = 64 * 1024 [getset]
 The size of the buffer used to collect data for deserialization in bytes.
 
- Properties inherited from TypedRest.Endpoints.EndpointBase
Uri Uri [get]
 
HttpClient HttpClient [get]
 
MediaTypeFormatter Serializer [get]
 
IErrorHandler ErrorHandler [get]
 
ILinkExtractor LinkExtractor [get]
 
- Properties inherited from TypedRest.Endpoints.IEndpoint
Uri Uri [get]
 The HTTP URI of the remote resource.
 
HttpClient HttpClient [get]
 The HTTP client used to communicate with the remote resource.
 
MediaTypeFormatter Serializer [get]
 Controls the serialization of entities sent to and received from the server.
 
IErrorHandler ErrorHandler [get]
 Handles errors in responses.
 
ILinkExtractor LinkExtractor [get]
 Extracts links from responses.
 

Additional Inherited Members

- Protected Member Functions inherited from TypedRest.Endpoints.EndpointBase
 EndpointBase (Uri uri, HttpClient httpClient, MediaTypeFormatter serializer, IErrorHandler errorHandler, ILinkExtractor linkExtractor)
 Creates a new endpoint with an absolute URI. More...
 
 EndpointBase (IEndpoint referrer, Uri relativeUri)
 Creates a new endpoint with a relative URI. More...
 
 EndpointBase (IEndpoint referrer, string relativeUri)
 Creates a new endpoint with a relative URI. More...
 
virtual async Task< HttpResponseMessage > HandleAsync (Func< Task< HttpResponseMessage > > request, [CallerMemberName] string caller="unknown")
 Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors. More...
 
Activity? StartActivity ([CallerMemberName] string caller="unknown")
 Starts a new Activity if there is any listener registered (e.g. OpenTelemetry), returns null otherwise. More...
 
virtual void HandleCapabilities (HttpResponseMessage response)
 Handles allowed HTTP methods and other capabilities reported by the server. More...
 
bool? IsMethodAllowed (HttpMethod method)
 Shows whether the server has indicated that a specific HTTP method is currently allowed. More...
 
- Static Protected Member Functions inherited from TypedRest.Endpoints.EndpointBase
static Func< IEndpoint, Uri, TEndpoint > GetConstructor< TEndpoint > ()
 Returns a constructor for TEndpoint as a function with a referrer an a relative URI as input. More...
 

Detailed Description

Endpoint for a stream of TEntity s using a persistent HTTP connection.

Template Parameters
TEntityThe type of individual elements in the stream.

Constructor & Destructor Documentation

◆ StreamingEndpoint() [1/2]

TypedRest.Endpoints.Reactive.StreamingEndpoint< TEntity >.StreamingEndpoint ( IEndpoint  referrer,
Uri  relativeUri,
string  separator = "\n" 
)
inline

Creates a new streaming endpoint.

Parameters
referrerThe endpoint used to navigate to this one.
relativeUriThe URI of this endpoint relative to the referrer 's.
separatorThe character sequence used to detect that a new element starts in an HTTP stream.

◆ StreamingEndpoint() [2/2]

TypedRest.Endpoints.Reactive.StreamingEndpoint< TEntity >.StreamingEndpoint ( IEndpoint  referrer,
string  relativeUri,
string  separator = "\n" 
)
inline

Creates a new streaming endpoint.

Parameters
referrerThe endpoint used to navigate to this one.
relativeUriThe URI of this endpoint relative to the referrer 's. Add a ./ prefix here to imply a trailing slash referrer 's URI.
separatorThe character sequence used to detect that a new element starts in an HTTP stream.

The documentation for this class was generated from the following file: