transport_interface

Documentation

Index

• Constants
• func LoadKnownPeers(path string) (peers []string, err error)
• func PrettyId(peerId string) string
• func PrettyIds(peerId []string) string
• type Bytable
• type CryptoType
• type IncomingLetter
  • func (i IncomingLetter) String() string
• type NewIncomingMessageEventSubscriber
• type NewOutgoingMessageEventSubscriber
• type OutgoingLetter
  • func (o OutgoingLetter) String() string
• type OutgoingMsg
• type PeerConnectedEventSubscriber
• type PeerDisconnectedEventSubscriber
• type PeerEvent
• type RelayableOutgoingMsg
• type SendType
  • func (s SendType) String() string
• type TransportAccount
• type WireMessage
  • func (z *WireMessage) DecodeMsg(dc *msgp.Reader) (err error)
  • func (z *WireMessage) EncodeMsg(en *msgp.Writer) (err error)
  • func (z *WireMessage) MarshalMsg(b []byte) (o []byte, err error)
  • func (z *WireMessage) Msgsize() (s int)
  • func (z *WireMessage) UnmarshalMsg(bts []byte) (o []byte, err error)

Constants

const CryptoTypeECDSA = CryptoType(cryptopb.KeyType_ECDSA)

const CryptoTypeEd25519 = CryptoType(cryptopb.KeyType_Ed25519)

const CryptoTypeRSA = CryptoType(cryptopb.KeyType_RSA)

const CryptoTypeSecp256k1 = CryptoType(cryptopb.KeyType_Secp256k1)

Functions

func LoadKnownPeers

func LoadKnownPeers(path string) (peers []string, err error)

func PrettyId

func PrettyId(peerId string) string

func PrettyIds

func PrettyIds(peerId []string) string

Types

type Bytable

type Bytable interface {
	ToBytes() []byte
	FromBytes(bts []byte) error
}

type CryptoType

type CryptoType int

type IncomingLetter

type IncomingLetter struct {
	Msg  *WireMessage
	From string // peer Id
}

func (IncomingLetter) String

func (i IncomingLetter) String() string

type NewIncomingMessageEventSubscriber

type NewIncomingMessageEventSubscriber interface {
	Name() string
	NewIncomingMessageEventChannel() chan *IncomingLetter
}

type NewOutgoingMessageEventSubscriber

type NewOutgoingMessageEventSubscriber interface {
	Name() string
	NewOutgoingMessageEventChannel() chan *OutgoingLetter
}

type OutgoingLetter

type OutgoingLetter struct {
	Msg            OutgoingMsg
	SendType       SendType
	CloseAfterSent bool
	ExceptMyself   bool
	EndReceivers   []string // may be the relayer
}

func (OutgoingLetter) String

func (o OutgoingLetter) String() string

type OutgoingMsg

type OutgoingMsg interface {
	Bytable
	msgp.Marshaler
	msgp.Unmarshaler
	GetTypeValue() int
	String() string
}

type PeerConnectedEventSubscriber

type PeerConnectedEventSubscriber interface {
	Name() string
	GetPeerConnectedEventChannel() chan *PeerEvent
}

type PeerDisconnectedEventSubscriber

type PeerDisconnectedEventSubscriber interface {
	Name() string
	GetPeerDisconnectedEventChannel() chan *PeerEvent
}

type PeerEvent

type PeerEvent struct {
	PeerId string
}

type RelayableOutgoingMsg

type RelayableOutgoingMsg interface {
	OutgoingMsg
	GetReceiverId() string // final receiver.
	GetOriginId() string   // original sender
}

type SendType

type SendType int

const (
	SendTypeUnicast   SendType = iota // send to only one
	SendTypeMulticast                 // send to multiple receivers
	SendTypeBroadcast                 // send to all peers in the network
)

func (SendType) String

func (s SendType) String() string

type TransportAccount

type TransportAccount struct {
	PublicKey  crypto.PubKey
	PrivateKey crypto.PrivKey
	NodeId     string
}

TransportAccount represents a full account of a user in p2p network.

type WireMessage

type WireMessage struct {
	MsgType      int    // what ContentByte is.
	ContentBytes []byte // this Byte will be recovered to implementation of Content interface
}

WireMessage is for transportation. msgp WireMessage

func (*WireMessage) DecodeMsg

func (z *WireMessage) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*WireMessage) EncodeMsg

func (z *WireMessage) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*WireMessage) MarshalMsg

func (z *WireMessage) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*WireMessage) Msgsize

func (z *WireMessage) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*WireMessage) UnmarshalMsg

func (z *WireMessage) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler