simple

Documentation

Overview

Package simple contains simplistic implementation for the wire.Dialer and wire.Listener interfaces.

Index

• type Account
  • func NewAccount(addr *Address) *Account
  • func NewRandomAccount(rng *rand.Rand) *Account
  • func (acc *Account) Address() wire.Address
• type Address
  • func NewAddress(host string) *Address
  • func NewRandomAddress(rng *rand.Rand) *Address
  • func (a Address) Cmp(b wire.Address) int
  • func (a Address) Equal(b wire.Address) bool
  • func (a Address) MarshalBinary() ([]byte, error)
  • func (a *Address) UnmarshalBinary(data []byte) error
• type Dialer
  • func NewNetDialer(network string, defaultTimeout time.Duration) *Dialer
  • func NewTCPDialer(defaultTimeout time.Duration) *Dialer
  • func NewUnixDialer(defaultTimeout time.Duration) *Dialer
  • func (d *Dialer) Dial(ctx context.Context, addr wire.Address, ser wire.EnvelopeSerializer) (wirenet.Conn, error)
  • func (d *Dialer) Register(addr wire.Address, address string)
• type Listener
  • func NewNetListener(network string, address string) (*Listener, error)
  • func NewTCPListener(address string) (*Listener, error)
  • func NewUnixListener(address string) (*Listener, error)
  • func (l *Listener) Accept(ser wire.EnvelopeSerializer) (wirenet.Conn, error)

Types

type Account

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

Account is a wire account.

func NewAccount

func NewAccount(addr *Address) *Account

NewAccount creates a new account.

func NewRandomAccount

func NewRandomAccount(rng *rand.Rand) *Account

NewRandomAccount generates a new random account.

func (*Account) Address

func (acc *Account) Address() wire.Address

Address returns the account's address.

type Address

type Address string

Address is a wire address.

func NewAddress

func NewAddress(host string) *Address

NewAddress returns a new address.

func NewRandomAddress

func NewRandomAddress(rng *rand.Rand) *Address

NewRandomAddress returns a new random peer address.

func (Address) Cmp

func (a Address) Cmp(b wire.Address) int

Cmp compares the byte representation of two addresses. For `a.Cmp(b)` returns -1 if a < b, 0 if a == b, 1 if a > b.

func (Address) Equal

func (a Address) Equal(b wire.Address) bool

Equal returns whether the two addresses are equal.

func (Address) MarshalBinary

func (a Address) MarshalBinary() ([]byte, error)

MarshalBinary marshals the address to binary.

func (*Address) UnmarshalBinary

func (a *Address) UnmarshalBinary(data []byte) error

UnmarshalBinary unmarshals an address from binary.

type Dialer

type Dialer struct {
	pkgsync.Closer
	// contains filtered or unexported fields
}

Dialer is a simple lookup-table based dialer that can dial known peers. New peer addresses can be added via Register().

func NewNetDialer

func NewNetDialer(network string, defaultTimeout time.Duration) *Dialer

NewNetDialer creates a new dialer with a preset default timeout for dial attempts. Leaving the timeout as 0 will result in no timeouts. Standard OS timeouts may still apply even when no timeout is selected. The network string controls the type of connection that the dialer can dial. `serializer` defines the message encoding.

func NewTCPDialer

func NewTCPDialer(defaultTimeout time.Duration) *Dialer

NewTCPDialer is a short-hand version of NewNetDialer for creating TCP dialers.

func NewUnixDialer

func NewUnixDialer(defaultTimeout time.Duration) *Dialer

NewUnixDialer is a short-hand version of NewNetDialer for creating Unix dialers.

func (*Dialer) Dial

func (d *Dialer) Dial(ctx context.Context, addr wire.Address, ser wire.EnvelopeSerializer) (wirenet.Conn, error)

Dial implements Dialer.Dial().

func (*Dialer) Register

func (d *Dialer) Register(addr wire.Address, address string)

Register registers a network address for a peer address.

type Listener

type Listener struct {
	net.Listener
}

Listener is a TCP Listener.

func NewNetListener

func NewNetListener(network string, address string) (*Listener, error)

NewNetListener creates a listener reachable under the requested address.

func NewTCPListener

func NewTCPListener(address string) (*Listener, error)

NewTCPListener is a short-hand version of NewNetListener for TCP listeners.

func NewUnixListener

func NewUnixListener(address string) (*Listener, error)

NewUnixListener is a short-hand version of NewNetListener for Unix listeners.

func (*Listener) Accept

func (l *Listener) Accept(ser wire.EnvelopeSerializer) (wirenet.Conn, error)

Accept implements peer.Dialer.Accept().