mobile

Documentation

Index

• func GenerateConfigJSON() []byte
• func GetVersion() string
• type MobileLogger
  • func (nsl MobileLogger) Write(p []byte) (n int, err error)
• type Yggdrasil
  • func (m *Yggdrasil) GetAddressString() string
  • func (m *Yggdrasil) GetMTU() int
  • func (m *Yggdrasil) GetPathsJSON() (result string)
  • func (m *Yggdrasil) GetPeersJSON() (result string)
  • func (m *Yggdrasil) GetPublicKeyString() string
  • func (m *Yggdrasil) GetRoutingEntries() int
  • func (m *Yggdrasil) GetSubnetString() string
  • func (m *Yggdrasil) GetTreeJSON() (result string)
  • func (m *Yggdrasil) Recv() ([]byte, error)
  • func (m *Yggdrasil) RecvBuffer(buf []byte) (int, error)
  • func (m *Yggdrasil) RetryPeersNow()
  • func (m *Yggdrasil) Send(p []byte) error
  • func (m *Yggdrasil) SendBuffer(p []byte, length int) error
  • func (m *Yggdrasil) StartAutoconfigure() error
  • func (m *Yggdrasil) StartJSON(configjson []byte) error
  • func (m *Yggdrasil) Stop() error

Functions

func GenerateConfigJSON

func GenerateConfigJSON() []byte

GenerateConfigJSON generates mobile-friendly configuration in JSON format

func GetVersion

func GetVersion() string

Types

type MobileLogger

type MobileLogger struct {
}

func (MobileLogger) Write

func (nsl MobileLogger) Write(p []byte) (n int, err error)

type Yggdrasil

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

Yggdrasil mobile package is meant to "plug the gap" for mobile support, as Gomobile will not create headers for Swift/Obj-C etc if they have complex (non-native) types. Therefore for iOS we will expose some nice simple functions. Note that in the case of iOS we handle reading/writing to/from TUN in Swift therefore we use the "dummy" TUN interface instead.

func (*Yggdrasil) GetAddressString

func (m *Yggdrasil) GetAddressString() string

GetAddressString gets the node's IPv6 address

func (*Yggdrasil) GetMTU

func (m *Yggdrasil) GetMTU() int

GetMTU returns the configured node MTU. This must be called AFTER Start.

func (*Yggdrasil) GetPathsJSON

func (m *Yggdrasil) GetPathsJSON() (result string)

func (*Yggdrasil) GetPeersJSON

func (m *Yggdrasil) GetPeersJSON() (result string)

func (*Yggdrasil) GetPublicKeyString

func (m *Yggdrasil) GetPublicKeyString() string

GetPublicKeyString gets the node's public key in hex form

func (*Yggdrasil) GetRoutingEntries

func (m *Yggdrasil) GetRoutingEntries() int

GetRoutingEntries gets the number of entries in the routing table

func (*Yggdrasil) GetSubnetString

func (m *Yggdrasil) GetSubnetString() string

GetSubnetString gets the node's IPv6 subnet in CIDR notation

func (*Yggdrasil) GetTreeJSON

func (m *Yggdrasil) GetTreeJSON() (result string)

func (*Yggdrasil) Recv

func (m *Yggdrasil) Recv() ([]byte, error)

Recv waits for and reads a packet coming from Yggdrasil. It will be a fully formed IPv6 packet

func (*Yggdrasil) RecvBuffer

func (m *Yggdrasil) RecvBuffer(buf []byte) (int, error)

Recv waits for and reads a packet coming from Yggdrasil to given buffer, returning size of packet

func (*Yggdrasil) RetryPeersNow

func (m *Yggdrasil) RetryPeersNow()

Retry resets the peer connection timer and tries to dial them immediately.

func (*Yggdrasil) Send

func (m *Yggdrasil) Send(p []byte) error

Send sends a packet to Yggdrasil. It should be a fully formed IPv6 packet

func (*Yggdrasil) SendBuffer

func (m *Yggdrasil) SendBuffer(p []byte, length int) error

Send sends a packet from given buffer to Yggdrasil. From first byte up to length.

func (*Yggdrasil) StartAutoconfigure

func (m *Yggdrasil) StartAutoconfigure() error

StartAutoconfigure starts a node with a randomly generated config

func (*Yggdrasil) StartJSON

func (m *Yggdrasil) StartJSON(configjson []byte) error

StartJSON starts a node with the given JSON config. You can get JSON config (rather than HJSON) by using the GenerateConfigJSON() function

func (*Yggdrasil) Stop

func (m *Yggdrasil) Stop() error

Stop the mobile Yggdrasil instance