blob: cc19c22c4a27a1bcec14df59921d1b9b1745db17 (
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
/*
* Copyright 2022 gRPC authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
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 abstract class BaseSubchannelWrapper implements SubchannelInterface {
constructor(protected child: SubchannelInterface) {}
getConnectivityState(): ConnectivityState {
return this.child.getConnectivityState();
}
addConnectivityStateListener(listener: ConnectivityStateListener): void {
this.child.addConnectivityStateListener(listener);
}
removeConnectivityStateListener(listener: ConnectivityStateListener): void {
this.child.removeConnectivityStateListener(listener);
}
startConnecting(): void {
this.child.startConnecting();
}
getAddress(): string {
return this.child.getAddress();
}
throttleKeepalive(newKeepaliveTime: number): void {
this.child.throttleKeepalive(newKeepaliveTime);
}
ref(): void {
this.child.ref();
}
unref(): void {
this.child.unref();
}
getChannelzRef(): SubchannelRef {
return this.child.getChannelzRef();
}
getRealSubchannel(): Subchannel {
return this.child.getRealSubchannel();
}
realSubchannelEquals(other: SubchannelInterface): boolean {
return this.getRealSubchannel() === other.getRealSubchannel();
}
}
|
