peer

Documentation

Index

• Constants
• Variables
• type PeerInfo
  • func (pi *PeerInfo) Address() string
  • func (pi *PeerInfo) Fingerprint() crypto.Fingerprint
  • func (s *PeerInfo) FromObject(o *object.Object) error
  • func (s PeerInfo) GetType() string
  • func (s PeerInfo) ToObject() *object.Object
• type PeerInfoCollection
  • func (c *PeerInfoCollection) All() ([]*PeerInfo, error)
  • func (c *PeerInfoCollection) Get(fingerprint string) (*PeerInfo, error)
  • func (c *PeerInfoCollection) Put(peerInfo *PeerInfo) error
• type PeerInfoRequest
  • func (s *PeerInfoRequest) FromObject(o *object.Object) error
  • func (s PeerInfoRequest) GetType() string
  • func (s PeerInfoRequest) ToObject() *object.Object

Constants

const (
	PeerInfoRequestType = "/peer.request"
)

const (
	PeerInfoType = "/peer"
)

Variables

var (
	// ErrNotFound is returned wheh a requqested item in the collection does
	// not exist
	ErrNotFound = errors.New("peer not found")
)

Types

type PeerInfo

type PeerInfo struct {
	Addresses    []string          `json:"addresses"`
	Protocols    []string          `json:"protocols"`
	ContentIDs   []string          `json:"contentIDs"`
	ContentTypes []string          `json:"contentTypes"`
	Signature    *crypto.Signature `json:"@signature"`
}

PeerInfo holds the information exchange needs to connect to a remote peer

func (*PeerInfo) Address

func (pi *PeerInfo) Address() string

Address of the peer

func (*PeerInfo) Fingerprint

func (pi *PeerInfo) Fingerprint() crypto.Fingerprint

Fingerprint of signer

func (*PeerInfo) FromObject

func (s *PeerInfo) FromObject(o *object.Object) error

FromObject populates the struct from a f12n object

func (PeerInfo) GetType

func (s PeerInfo) GetType() string

GetType returns the object's type

func (PeerInfo) ToObject

func (s PeerInfo) ToObject() *object.Object

ToObject returns a f12n object

type PeerInfoCollection

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

PeerInfoCollection allows concurrent access to peerinfos

func (*PeerInfoCollection) All

func (c *PeerInfoCollection) All() ([]*PeerInfo, error)

All returns all items in the collection

func (*PeerInfoCollection) Get

func (c *PeerInfoCollection) Get(fingerprint string) (*PeerInfo, error)

Get retuns a single item from the collection given its id

func (*PeerInfoCollection) Put

func (c *PeerInfoCollection) Put(peerInfo *PeerInfo) error

Put adds or overwrites an item in the collection

type PeerInfoRequest

type PeerInfoRequest struct {
	Keys         []crypto.Fingerprint
	Protocols    []string
	ContentIDs   []string
	ContentTypes []string
}

PeerInfoRequest is a request for a peer info

func (*PeerInfoRequest) FromObject

func (s *PeerInfoRequest) FromObject(o *object.Object) error

FromObject populates the struct from a f12n object

func (PeerInfoRequest) GetType

func (s PeerInfoRequest) GetType() string

GetType returns the object's type

func (PeerInfoRequest) ToObject

func (s PeerInfoRequest) ToObject() *object.Object

ToObject returns a f12n object