peer

Documentation

Index

• Constants
• Variables
• type ConnectionInfo
  • func (e *ConnectionInfo) FromObject(o *object.Object) error
  • func (e ConnectionInfo) ToObject() *object.Object
  • func (e *ConnectionInfo) Type() string
• 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 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 Shorthand
  • func (s Shorthand) ConnectionInfo() (*ConnectionInfo, error)
  • func (s Shorthand) IsValid() bool

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 ConnectionInfo

type ConnectionInfo struct {
	Metadata  object.Metadata   `nimona:"metadata:m,omitempty"`
	PublicKey crypto.PublicKey  `nimona:"publicKey:s,omitempty"`
	Addresses []string          `nimona:"addresses:as,omitempty"`
	Relays    []*ConnectionInfo `nimona:"relays:ao,omitempty"`
}

func (*ConnectionInfo) FromObject

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

func (ConnectionInfo) ToObject

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

func (*ConnectionInfo) Type

func (e *ConnectionInfo) Type() string

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 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 Shorthand

type Shorthand string

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

func (Shorthand) ConnectionInfo

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

func (Shorthand) IsValid

func (s Shorthand) IsValid() bool