client

Documentation

Index

• type Client
  • func New(cfg config.Client, l logger.Logger) Client
• type Inbound
  • func NewInbound(cfg config.Client, l logger.Logger) (in *Inbound, err error)
  • func (in *Inbound) Establish()
• type Outbound
  • func NewOutbound(cfg config.Client, l logger.Logger) *Outbound
  • func (out *Outbound) Establish() error

Types

type Client

type Client interface {
	Dial() error
}

A Client dials a server for running Seikan's tunnels.

func New

func New(cfg config.Client, l logger.Logger) Client

New returns a new Client.

type Inbound

type Inbound struct {
	// contains filtered or unexported fields
}

Inbound handles server to client tunneling.

func NewInbound

func NewInbound(cfg config.Client, l logger.Logger) (in *Inbound, err error)

NewInbound returns a new Inbound.

func (*Inbound) Establish

func (in *Inbound) Establish()

Establish establishes the client's tunnels. It retries in case of error.

type Outbound

type Outbound struct {
	// contains filtered or unexported fields
}

Outbound handles client to server tunneling.

func NewOutbound

func NewOutbound(cfg config.Client, l logger.Logger) *Outbound

NewOutbound returns a new Outbound.

func (*Outbound) Establish

func (out *Outbound) Establish() error

Establish establishes the tunnel. It retries in case of error.