Class HystrixCollapser<BatchReturnType, RequestResponseType, RequestArgumentType>

Inheritance

System.Object

HysrixCollapserBase

HystrixCollapser<BatchReturnType, RequestResponseType, RequestArgumentType>

Implements

IHystrixExecutable<RequestResponseType>

IHystrixObservable<RequestResponseType>

IHystrixInvokable

Inherited Members

HysrixCollapserBase._defaultNameCache

Namespace: Steeltoe.CircuitBreaker.Hystrix

Assembly: Steeltoe.CircuitBreaker.HystrixBase.dll

Syntax

public abstract class HystrixCollapser<BatchReturnType, RequestResponseType, RequestArgumentType> : HysrixCollapserBase, IHystrixExecutable<RequestResponseType>, IHystrixObservable<RequestResponseType>, IHystrixInvokable

Type Parameters

Name	Description
BatchReturnType
RequestResponseType
RequestArgumentType

Constructors

| Edit this page View Source

HystrixCollapser()

Declaration

protected HystrixCollapser()

| Edit this page View Source

HystrixCollapser(IHystrixCollapserKey)

Declaration

protected HystrixCollapser(IHystrixCollapserKey collapserKey)

Parameters

Type	Name	Description
IHystrixCollapserKey	collapserKey

| Edit this page View Source

HystrixCollapser(IHystrixCollapserKey, RequestCollapserScope)

Declaration

protected HystrixCollapser(IHystrixCollapserKey collapserKey, RequestCollapserScope scope)

Parameters

Type	Name	Description
IHystrixCollapserKey	collapserKey
RequestCollapserScope	scope

| Edit this page View Source

HystrixCollapser(IHystrixCollapserKey, RequestCollapserScope, ICollapserTimer, IHystrixCollapserOptions)

Declaration

protected HystrixCollapser(IHystrixCollapserKey collapserKey, RequestCollapserScope scope, ICollapserTimer timer, IHystrixCollapserOptions options)

Parameters

Type	Name	Description
IHystrixCollapserKey	collapserKey
RequestCollapserScope	scope
ICollapserTimer	timer
IHystrixCollapserOptions	options

| Edit this page View Source

HystrixCollapser(IHystrixCollapserKey, RequestCollapserScope, ICollapserTimer, IHystrixCollapserOptions, HystrixCollapserMetrics)

Declaration

protected HystrixCollapser(IHystrixCollapserKey collapserKey, RequestCollapserScope scope, ICollapserTimer timer, IHystrixCollapserOptions optionsDefault, HystrixCollapserMetrics metrics)

Parameters

Type	Name	Description
IHystrixCollapserKey	collapserKey
RequestCollapserScope	scope
ICollapserTimer	timer
IHystrixCollapserOptions	optionsDefault
HystrixCollapserMetrics	metrics

| Edit this page View Source

HystrixCollapser(IHystrixCollapserOptions)

Declaration

protected HystrixCollapser(IHystrixCollapserOptions options)

Parameters

Type	Name	Description
IHystrixCollapserOptions	options

Fields

| Edit this page View Source

_token

Declaration

protected CancellationToken _token

Field Value

Type	Description
CancellationToken

Properties

| Edit this page View Source

CacheKey

Declaration

protected virtual string CacheKey { get; }

Property Value

Type	Description
System.String

| Edit this page View Source

CollapserKey

Declaration

public virtual IHystrixCollapserKey CollapserKey { get; }

Property Value

Type	Description
IHystrixCollapserKey

| Edit this page View Source

Metrics

Declaration

public virtual HystrixCollapserMetrics Metrics { get; }

Property Value

Type	Description
HystrixCollapserMetrics

| Edit this page View Source

RequestArgument

Declaration

public abstract RequestArgumentType RequestArgument { get; }

Property Value

Type	Description
RequestArgumentType

| Edit this page View Source

Scope

Declaration

public virtual RequestCollapserScope Scope { get; }

Property Value

Type	Description
RequestCollapserScope

Methods

| Edit this page View Source

AddCacheEntryIfAbsent(String, out HystrixCachedTask<RequestResponseType>)

Declaration

protected bool AddCacheEntryIfAbsent(string cacheKey, out HystrixCachedTask<RequestResponseType> entry)

Parameters

Type	Name	Description
System.String	cacheKey
HystrixCachedTask<RequestResponseType>	entry

Returns

Type	Description
System.Boolean

| Edit this page View Source

CreateCommand(ICollection<ICollapsedRequest<RequestResponseType, RequestArgumentType>>)

Declaration

protected abstract HystrixCommand<BatchReturnType> CreateCommand(ICollection<ICollapsedRequest<RequestResponseType, RequestArgumentType>> requests)

Parameters

Type	Name	Description
ICollection<ICollapsedRequest<RequestResponseType, RequestArgumentType>>	requests

Returns

Type	Description
HystrixCommand<BatchReturnType>

| Edit this page View Source

DecomposeException(Exception)

Declaration

protected virtual Exception DecomposeException(Exception e)

Parameters

Type	Name	Description
Exception	e

Returns

Type	Description
Exception

| Edit this page View Source

Execute()

Declaration

public RequestResponseType Execute()

Returns

Type	Description
RequestResponseType

| Edit this page View Source

ExecuteAsync()

Declaration

public Task<RequestResponseType> ExecuteAsync()

Returns

Type	Description
Task<RequestResponseType>

| Edit this page View Source

ExecuteAsync(CancellationToken)

Declaration

public Task<RequestResponseType> ExecuteAsync(CancellationToken token)

Parameters

Type	Name	Description
CancellationToken	token

Returns

Type	Description
Task<RequestResponseType>

| Edit this page View Source

MapResponseToRequests(BatchReturnType, ICollection<ICollapsedRequest<RequestResponseType, RequestArgumentType>>)

Declaration

protected abstract void MapResponseToRequests(BatchReturnType batchResponse, ICollection<ICollapsedRequest<RequestResponseType, RequestArgumentType>> requests)

Parameters

Type	Name	Description
BatchReturnType	batchResponse
ICollection<ICollapsedRequest<RequestResponseType, RequestArgumentType>>	requests

| Edit this page View Source

Observe()

Declaration

public IObservable<RequestResponseType> Observe()

Returns

Type	Description
IObservable<RequestResponseType>

| Edit this page View Source

Observe(CancellationToken)

Declaration

public IObservable<RequestResponseType> Observe(CancellationToken token)

Parameters

Type	Name	Description
CancellationToken	token

Returns

Type	Description
IObservable<RequestResponseType>

| Edit this page View Source

ShardRequests(ICollection<ICollapsedRequest<RequestResponseType, RequestArgumentType>>)

Declaration

protected virtual ICollection<ICollection<ICollapsedRequest<RequestResponseType, RequestArgumentType>>> ShardRequests(ICollection<ICollapsedRequest<RequestResponseType, RequestArgumentType>> requests)

Parameters

Type	Name	Description
ICollection<ICollapsedRequest<RequestResponseType, RequestArgumentType>>	requests

Returns

Type	Description
ICollection<ICollection<ICollapsedRequest<RequestResponseType, RequestArgumentType>>>

| Edit this page View Source

ToObservable()

Declaration

public IObservable<RequestResponseType> ToObservable()

Returns

Type	Description
IObservable<RequestResponseType>

| Edit this page View Source

ToTask()

Declaration

public Task<RequestResponseType> ToTask()

Returns

Type	Description
Task<RequestResponseType>

Implements

IHystrixExecutable<TResult>

IHystrixObservable<TResult>

IHystrixInvokable