Class Service

Inheritance
Object
Service
AcousticEventService
AudioRecordingService
AuthenticationService
MediaService
Inherited Members
Namespace: AcousticWorkbench
Assembly: AcousticWorkbench.dll
Syntax
public abstract class Service

Constructors

| Improve this Doc View Source

Service(IApi)

Declaration
protected Service(IApi api)
Parameters
Type Name Description
IApi api
| Improve this Doc View Source

Service(IAuthenticatedApi)

Declaration
protected Service(IAuthenticatedApi authenticatedApi)
Parameters
Type Name Description
IAuthenticatedApi authenticatedApi

Fields

| Improve this Doc View Source

ClientTimeout

The amount of time to wait for a request to be processed.

Declaration
public static readonly TimeSpan ClientTimeout
Field Value
Type Description
TimeSpan
Remarks

We dynamically scale this value to the number of CPU cores multiplied by 10 seconds each so that in cases where there is back pressure the async requests do not prematurely timeout. This is important because the timeout calculation for HttpClient includes the time the request is waiting to be sent as well as the total request time.

Properties

| Improve this Doc View Source

AuthenticatedApi

Declaration
protected IAuthenticatedApi AuthenticatedApi { get; }
Property Value
Type Description
IAuthenticatedApi
| Improve this Doc View Source

HttpClient

Declaration
protected HttpClient HttpClient { get; }
Property Value
Type Description
HttpClient

Methods

| Improve this Doc View Source

AddAuthTokenHeader(HttpRequestHeaders, String)

Declaration
protected static void AddAuthTokenHeader(HttpRequestHeaders headers, string token)
Parameters
Type Name Description
HttpRequestHeaders headers
String token
| Improve this Doc View Source

Deserialize<T>(String)

Declaration
protected AcousticWorkbenchResponse<T> Deserialize<T>(string json)
Parameters
Type Name Description
String json
Returns
Type Description
AcousticWorkbenchResponse<T>
Type Parameters
Name Description
T
| Improve this Doc View Source

ProcessApiResult<T>(HttpResponseMessage, String)

Declaration
protected async Task<T> ProcessApiResult<T>(HttpResponseMessage response, string requestBody = "")
Parameters
Type Name Description
HttpResponseMessage response
String requestBody
Returns
Type Description
Task<T>
Type Parameters
Name Description
T
| Improve this Doc View Source

Serialize(Object)

Declaration
protected string Serialize(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
String
| Improve this Doc View Source

SerializeContent(Object)

Declaration
protected StringContent SerializeContent(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
StringContent
| Improve this Doc View Source

SerializeContent(Object, out String)

Declaration
protected StringContent SerializeContent(object obj, out string serializedString)
Parameters
Type Name Description
Object obj
String serializedString
Returns
Type Description
StringContent

Extension Methods