conn

Documentation

Index

• type AddrDialFunc
• type Link
• type Opts
  • func (m *Opts) CloneMessageVT() protobuf_go_lite.CloneMessage
  • func (m *Opts) CloneVT() *Opts
  • func (this *Opts) EqualMessageVT(thatMsg any) bool
  • func (this *Opts) EqualVT(that *Opts) bool
  • func (x *Opts) GetBufSize() uint32
  • func (x *Opts) GetMtu() uint32
  • func (x *Opts) GetQuic() *quic.Opts
  • func (x *Opts) GetVerbose() bool
  • func (x *Opts) MarshalJSON() ([]byte, error)
  • func (x *Opts) MarshalProtoJSON(s *json.MarshalState)
  • func (x *Opts) MarshalProtoText() string
  • func (m *Opts) MarshalToSizedBufferVT(dAtA []byte) (int, error)
  • func (m *Opts) MarshalToVT(dAtA []byte) (int, error)
  • func (m *Opts) MarshalVT() (dAtA []byte, err error)
  • func (*Opts) ProtoMessage()
  • func (x *Opts) Reset()
  • func (m *Opts) SizeVT() (n int)
  • func (x *Opts) String() string
  • func (x *Opts) UnmarshalJSON(b []byte) error
  • func (x *Opts) UnmarshalProtoJSON(s *json.UnmarshalState)
  • func (m *Opts) UnmarshalVT(dAtA []byte) error
• type Transport
  • func NewTransport(ctx context.Context, le *logrus.Entry, privKey crypto.PrivKey, ...) (*Transport, error)
  • func (t *Transport) HandleConn(ctx context.Context, dial bool, c io.ReadWriteCloser, raddr net.Addr, ...) (*Link, error)

Types

type AddrDialFunc

type AddrDialFunc func(ctx context.Context, addr string) (io.ReadWriteCloser, net.Addr, error)

AddrDialFunc dials an address.

type Link

type Link = transport_quic.Link

Link is a Quic-based connection/link backed by a Conn.

type Opts

type Opts struct {

	// Quic are the quic protocol options.
	Quic *quic.Opts `protobuf:"bytes,1,opt,name=quic,proto3" json:"quic,omitempty"`
	// Verbose turns on verbose debug logging.
	Verbose bool `protobuf:"varint,2,opt,name=verbose,proto3" json:"verbose,omitempty"`
	// Mtu sets the maximum size for a single packet.
	// Defaults to 65000.
	Mtu uint32 `protobuf:"varint,3,opt,name=mtu,proto3" json:"mtu,omitempty"`
	// BufSize is the number of packets to buffer.
	//
	// Total memory cap is mtu * bufSize.
	// Defaults to 10.
	BufSize uint32 `protobuf:"varint,4,opt,name=buf_size,json=bufSize,proto3" json:"bufSize,omitempty"`
	// contains filtered or unexported fields
}

Opts are extra options for the conn.

func (*Opts) CloneMessageVT

func (m *Opts) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Opts) CloneVT

func (m *Opts) CloneVT() *Opts

func (*Opts) EqualMessageVT

func (this *Opts) EqualMessageVT(thatMsg any) bool

func (*Opts) EqualVT

func (this *Opts) EqualVT(that *Opts) bool

func (*Opts) GetBufSize

func (x *Opts) GetBufSize() uint32

func (*Opts) GetMtu

func (x *Opts) GetMtu() uint32

func (*Opts) GetQuic

func (x *Opts) GetQuic() *quic.Opts

func (*Opts) GetVerbose

func (x *Opts) GetVerbose() bool

func (*Opts) MarshalJSON

func (x *Opts) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Opts to JSON.

func (*Opts) MarshalProtoJSON

func (x *Opts) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Opts message to JSON.

func (*Opts) MarshalProtoText

func (x *Opts) MarshalProtoText() string

func (*Opts) MarshalToSizedBufferVT

func (m *Opts) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Opts) MarshalToVT

func (m *Opts) MarshalToVT(dAtA []byte) (int, error)

func (*Opts) MarshalVT

func (m *Opts) MarshalVT() (dAtA []byte, err error)

func (*Opts) ProtoMessage

func (*Opts) ProtoMessage()

func (*Opts) Reset

func (x *Opts) Reset()

func (*Opts) SizeVT

func (m *Opts) SizeVT() (n int)

func (*Opts) String

func (x *Opts) String() string

func (*Opts) UnmarshalJSON

func (x *Opts) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Opts from JSON.

func (*Opts) UnmarshalProtoJSON

func (x *Opts) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Opts message from JSON.

func (*Opts) UnmarshalVT

func (m *Opts) UnmarshalVT(dAtA []byte) error

type Transport

type Transport struct {
	// Transport is the underlying quic transport
	*transport_quic.Transport
	// contains filtered or unexported fields
}

Transport implements a Bifrost transport with ordered conns.

An example is a TCP connection: the OS provides an ordered stream of data as the interface for the Go program to use.

func NewTransport

func NewTransport(
	ctx context.Context,
	le *logrus.Entry,
	privKey crypto.PrivKey,
	tc transport.TransportHandler,
	opts *Opts,

	uuid uint64,

	laddr net.Addr,

	addrDialer AddrDialFunc,
) (*Transport, error)

NewTransport constructs a new conn-backed transport.

addrDialer is an optional function to enable dialing out.

func (*Transport) HandleConn

func (t *Transport) HandleConn(
	ctx context.Context,
	dial bool,
	c io.ReadWriteCloser,
	raddr net.Addr,
	peerID peer.ID,
) (*Link, error)

HandleConn handles an incoming or outgoing connection.

dial indicates if this is the originator (outgoing) conn or not ctx is used for the negotiation phase only if peerID is empty, allows any peer ID on the other end raddr can be nil if peerID is NOT empty