connpool.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 remote

import (
	"context"
	"net"
	"time"
)

// ConnOption contains configurations for connection pool.
type ConnOption struct {
	Dialer         Dialer
	ConnectTimeout time.Duration
}

// ConnPool is used to get connections.
type ConnPool interface {
	// Get returns a connection to the given address.
	Get(ctx context.Context, network, address string, opt ConnOption) (net.Conn, error)

	// Put puts the connection back to pool.
	// Note that the Close method of conn may already be invoked.
	Put(conn net.Conn) error

	// Discard discards the connection rather than putting it to the pool.
	Discard(conn net.Conn) error

	// Close is to release resource of ConnPool, it is executed when client is closed.
	Close() error
}

// LongConnPool supports Clean connections to a desired address.
type LongConnPool interface {
	ConnPool

	// Clean the state maintained in the poor for this address
	Clean(network, address string)
}

// ConnPoolReporter is used to enable reporter.
type ConnPoolReporter interface {
	EnableReporter()
}

// RawConn is used to get the raw connection.
type RawConn interface {
	RawConn() net.Conn
}

// IsActive is used to check if the connection is active.
type IsActive interface {
	IsActive() bool
}