OpenServiceBroker for .NET 0.4.3
client and a server .NET library for the Open Service Broker API specification
OpenServiceBroker.BrokerControllerBase< TBlocking, TDeferred > Class Template Reference

Common base class for Open Service Broker API controllers. More...

Inheritance diagram for OpenServiceBroker.BrokerControllerBase< TBlocking, TDeferred >:

Protected Member Functions

 BrokerControllerBase (IServiceProvider provider)
 
async Task< IActionResult > Do (bool acceptsIncomplete, Func< TBlocking, Task< IActionResult > > blocking, Func< TDeferred, Task< IActionResult > > deferred)
 Performs either a blocking or a deferred operation, handling aspects such as API versioning and error serialization. More...
 
new OkObjectResult Ok ()
 Creates an OK response with an empty JSON object in the body.
 

Properties

static ApiVersion SupportedApiVersion [get]
 The latest Open Service Broker API version currently supported.
 
OriginatingIdentity??? OriginatingIdentity [get]
 Describes the identity of the user that initiated a request from the Platform.
 

Detailed Description

Common base class for Open Service Broker API controllers.

Template Parameters
TBlockingThe service type to request from dependency injection for blocking operations.
TDeferredThe service type to request from dependency injection for deferred (asynchronous) operations.

Member Function Documentation

◆ Do()

async Task< IActionResult > OpenServiceBroker.BrokerControllerBase< TBlocking, TDeferred >.Do ( bool  acceptsIncomplete,
Func< TBlocking, Task< IActionResult > >  blocking,
Func< TDeferred, Task< IActionResult > >  deferred 
)
inlineprotected

Performs either a blocking or a deferred operation, handling aspects such as API versioning and error serialization.

Parameters
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.
blockingA callback to invoke for blocking operations.
deferredA callback to invoke for deferred (asynchronous) operations.
Returns

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