reporter.go

/*
 * Copyright 2021 CloudWeGo Authors
 *
 * Licensed 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 connpool

import (
	"net"
	"sync"
)

var (
	isSet          bool
	rwLock         sync.RWMutex
	commonReporter Reporter = &DummyReporter{}
)

// ConnectionPoolType is the type of connection pool.
type ConnectionPoolType int8

// Short and Long flags define which indicates type of connection pool..
const (
	Short ConnectionPoolType = iota
	Long
)

// Reporter report status of connection pool.
type Reporter interface {
	ConnSucceed(poolType ConnectionPoolType, serviceName string, addr net.Addr)
	ConnFailed(poolType ConnectionPoolType, serviceName string, addr net.Addr)
	ReuseSucceed(poolType ConnectionPoolType, serviceName string, addr net.Addr)
}

// SetReporter set the common reporter of connection pool, that can only be set once.
func SetReporter(r Reporter) {
	rwLock.Lock()
	defer rwLock.Unlock()
	if !isSet {
		isSet = true
		commonReporter = r
	}
}

// GetCommonReporter returns the current Reporter used by connection pools.
func GetCommonReporter() Reporter {
	rwLock.RLock()
	defer rwLock.RUnlock()
	return commonReporter
}