routing

Documentation

Index

• func DispatcherType() interface{}
• func RouterType() interface{}
• type DefaultRouter
  • func (DefaultRouter) Close() error
  • func (DefaultRouter) PickRoute(ctx context.Context) (string, error)
  • func (DefaultRouter) Start() error
  • func (DefaultRouter) Type() interface{}
• type Dispatcher
• type Router

Functions

func DispatcherType

func DispatcherType() interface{}

DispatcherType returns the type of Dispatcher interface. Can be used to implement common.HasType.

v2ray:api:stable

func RouterType

func RouterType() interface{}

RouterType return the type of Router interface. Can be used to implement common.HasType.

v2ray:api:stable

Types

type DefaultRouter

type DefaultRouter struct{}

DefaultRouter is an implementation of Router, which always returns ErrNoClue for routing decisions.

func (DefaultRouter) Close

func (DefaultRouter) Close() error

Close implements common.Closable.

func (DefaultRouter) PickRoute

func (DefaultRouter) PickRoute(ctx context.Context) (string, error)

PickRoute implements Router.

func (DefaultRouter) Start

func (DefaultRouter) Start() error

Start implements common.Runnable.

func (DefaultRouter) Type

func (DefaultRouter) Type() interface{}

Type implements common.HasType.

type Dispatcher

type Dispatcher interface {
	features.Feature

	// Dispatch returns a Ray for transporting data for the given request.
	Dispatch(ctx context.Context, dest net.Destination) (*transport.Link, error)
}

Dispatcher is a feature that dispatches inbound requests to outbound handlers based on rules. Dispatcher is required to be registered in a V2Ray instance to make V2Ray function properly.

v2ray:api:stable

type Router

type Router interface {
	features.Feature

	// PickRoute returns a tag of an OutboundHandler based on the given context.
	PickRoute(ctx context.Context) (string, error)
}

Router is a feature to choose an outbound tag for the given request.

v2ray:api:stable