protocol

Documentation

Index

• Constants
• func ReadUint64(stream io.Reader) (uint64, error)
• func SendAuth(stream io.Writer, authPeer AuthPeer) error
• func SendAuthResponse(stream io.Writer, response AuthPeerResponse) error
• func SendStatus(stream io.Writer, statusInfo PeerStatusInfo) error
• func WritePacketToBuf(buf, packet []byte) []byte
• type AuthPeer
  • func ReceiveAuth(stream io.Reader) (AuthPeer, error)
• type AuthPeerResponse
  • func ReceiveAuthResponse(stream io.Reader) (AuthPeerResponse, error)
• type PeerStatusInfo
  • func ReceiveStatus(stream io.Reader) (PeerStatusInfo, error)

Constants

const (
	Version = "0.3.0"

	AuthMethod         protocol.ID = basePath + "/auth/"
	GetStatusMethod    protocol.ID = basePath + "/status/"
	TunnelPacketMethod protocol.ID = basePath + "/tunnel/"
)

Functions

func ReadUint64

func ReadUint64(stream io.Reader) (uint64, error)

func SendAuth

func SendAuth(stream io.Writer, authPeer AuthPeer) error

func SendAuthResponse

func SendAuthResponse(stream io.Writer, response AuthPeerResponse) error

func SendStatus

func SendStatus(stream io.Writer, statusInfo PeerStatusInfo) error

func WritePacketToBuf

func WritePacketToBuf(buf, packet []byte) []byte

Types

type AuthPeer

type AuthPeer struct {
	Name string
}

func ReceiveAuth

func ReceiveAuth(stream io.Reader) (AuthPeer, error)

type AuthPeerResponse

type AuthPeerResponse struct {
	Confirmed bool
	Declined  bool
}

func ReceiveAuthResponse

func ReceiveAuthResponse(stream io.Reader) (AuthPeerResponse, error)

type PeerStatusInfo

type PeerStatusInfo struct {
	Name                 string
	Declined             bool
	AllowUsingAsExitNode bool
}

func ReceiveStatus

func ReceiveStatus(stream io.Reader) (PeerStatusInfo, error)