peer

Documentation

Index

• Constants
• Variables
• type CryptoPublicKeySyncList
  • func NewCryptoPublicKeyValueTypeSyncMap() *CryptoPublicKeySyncList
  • func (m *CryptoPublicKeySyncList) Delete(k crypto.PublicKey)
  • func (m *CryptoPublicKeySyncList) Exists(k crypto.PublicKey) bool
  • func (m *CryptoPublicKeySyncList) Put(k crypto.PublicKey)
  • func (m *CryptoPublicKeySyncList) Range(i func(k crypto.PublicKey) bool)
• type LookupRequest
  • func (e *LookupRequest) FromObject(o *object.Object) error
  • func (e LookupRequest) ToObject() *object.Object
  • func (e *LookupRequest) Type() string
• type LookupResponse
  • func (e *LookupResponse) FromObject(o *object.Object) error
  • func (e LookupResponse) ToObject() *object.Object
  • func (e *LookupResponse) Type() string
• type ObjectHashSyncList
  • func NewObjectHashValueTypeSyncMap() *ObjectHashSyncList
  • func (m *ObjectHashSyncList) Delete(k object.Hash)
  • func (m *ObjectHashSyncList) Exists(k object.Hash) bool
  • func (m *ObjectHashSyncList) Put(k object.Hash)
  • func (m *ObjectHashSyncList) Range(i func(k object.Hash) bool)
• type Peer
  • func Unique(peers []*Peer) []*Peer
  • func (pi *Peer) Address() string
  • func (e *Peer) FromObject(o *object.Object) error
  • func (pi *Peer) PublicKey() crypto.PublicKey
  • func (e Peer) ToObject() *object.Object
  • func (e *Peer) Type() string
• type Shorthand
  • func (s Shorthand) Addresses() []string
  • func (s Shorthand) IsValid() bool
  • func (s Shorthand) Peer() (*Peer, error)
  • func (s Shorthand) PublicKey() crypto.PublicKey

Constants

const (
	ErrInvalidShorthand = errors.Error("invalid shorthand")
)

Variables

var (
	// ErrMissingKey when a key is not passed
	ErrMissingKey = errors.New("missing key")
	// ErrECDSAPrivateKeyRequired when a key is not an ECDSA key
	ErrECDSAPrivateKeyRequired = errors.New(
		"network currently requires an ecdsa private key")
)

Types

type CryptoPublicKeySyncList

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

CryptoPublicKeySyncList -

func NewCryptoPublicKeyValueTypeSyncMap

func NewCryptoPublicKeyValueTypeSyncMap() *CryptoPublicKeySyncList

NewCryptoPublicKeyValueTypeSyncMap constructs a new SyncMap

func (*CryptoPublicKeySyncList) Delete

func (m *CryptoPublicKeySyncList) Delete(k crypto.PublicKey)

Delete -

func (*CryptoPublicKeySyncList) Exists

func (m *CryptoPublicKeySyncList) Exists(k crypto.PublicKey) bool

Exists -

func (*CryptoPublicKeySyncList) Put

func (m *CryptoPublicKeySyncList) Put(k crypto.PublicKey)

Put -

func (*CryptoPublicKeySyncList) Range

func (m *CryptoPublicKeySyncList) Range(i func(k crypto.PublicKey) bool)

Range -

type LookupRequest

type LookupRequest struct {
	Metadata object.Metadata `nimona:"metadata:m"`
	Nonce    string          `nimona:"nonce:s,omitempty"`
	Bloom    []int64         `nimona:"bloom:ai,omitempty"`
}

func (*LookupRequest) FromObject

func (e *LookupRequest) FromObject(o *object.Object) error

func (LookupRequest) ToObject

func (e LookupRequest) ToObject() *object.Object

func (*LookupRequest) Type

func (e *LookupRequest) Type() string

type LookupResponse

type LookupResponse struct {
	Metadata object.Metadata `nimona:"metadata:m"`
	Nonce    string          `nimona:"nonce:s,omitempty"`
	Bloom    []int64         `nimona:"bloom:ai,omitempty"`
	Peers    []*Peer         `nimona:"peers:am,omitempty"`
}

func (*LookupResponse) FromObject

func (e *LookupResponse) FromObject(o *object.Object) error

func (LookupResponse) ToObject

func (e LookupResponse) ToObject() *object.Object

func (*LookupResponse) Type

func (e *LookupResponse) Type() string

type ObjectHashSyncList

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

ObjectHashSyncList -

func NewObjectHashValueTypeSyncMap

func NewObjectHashValueTypeSyncMap() *ObjectHashSyncList

NewObjectHashValueTypeSyncMap constructs a new SyncMap

func (*ObjectHashSyncList) Delete

func (m *ObjectHashSyncList) Delete(k object.Hash)

Delete -

func (*ObjectHashSyncList) Exists

func (m *ObjectHashSyncList) Exists(k object.Hash) bool

Exists -

func (*ObjectHashSyncList) Put

func (m *ObjectHashSyncList) Put(k object.Hash)

Put -

func (*ObjectHashSyncList) Range

func (m *ObjectHashSyncList) Range(i func(k object.Hash) bool)

Range -

type Peer

type Peer struct {
	Metadata     object.Metadata       `nimona:"metadata:m"`
	Version      int64                 `nimona:"version:i,omitempty"`
	Addresses    []string              `nimona:"addresses:as,omitempty"`
	Bloom        []int64               `nimona:"bloom:ai,omitempty"`
	ContentTypes []string              `nimona:"contentTypes:as,omitempty"`
	Certificates []*object.Certificate `nimona:"certificates:am,omitempty"`
	Relays       []*Peer               `nimona:"relays:am,omitempty"`
}

func Unique

func Unique(peers []*Peer) []*Peer

func (*Peer) Address

func (pi *Peer) Address() string

Address of the peer

func (*Peer) FromObject

func (e *Peer) FromObject(o *object.Object) error

func (*Peer) PublicKey

func (pi *Peer) PublicKey() crypto.PublicKey

func (Peer) ToObject

func (e Peer) ToObject() *object.Object

func (*Peer) Type

func (e *Peer) Type() string

type Shorthand

type Shorthand string

Shorthand has the form of `<public-key>@<address>`. They are mostly used for configuration and bootstrapping.

func (Shorthand) Addresses

func (s Shorthand) Addresses() []string

func (Shorthand) IsValid

func (s Shorthand) IsValid() bool

func (Shorthand) Peer

func (s Shorthand) Peer() (*Peer, error)

func (Shorthand) PublicKey

func (s Shorthand) PublicKey() crypto.PublicKey