50 lines
2.2 KiB
TypeScript
50 lines
2.2 KiB
TypeScript
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;
|
|
}
|