istio.io/istio@v0.0.0-20240520182934-d79c90f27776/pilot/pkg/xds/eventhandler.go (about)

     1  // Copyright Istio Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package xds
    16  
    17  import (
    18  	v3 "istio.io/istio/pilot/pkg/xds/v3"
    19  	"istio.io/istio/pkg/util/sets"
    20  )
    21  
    22  // EventType represents the type of object we are tracking, mapping to envoy TypeUrl.
    23  type EventType = string
    24  
    25  var AllTrackingEventTypes = sets.New[EventType](
    26  	v3.ClusterType,
    27  	v3.ListenerType,
    28  	v3.RouteType,
    29  	v3.EndpointType,
    30  )
    31  
    32  // EventHandler allows for generic monitoring of xDS ACKS and disconnects, for the purpose of tracking
    33  // Config distribution through the mesh.
    34  type DistributionStatusCache interface {
    35  	// RegisterEvent notifies the implementer of an xDS ACK, and must be non-blocking
    36  	RegisterEvent(conID string, eventType EventType, nonce string)
    37  	RegisterDisconnect(s string, types sets.Set[EventType])
    38  	QueryLastNonce(conID string, eventType EventType) (noncePrefix string)
    39  }