tcp

Documentation

Index

• func ReuseportIsAvailable() bool
• type Option
  • func DisableReuseport() Option
  • func WithConnectionTimeout(d time.Duration) Option
  • func WithMetrics() Option
• type TcpTransport
  • func NewTCPTransport(upgrader transport.Upgrader, rcmgr network.ResourceManager, opts ...Option) (*TcpTransport, error)
  • func (t *TcpTransport) CanDial(addr ma.Multiaddr) bool
  • func (t *TcpTransport) Dial(ctx context.Context, raddr ma.Multiaddr, p peer.ID) (transport.CapableConn, error)
  • func (t *TcpTransport) DialWithUpdates(ctx context.Context, raddr ma.Multiaddr, p peer.ID, ...) (transport.CapableConn, error)
  • func (t *TcpTransport) Listen(laddr ma.Multiaddr) (transport.Listener, error)
  • func (t *TcpTransport) Protocols() []int
  • func (t *TcpTransport) Proxy() bool
  • func (t *TcpTransport) String() string
  • func (t *TcpTransport) UseReuseport() bool

Functions

func ReuseportIsAvailable

func ReuseportIsAvailable() bool

ReuseportIsAvailable returns whether reuseport is available to be used. This is here because we want to be able to turn reuseport on and off selectively. For now we use an ENV variable, as this handles our pressing need:

LIBP2P_TCP_REUSEPORT=false ipfs daemon

If this becomes a sought after feature, we could add this to the config. In the end, reuseport is a stop-gap.

Types

type Option

type Option func(*TcpTransport) error

func DisableReuseport

func DisableReuseport() Option

func WithConnectionTimeout

func WithConnectionTimeout(d time.Duration) Option

func WithMetrics

func WithMetrics() Option

type TcpTransport

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

TcpTransport is the TCP transport.

func NewTCPTransport

func NewTCPTransport(upgrader transport.Upgrader, rcmgr network.ResourceManager, opts ...Option) (*TcpTransport, error)

NewTCPTransport creates a tcp transport object that tracks dialers and listeners created. It represents an entire TCP stack (though it might not necessarily be).

func (*TcpTransport) CanDial

func (t *TcpTransport) CanDial(addr ma.Multiaddr) bool

CanDial returns true if this transport believes it can dial the given multiaddr.

func (*TcpTransport) Dial

func (t *TcpTransport) Dial(ctx context.Context, raddr ma.Multiaddr, p peer.ID) (transport.CapableConn, error)

Dial dials the peer at the remote address.

func (*TcpTransport) DialWithUpdates

func (t *TcpTransport) DialWithUpdates(ctx context.Context, raddr ma.Multiaddr, p peer.ID, updateChan chan<- transport.DialUpdate) (transport.CapableConn, error)

func (*TcpTransport) Listen

func (t *TcpTransport) Listen(laddr ma.Multiaddr) (transport.Listener, error)

Listen listens on the given multiaddr.

func (*TcpTransport) Protocols

func (t *TcpTransport) Protocols() []int

Protocols returns the list of terminal protocols this transport can dial.

func (*TcpTransport) Proxy

func (t *TcpTransport) Proxy() bool

Proxy always returns false for the TCP transport.

func (*TcpTransport) String

func (t *TcpTransport) String() string

func (*TcpTransport) UseReuseport

func (t *TcpTransport) UseReuseport() bool

UseReuseport returns true if reuseport is enabled and available.