Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

relay

package

Go to main page

Versions in this module

v1

v1.3.1

Dec 27, 2023

v1.3.0

Dec 23, 2022

v1.1.2

Mar 29, 2024

v1.1.1

Feb 20, 2023

v1.1.0

Sep 5, 2022

Changes in this version

+ const Relay_Protocol_ID

+ var HopConnectTimeout = 30 * time.Second

+ var HopStreamLimit = 1 << 19

+ var OptActive = RelayOpt(0)

+ var OptHop = RelayOpt(1)

+ var RelayAcceptTimeout = 10 * time.Second

+ var StopHandshakeTimeout = 1 * time.Minute

+ func GetRelayAddrAndDstPeerAddr(addr ma.Multiaddr) (relayAddr, dstAddr ma.Multiaddr, err error)

+ func IsRelayAddr(addr ma.Multiaddr) bool

+ func PeerInfoToRelayPeer(peerId peer.ID, peerAddr []ma.Multiaddr) *pb.RelayMsg_Peer

+ func ReadRelayMsg(stream network.Stream) (*pb.RelayMsg, error)

+ func RelayPeerToPeerInfo(p *pb.RelayMsg_Peer) (peer.ID, []ma.Multiaddr, error)

+ func WriteRelayMsg(s network.Stream, msg *pb.RelayMsg) error

+ type Conn struct

+ Stream network.Stream

+ func (c *Conn) Close() error

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

+ func (c *Conn) Read(buf []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 (c *Conn) Write(buf []byte) (int, error)

+ type NetAddr struct

+ Addr string

+ func (n *NetAddr) Network() string

+ func (n *NetAddr) String() string

+ type Relay struct

+ func NewRelay(ctx context.Context, peerId peer.ID, logger api.Logger, opts ...RelayOpt) (*Relay, error)

+ func (r *Relay) Accept() (net.Conn, error)

+ func (r *Relay) Addr() net.Addr

+ func (r *Relay) Close() error

+ func (r *Relay) HandleHopStream(stream network.Stream, h host.Host, relayMsg *pb.RelayMsg)

+ func (r *Relay) HandleStopStream(stream network.Stream, h host.Host, relayMsg *pb.RelayMsg)

+ type RelayOpt int