relay

Documentation

Index

• Constants
• func ReadHeader(r io.Reader) (src, dst peer.ID, err error)
• func WriteHeader(w io.Writer, src, dst peer.ID) error
• type RelayService
  • func NewRelayService(h host.Host, sh inet.StreamHandler) *RelayService

Constants

const ID protocol.ID = "/ipfs/relay"

ID is the protocol.ID of the Relay Service.

Functions

func ReadHeader

func ReadHeader(r io.Reader) (src, dst peer.ID, err error)

func WriteHeader

func WriteHeader(w io.Writer, src, dst peer.ID) error

Types

type RelayService

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

Relay is a structure that implements ProtocolRelay. It is a simple relay service which forwards traffic between two directly connected peers.

the protocol is very simple:

/ipfs/relay\n
<multihash src id>
<multihash dst id>
<data stream>

func NewRelayService

func NewRelayService(h host.Host, sh inet.StreamHandler) *RelayService