OpenServiceBroker for .NET 0.4.3
client and a server .NET library for the Open Service Broker API specification
OpenServiceBroker.ServiceBrokerEndpointBase Class Reference

Common base class for Open Service Broker endpoints. More...

Inheritance diagram for OpenServiceBroker.ServiceBrokerEndpointBase:
TypedRest::Endpoints::EndpointBase TypedRest::Endpoints::IEndpoint OpenServiceBroker.Bindings.ServiceBindingEndpointBase OpenServiceBroker.Instances.ServiceInstanceEndpointBase< TServiceBindingEndpointInterface, TServiceBindingEndpoint > OpenServiceBroker.Bindings.ServiceBindingBlockingEndpoint OpenServiceBroker.Bindings.ServiceBindingDeferredEndpoint OpenServiceBroker.Bindings.ServiceBindingPollingEndpoint

Protected Member Functions

 ServiceBrokerEndpointBase (IEndpoint referrer, Uri relativeUri, bool acceptsIncomplete=false)
 Creates a new service endpoint. More...
Uri GetDeleteUri (string? serviceId, string? planId)
async Task< AsyncOperationParseDeferredResponseAsync (HttpResponseMessage response)
async Task< TDeferred > ParseDeferredResponseAsync< TComplete, TDeferred > (HttpResponseMessage response)
Task< T > FromContentAsync< T > (HttpResponseMessage message)
- Protected Member Functions inherited from TypedRest::Endpoints::EndpointBase
 EndpointBase (Uri uri, HttpClient httpClient, MediaTypeFormatter serializer, IErrorHandler errorHandler, ILinkExtractor linkExtractor)
 EndpointBase (IEndpoint referrer, Uri relativeUri)
 EndpointBase (IEndpoint referrer, string relativeUri)
virtual async Task< HttpResponseMessage > HandleAsync (Func< Task< HttpResponseMessage > > request,[CallerMemberName] string caller="unknown")
Activity? StartActivity ([CallerMemberName] string caller="unknown")
virtual void HandleCapabilities (HttpResponseMessage response)
bool? IsMethodAllowed (HttpMethod method)

Additional Inherited Members

- Public Member Functions inherited from TypedRest::Endpoints::EndpointBase
void SetDefaultLink (string rel, string? href)
void SetDefaultLinkTemplate (string rel, string? href)
IReadOnlyList<(Uri uri, string? title)> GetLinks (string rel)
Uri Link (string rel)
UriTemplate GetLinkTemplate (string rel)
Uri LinkTemplate (string rel, IDictionary< string, object > variables)
Uri LinkTemplate (string rel, object variables)
- Static Protected Member Functions inherited from TypedRest::Endpoints::EndpointBase
static Func< IEndpoint, Uri, TEndpoint > GetConstructor ()
- Properties inherited from TypedRest::Endpoints::IEndpoint
Uri Uri
HttpClient HttpClient
MediaTypeFormatter Serializer
IErrorHandler ErrorHandler
ILinkExtractor LinkExtractor

Detailed Description

Common base class for Open Service Broker endpoints.

Constructor & Destructor Documentation

◆ ServiceBrokerEndpointBase()

OpenServiceBroker.ServiceBrokerEndpointBase.ServiceBrokerEndpointBase ( IEndpoint  referrer,
Uri  relativeUri,
bool  acceptsIncomplete = false 

Creates a new service endpoint.

referrerThe endpoint used to navigate to this one.
relativeUriThe URI of this endpoint relative to the referrer 's. Prefix ./ to append a trailing slash to the referrer URI if missing.
acceptsIncompleteA value of true indicates that the Platform and its clients support deferred (asynchronous) Service Broker operations. If this parameter is false, and the Service Broker can only handle a request deferred (asynchronously) Errors.AsyncRequiredException is thrown.

Member Function Documentation

◆ ParseDeferredResponseAsync< TComplete, TDeferred >()

async Task< TDeferred > OpenServiceBroker.ServiceBrokerEndpointBase.ParseDeferredResponseAsync< TComplete, TDeferred > ( HttpResponseMessage  response)
Type Constraints
TComplete :class 
TComplete :IUnchangedFlag 
TDeferred :AsyncOperation 
TDeferred :ICompletableWithResult<TComplete> 
TDeferred :new() 

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