router

Documentation

Index

• Constants
• Variables
• func ReadFrame(frame *Frame, reader io.Reader) error
• func WriteFrame(frame *Frame, writer io.Writer) error
• type Address
  • func (*Address) Network() string
  • func (address *Address) String() string
• type Authority
• type Client
  • func NewClient(RouterAddress string, TLSConfig *tls.Config) *Client
  • func NewClientWithoutAuth(RouterAddress string) *Client
  • func (client *Client) Dial(TargetChannel string) (net.Conn, error)
  • func (client *Client) ScanChannel(ChannelRegexp string) (*ListenerScanResult, error)
• type Frame
• type Listener
  • func NewListener(RouterAddress string, Channel string, TLSConfig *tls.Config) (*Listener, error)
  • func NewListenerWithoutAuth(RouterAddress string, Channel string) (*Listener, error)
  • func NewRouterListenerWithConn(RouterAddress string, Channel string, ...) (*Listener, error)
  • func (listener *Listener) Accept() (net.Conn, error)
  • func (listener *Listener) Addr() net.Addr
  • func (listener *Listener) Close() error
  • func (listener *Listener) IsClosed() bool
• type ListenerScanResult
• type Option
• type PeerInfo
• type Router
  • func NewDefaultRouter() *Router
  • func NewRouter(option Option) *Router
  • func (router *Router) Serve(listener net.Listener) error
• type TrackerConnection
  • func (conn *TrackerConnection) Close() error
  • func (conn *TrackerConnection) ErrorF(format string, args ...interface{})
  • func (conn *TrackerConnection) PrintF(format string, args ...interface{})

Constants

const (
	// DefaultDialConnectionTimeout is the default timeout for a dial operation.
	DefaultDialConnectionTimeout = 2 * time.Second
	// DefaultListenConnectionKeepAlive is the default keep alive checking interval for listening threads.
	DefaultListenConnectionKeepAlive = 20 * time.Second
)

const ListenerWaitTimeout = 5 * time.Minute

ListenerWaitTimeout specifies the duration for the listener to close the connection without receiving heartbeat from router.

const MaxChannelNameLength = 256

MaxChannelNameLength limits the maxmimum length of a channel name.

Variables

var DefaultRouterOption = Option{
	TokenAuthority:            &noPermissionCheckAuthority{},
	DialConnectionTimeout:     DefaultDialConnectionTimeout,
	ListenConnectionKeepAlive: DefaultListenConnectionKeepAlive,
}

DefaultRouterOption is a set of parameters in default value.

Functions

func ReadFrame

func ReadFrame(frame *Frame, reader io.Reader) error

ReadFrame decodes a frame from the reader, the data will be override.

func WriteFrame

func WriteFrame(frame *Frame, writer io.Writer) error

WriteFrame writes a frame to the writer.

Types

type Address

type Address struct {
	Channel string
}

Address represents an address in Router network.

func (*Address) Network

func (*Address) Network() string

Network returns the network type.

func (*Address) String

func (address *Address) String() string

String return the channel name of this address.

type Authority

type Authority interface {
	// Only returns a PeerInfo when the connection has the access permission.
	ValidatePeerInfo(*Frame, net.Conn) (*PeerInfo, error)
}

Authority will be used by the router for ACL control.

type Client

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

Client implements a Dial method to join the Router network.

func NewClient

func NewClient(RouterAddress string, TLSConfig *tls.Config) *Client

NewClient creates a RouterClient with TLS settings.

func NewClientWithoutAuth

func NewClientWithoutAuth(RouterAddress string) *Client

NewClientWithoutAuth creates a RouterClient structure.

func (*Client) Dial

func (client *Client) Dial(TargetChannel string) (net.Conn, error)

Dial initiaites a dial request into the Route network.

func (*Client) ScanChannel

func (client *Client) ScanChannel(ChannelRegexp string) (*ListenerScanResult, error)

ScanChannel returns the list of acessible channels.

type Frame

type Frame struct {
	Type         byte
	ConnectionID uint64
	Payload      string
}

Frame is the packet using between Router.

type Listener

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

Listener implements a net.Listener interface on Router network.

func NewListener

func NewListener(RouterAddress string, Channel string, TLSConfig *tls.Config) (*Listener, error)

NewListener creates a RouterListener.

func NewListenerWithoutAuth

func NewListenerWithoutAuth(RouterAddress string, Channel string) (*Listener, error)

NewListenerWithoutAuth creates a RouterListener structure and try to handshake with Router in `RouterAddress`.

func NewRouterListenerWithConn

func NewRouterListenerWithConn(
	RouterAddress string, Channel string, RouterAddressDialer func(string) (net.Conn, error)) (*Listener, error)

NewRouterListenerWithConn creates a RouterListener structure. Conn here can be a just initialized connectiono from TLS.

func (*Listener) Accept

func (listener *Listener) Accept() (net.Conn, error)

Accept returns a bridged connection from a dial request.

func (*Listener) Addr

func (listener *Listener) Addr() net.Addr

Addr returns the listener's address.

func (*Listener) Close

func (listener *Listener) Close() error

Close closes the listener.

func (*Listener) IsClosed

func (listener *Listener) IsClosed() bool

IsClosed returns whether the listener is closed.

type ListenerScanResult

type ListenerScanResult struct {
	ActiveChannels []string `json:"active_channels"`
}

ListenerScanResult returns a snapshot of accessible channels at the moment.

type Option

type Option struct {
	// TokenAuthority is the authority used for checking permissions.
	TokenAuthority Authority
	// DialConnectionTimeout specifies the timeout when a dialer connects to a listener.
	DialConnectionTimeout time.Duration
	// ListenConnectionKeepAlive specfies the health check interval.
	ListenConnectionKeepAlive time.Duration
}

Option specifies a set of options being used by the router.

type PeerInfo

type PeerInfo struct {
	Name          string `json:"name"`
	RemoteAddress string `json:"remote-address"`
	Expiration    time.Time
}

PeerInfo provides the necessary information to identify a peer.

type Router

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

Router proxies requests.

func NewDefaultRouter

func NewDefaultRouter() *Router

NewDefaultRouter creates a router with default option.

func NewRouter

func NewRouter(option Option) *Router

NewRouter creates a Router structure.

func (*Router) Serve

func (router *Router) Serve(listener net.Listener) error

Serve starts the serving process, this is a blocking call.

type TrackerConnection

type TrackerConnection struct {
	net.Conn
	// contains filtered or unexported fields
}

TrackerConnection keeps the track of the wrapped connection.

func (*TrackerConnection) Close

func (conn *TrackerConnection) Close() error

Close implements the net.Conn Close interface as well as finish the tracking.

func (*TrackerConnection) ErrorF

func (conn *TrackerConnection) ErrorF(format string, args ...interface{})

ErrorF prints a message to the according tracker and marks it as error status.

func (*TrackerConnection) PrintF

func (conn *TrackerConnection) PrintF(format string, args ...interface{})

PrintF prints a message to the according tracker.