relay

Documentation

Overview

Package relay implements the message relay between the Iris node and locally attached applications.

Index

• type Relay
  • func New(port int, overlay *iris.Overlay) (*Relay, error)
  • func (r *Relay) Boot() error
  • func (r *Relay) Terminate() error

Types

type Relay

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

Relay service, listening on a local TCP port and accepting connections for joining the Iris network.

func New

func New(port int, overlay *iris.Overlay) (*Relay, error)

Creates a new relay attached to a carrier and opens the listener socket on the specified local port.

func (*Relay) Boot

func (r *Relay) Boot() error

Starts accepting local relay connections.

func (*Relay) Terminate

func (r *Relay) Terminate() error

Closes all open connections and terminates the relaying service.