io.envoyproxy.controlplane.server

Interface DiscoveryServerCallbacks

All Known Implementing Classes:

SnapshotCollectingCallback

public interface DiscoveryServerCallbacks

DiscoveryServerCallbacks defines the callbacks that are exposed by the DiscoveryServer. The callbacks give consumers the opportunity to add their own application-specific logs/metrics based

Method Summary

Modifier and Type	Method and Description
default void	onStreamClose(long streamId, String typeUrl) onStreamClose is called just before the bi-directional gRPC stream is closed successfully for an envoy instance.
default void	onStreamCloseWithError(long streamId, String typeUrl, Throwable error) onStreamCloseWithError is called just before the bi-directional gRPC stream is closed for an envoy instance due to some error that has occurred.
default void	onStreamOpen(long streamId, String typeUrl) onStreamOpen is called when the bi-directional gRPC stream is opened for an envoy instance, before the initial DiscoveryRequest is processed.
default void	onStreamRequest(long streamId, io.envoyproxy.envoy.api.v2.DiscoveryRequest request) onStreamRequest is called for each DiscoveryRequest that is received on the stream.
default void	onStreamResponse(long streamId, io.envoyproxy.envoy.api.v2.DiscoveryRequest request, io.envoyproxy.envoy.api.v2.DiscoveryResponse response) onStreamResponse is called just before each DiscoveryResponse that is sent on the stream.

Method Detail

onStreamClose

default void onStreamClose(long streamId,
                           String typeUrl)

onStreamClose is called just before the bi-directional gRPC stream is closed successfully for an envoy instance.

Parameters:

streamId - an ID for this stream that is only unique to this discovery server instance

typeUrl - the resource type of the stream, or DiscoveryServer.ANY_TYPE_URL for ADS

onStreamCloseWithError

default void onStreamCloseWithError(long streamId,
                                    String typeUrl,
                                    Throwable error)

onStreamCloseWithError is called just before the bi-directional gRPC stream is closed for an envoy instance due to some error that has occurred.

Parameters:

streamId - an ID for this stream that is only unique to this discovery server instance

typeUrl - the resource type of the stream, or DiscoveryServer.ANY_TYPE_URL for ADS

error - the error that caused the stream to close

onStreamOpen

default void onStreamOpen(long streamId,
                          String typeUrl)

onStreamOpen is called when the bi-directional gRPC stream is opened for an envoy instance, before the initial DiscoveryRequest is processed.

Parameters:

streamId - an ID for this stream that is only unique to this discovery server instance

typeUrl - the resource type of the stream, or DiscoveryServer.ANY_TYPE_URL for ADS

onStreamRequest

default void onStreamRequest(long streamId,
                             io.envoyproxy.envoy.api.v2.DiscoveryRequest request)

onStreamRequest is called for each DiscoveryRequest that is received on the stream.

Parameters:

streamId - an ID for this stream that is only unique to this discovery server instance

request - the discovery request sent by the envoy instance

Throws:

RequestException - optionally can throw RequestException with custom status. That status will be returned to the client and the stream will be closed with error.

onStreamResponse

default void onStreamResponse(long streamId,
                              io.envoyproxy.envoy.api.v2.DiscoveryRequest request,
                              io.envoyproxy.envoy.api.v2.DiscoveryResponse response)

onStreamResponse is called just before each DiscoveryResponse that is sent on the stream.

Parameters:

streamId - an ID for this stream that is only unique to this discovery server instance

request - the discovery request sent by the envoy instance

response - the discovery response sent by the discovery server