...

Source file src/github.com/chaos-mesh/chaos-mesh/pkg/router/endpoint/endpoint.go

Documentation: github.com/chaos-mesh/chaos-mesh/pkg/router/endpoint

     1  // Copyright 2020 Chaos Mesh 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  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package endpoint
    15  
    16  import (
    17  	"context"
    18  
    19  	ctrl "sigs.k8s.io/controller-runtime"
    20  
    21  	"github.com/chaos-mesh/chaos-mesh/api/v1alpha1"
    22  	ctx "github.com/chaos-mesh/chaos-mesh/pkg/router/context"
    23  )
    24  
    25  // Endpoint is interface for reconciler
    26  type Endpoint interface {
    27  	// Apply means the reconciler perform the chaos action
    28  	Apply(ctx context.Context, req ctrl.Request, chaos v1alpha1.InnerObject) error
    29  
    30  	// Recover means the reconciler recovers the chaos action
    31  	Recover(ctx context.Context, req ctrl.Request, chaos v1alpha1.InnerObject) error
    32  
    33  	// Object would return the instance of chaos
    34  	Object() v1alpha1.InnerObject
    35  }
    36  
    37  // NewEndpoint represents a function who creates a new reconciler
    38  type NewEndpoint func(ctx ctx.Context) Endpoint
    39