blob: 9c13f53debab52d3af7896873b937d680489c2b2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
import { SubchannelRef } from './channelz';
import { ConnectivityState } from './connectivity-state';
import { Subchannel } from './subchannel';
export type ConnectivityStateListener = (subchannel: SubchannelInterface, previousState: ConnectivityState, newState: ConnectivityState, keepaliveTime: number, errorMessage?: string) => void;
/**
* This is an interface for load balancing policies to use to interact with
* subchannels. This allows load balancing policies to wrap and unwrap
* subchannels.
*
* Any load balancing policy that wraps subchannels must unwrap the subchannel
* in the picker, so that other load balancing policies consistently have
* access to their own wrapper objects.
*/
export interface SubchannelInterface {
getConnectivityState(): ConnectivityState;
addConnectivityStateListener(listener: ConnectivityStateListener): void;
removeConnectivityStateListener(listener: ConnectivityStateListener): void;
startConnecting(): void;
getAddress(): string;
throttleKeepalive(newKeepaliveTime: number): void;
ref(): void;
unref(): void;
getChannelzRef(): SubchannelRef;
/**
* If this is a wrapper, return the wrapped subchannel, otherwise return this
*/
getRealSubchannel(): Subchannel;
/**
* Returns true if this and other both proxy the same underlying subchannel.
* Can be used instead of directly accessing getRealSubchannel to allow mocks
* to avoid implementing getRealSubchannel
*/
realSubchannelEquals(other: SubchannelInterface): boolean;
}
export declare abstract class BaseSubchannelWrapper implements SubchannelInterface {
protected child: SubchannelInterface;
constructor(child: SubchannelInterface);
getConnectivityState(): ConnectivityState;
addConnectivityStateListener(listener: ConnectivityStateListener): void;
removeConnectivityStateListener(listener: ConnectivityStateListener): void;
startConnecting(): void;
getAddress(): string;
throttleKeepalive(newKeepaliveTime: number): void;
ref(): void;
unref(): void;
getChannelzRef(): SubchannelRef;
getRealSubchannel(): Subchannel;
realSubchannelEquals(other: SubchannelInterface): boolean;
}
|