rejected_execution_handler.go

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

package filter

import (
	"dubbo.apache.org/dubbo-go/v3/common"
	"dubbo.apache.org/dubbo-go/v3/protocol"
)

// RejectedExecutionHandler is the interface which defines the handler to handle exceptions from invoking filters.
// If the invocation cannot pass any validation in filter, like ExecuteLimitFilter and TpsLimitFilter,
// the implementation will be used. The common case is that sometimes you want to return the default
// value when the request was rejected.  Or you want to be warned if any request was rejected.
// In such situation, implement this interface and register it by invoking extension.SetRejectedExecutionHandler.
//
// RejectedExecution method will be called if the invocation was rejected by some component.
type RejectedExecutionHandler interface {
	RejectedExecution(url *common.URL, invocation protocol.Invocation) protocol.Result
}