xconn

Documentation

Index

• Constants
• Variables
• func Listen(ctx context.Context, network, address string, config *Config) (net.Listener, error)
• func ListenURL(ctx context.Context, listenURL *url.URL, config *Config) (net.Listener, error)
• func MayPerformXConnHandshake(Raw net.Conn) error
• func NewXDialerProtocol(UnderlyingDialer client.Protocol, XConfig *Config) client.Protocol
• type Config
  • func ConstructXConfigFromEnv(maybeFec *int, maybePrivateKey, maybeKnownPeerPubKeys *string) (*Config, bool, error)
  • func Default() *Config
  • func (x *Config) Clone() *Config
  • func (x *Config) GeneratePrivateKeyIfNotExists() error
  • func (x *Config) PublicKeyStr() string
• type Conn
  • func Client(raw net.Conn, xConfig *Config) *Conn
  • func ClientWithKnownPeer(raw net.Conn, xConfig *Config, remotePub []byte) *Conn
  • func Server(raw net.Conn, xConfig *Config) *Conn
  • func (c *Conn) Close() error
  • func (c *Conn) ConsumeBuffer(ba *bufferio.BufferArray) error
  • func (c *Conn) GetExtensionProperty() map[string]uint64
  • func (c *Conn) Handshake() error
  • func (c *Conn) IsClosed() bool
  • func (c *Conn) LocalAddr() net.Addr
  • func (c *Conn) ProduceBuffer(bs *bufferio.BufferArray, startOffset int) error
  • func (c *Conn) Read(b []byte) (int, error)
  • func (c *Conn) RemoteAddr() net.Addr
  • func (c *Conn) SetDeadline(t time.Time) error
  • func (c *Conn) SetReadDeadline(t time.Time) error
  • func (c *Conn) SetWriteDeadline(t time.Time) error
  • func (*Conn) SupportBufferIO() bool
  • func (c *Conn) SupportKeepAlive() bool
  • func (c *Conn) Write(b []byte) (int, error)
  • func (c *Conn) WriteTo(writer io.Writer) (int64, error)

Constants

const (
	PacketByteLimit = 1 << 25
)

Variables

var (
	EmbeddedPrivateKey = ""
)

Functions

func Listen

func Listen(ctx context.Context, network, address string, config *Config) (net.Listener, error)

func ListenURL

func ListenURL(ctx context.Context, listenURL *url.URL, config *Config) (net.Listener, error)

func MayPerformXConnHandshake

func MayPerformXConnHandshake(Raw net.Conn) error

func NewXDialerProtocol

func NewXDialerProtocol(UnderlyingDialer client.Protocol, XConfig *Config) client.Protocol

XConfig can be null.

Types

type Config

type Config struct {
	AuthFunc  func(string, ed25519.PublicKey) bool
	TraceFunc util.TracerFunc

	AuthPrivateKey ed25519.PrivateKey

	KeepaliveInterval          time.Duration
	HandshakeTimeout           time.Duration
	HandshakeServerAllowPublic bool
	// FECParityNum specifies the number of parity shards in every 16 packets. 0 means disabled.
	FECParityNum int

	// If enabled, a separate routine will do the actual IO.
	// This only affects the behavior of UDP connection.
	EnableAIO bool
}

func ConstructXConfigFromEnv

func ConstructXConfigFromEnv(maybeFec *int, maybePrivateKey, maybeKnownPeerPubKeys *string) (*Config, bool, error)

Return true if private key is generated at runtime. `maybeFec`, `maybePrivateKey` and `maybeKnownPeerPubKeys` can be nil.

func Default

func Default() *Config

func (*Config) Clone

func (x *Config) Clone() *Config

func (*Config) GeneratePrivateKeyIfNotExists

func (x *Config) GeneratePrivateKeyIfNotExists() error

func (*Config) PublicKeyStr

func (x *Config) PublicKeyStr() string

Automatically generates a private key if not exists, panic if cannot generate one.

type Conn

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

func Client

func Client(raw net.Conn, xConfig *Config) *Conn

func ClientWithKnownPeer

func ClientWithKnownPeer(raw net.Conn, xConfig *Config, remotePub []byte) *Conn

func Server

func Server(raw net.Conn, xConfig *Config) *Conn

func (*Conn) Close

func (c *Conn) Close() error

func (*Conn) ConsumeBuffer

func (c *Conn) ConsumeBuffer(ba *bufferio.BufferArray) error

func (*Conn) GetExtensionProperty

func (c *Conn) GetExtensionProperty() map[string]uint64

func (*Conn) Handshake

func (c *Conn) Handshake() error

func (*Conn) IsClosed

func (c *Conn) IsClosed() bool

func (*Conn) LocalAddr

func (c *Conn) LocalAddr() net.Addr

func (*Conn) ProduceBuffer

func (c *Conn) ProduceBuffer(bs *bufferio.BufferArray, startOffset int) error

func (*Conn) Read

func (c *Conn) Read(b []byte) (int, error)

func (*Conn) RemoteAddr

func (c *Conn) RemoteAddr() net.Addr

func (*Conn) SetDeadline

func (c *Conn) SetDeadline(t time.Time) error

func (*Conn) SetReadDeadline

func (c *Conn) SetReadDeadline(t time.Time) error

func (*Conn) SetWriteDeadline

func (c *Conn) SetWriteDeadline(t time.Time) error

func (*Conn) SupportBufferIO

func (*Conn) SupportBufferIO() bool

func (*Conn) SupportKeepAlive

func (c *Conn) SupportKeepAlive() bool

func (*Conn) Write

func (c *Conn) Write(b []byte) (int, error)

func (*Conn) WriteTo

func (c *Conn) WriteTo(writer io.Writer) (int64, error)