client

Documentation

Index

• Constants
• type Tunnel
  • func CreateSingleUseGrpcTunnel(address string, opts ...grpc.DialOption) (Tunnel, error)

Constants

const CloseTimeout = 10 * time.Second

CloseTimeout is the timeout to wait CLOSE_RSP packet after a successful delivery of CLOSE_REQ.

Types

type Tunnel

type Tunnel interface {
	// Dial connects to the address on the named network, similar to
	// what net.Dial does. The only supported protocol is tcp.
	Dial(protocol, address string) (net.Conn, error)
}

Tunnel provides ability to dial a connection through a tunnel.

func CreateSingleUseGrpcTunnel

func CreateSingleUseGrpcTunnel(address string, opts ...grpc.DialOption) (Tunnel, error)

CreateSingleUseGrpcTunnel creates a Tunnel to dial to a remote server through a gRPC based proxy service. Currently, a single tunnel supports a single connection, and the tunnel is closed when the connection is terminated The Dial() method of the returned tunnel should only be called once