github.com/cloudwego/hertz@v0.9.3/pkg/network/dialer.go (about)

     1  /*
     2   * Copyright 2022 CloudWeGo Authors
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *     http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  package network
    18  
    19  import (
    20  	"crypto/tls"
    21  	"net"
    22  	"time"
    23  )
    24  
    25  type Dialer interface {
    26  	// DialConnection is used to dial the peer end.
    27  	DialConnection(network, address string, timeout time.Duration, tlsConfig *tls.Config) (conn Conn, err error)
    28  
    29  	// DialTimeout is used to dial the peer end with a timeout.
    30  	//
    31  	// NOTE: Not recommended to use this function. Just for compatibility.
    32  	DialTimeout(network, address string, timeout time.Duration, tlsConfig *tls.Config) (conn net.Conn, err error)
    33  
    34  	// AddTLS will transfer a common connection to a tls connection.
    35  	AddTLS(conn Conn, tlsConfig *tls.Config) (Conn, error)
    36  }