route

Documentation

Overview

Package route implements management functions of REST Router

Index

• Constants
• type RestRouter
  • func NewRestRouter() *RestRouter
  • func NewRestRouterWithCerti(path string) *RestRouter
  • func (r *RestRouter) Add(s restinterface.IRestRoutes)
  • func (r RestRouter) Start()

Constants

const (
	// ConstWellknownPort is the common port for REST API
	ConstWellknownPort = 56001
	// ConstInternalPort is the port used for TLS connection
	ConstInternalPort = 56002
)

Types

type RestRouter

type RestRouter struct {
	tls.HasCertificate
	// contains filtered or unexported fields
}

RestRouter struct {

func NewRestRouter

func NewRestRouter() *RestRouter

NewRestRouter constructs RestRouter instance

func NewRestRouterWithCerti

func NewRestRouterWithCerti(path string) *RestRouter

NewRestRouterWithCerti constructs RestRouter instance with Certificate file path

func (*RestRouter) Add

func (r *RestRouter) Add(s restinterface.IRestRoutes)

Add registers REST API to RestRouter

func (RestRouter) Start

func (r RestRouter) Start()

Start wraps ListenAndServe function