http

Documentation

Index

• func RequestFromServerContext(ctx context.Context) (*http.Request, bool)
• func SetOperation(ctx context.Context, op string)
• type Server
  • func NewServer(opts ...ServerOption) *Server
  • func (s *Server) Endpoint() (*url.URL, error)
  • func (s *Server) Start(ctx context.Context) error
  • func (s *Server) Stop(ctx context.Context) error
• type ServerOption
  • func TLSConfig(c *tls.Config) ServerOption
  • func WithAddress(addr string) ServerOption
  • func WithEnableProfiling(profiling bool) ServerOption
  • func WithMetric(metric metric.GinMetric) ServerOption
  • func WithMiddlewares(middlewares []string) ServerOption
  • func WithMode(mode string) ServerOption
  • func WithServiceName(srvName string) ServerOption
  • func WithTimeout(timeout time.Duration) ServerOption
• type Transport
  • func (tr *Transport) Endpoint() string
  • func (tr *Transport) Kind() transport.Kind
  • func (tr *Transport) Operation() string
  • func (tr *Transport) PathTemplate() string
  • func (tr *Transport) ReplyHeader() transport.Header
  • func (tr *Transport) Request() *http.Request
  • func (tr *Transport) RequestHeader() transport.Header
• type Transporter

Functions

func RequestFromServerContext

func RequestFromServerContext(ctx context.Context) (*http.Request, bool)

RequestFromServerContext returns request from context.

func SetOperation

func SetOperation(ctx context.Context, op string)

SetOperation sets the transport operation.

Types

type Server

type Server struct {
	*gin.Engine
	// contains filtered or unexported fields
}

wrapper for gin.Engine

func NewServer

func NewServer(opts ...ServerOption) *Server

func (*Server) Endpoint

func (s *Server) Endpoint() (*url.URL, error)

Endpoint return a real address to registry endpoint. examples:

https://127.0.0.1:8000
Legacy: http://127.0.0.1:8000?isSecure=false

func (*Server) Start

func (s *Server) Start(ctx context.Context) error

start rest server

func (*Server) Stop

func (s *Server) Stop(ctx context.Context) error

type ServerOption

type ServerOption func(*Server)

func TLSConfig

func TLSConfig(c *tls.Config) ServerOption

TLSConfig with TLS config.

func WithAddress

func WithAddress(addr string) ServerOption

func WithEnableProfiling

func WithEnableProfiling(profiling bool) ServerOption

func WithMetric

func WithMetric(metric metric.GinMetric) ServerOption

func WithMiddlewares

func WithMiddlewares(middlewares []string) ServerOption

func WithMode

func WithMode(mode string) ServerOption

func WithServiceName

func WithServiceName(srvName string) ServerOption

func WithTimeout

func WithTimeout(timeout time.Duration) ServerOption

type Transport

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

Transport is an HTTP transport.

func (*Transport) Endpoint

func (tr *Transport) Endpoint() string

Endpoint returns the transport endpoint.

func (*Transport) Kind

func (tr *Transport) Kind() transport.Kind

Kind returns the transport kind.

func (*Transport) Operation

func (tr *Transport) Operation() string

Operation returns the transport operation.

func (*Transport) PathTemplate

func (tr *Transport) PathTemplate() string

PathTemplate returns the http path template.

func (*Transport) ReplyHeader

func (tr *Transport) ReplyHeader() transport.Header

ReplyHeader returns the reply header.

func (*Transport) Request

func (tr *Transport) Request() *http.Request

Request returns the HTTP request.

func (*Transport) RequestHeader

func (tr *Transport) RequestHeader() transport.Header

RequestHeader returns the request header.

type Transporter

type Transporter interface {
	transport.Transporter
	Request() *http.Request
	PathTemplate() string
}

Transporter is http Transporter