server

Documentation

Index

• type Address
• type Contact
• type Document
• type DocumentHandlerOptions
• type FastHttp
  • func (srv *FastHttp) Build(options HttpOptions) (err error)
  • func (srv *FastHttp) Close() (err error)
  • func (srv *FastHttp) ListenAndServe() (err error)
• type Handler
  • func NewCorsHandler() (h Handler)
  • func NewDocumentHandler(options DocumentHandlerOptions) (h Handler)
  • func NewHealthHandler(options HealthHandlerOptions) (h Handler)
  • func NewServiceHandler() (h Handler)
  • func NewWebsocketHandler() (h Handler)
  • func PprofHandler() (h Handler)
• type HandlerOptions
• type Handlers
  • func NewHandlers(options *HandlerOptions) (handlers *Handlers)
  • func (handlers *Handlers) Append(h Handler) (err error)
  • func (handlers *Handlers) Close()
  • func (handlers *Handlers) ServeHTTP(writer http.ResponseWriter, request *http.Request)
• type HealthHandlerOptions
• type Http
• type HttpClient
• type HttpOptions
  • func (options HttpOptions) GetOption(key string, value interface{}) (has bool, err error)
• type License
• type PprofArgument
• type PprofHandlerOptions
• type WebsocketEndpoint
• type WebsocketMessage
• type WebsocketRequest
  • func NewWebsocketRequest(msg *WebsocketMessage, remoteIp string) (r *WebsocketRequest, err errors.CodeError)
  • func (r *WebsocketRequest) Argument() (argument service.Argument)
  • func (r *WebsocketRequest) Authorization() (v string)
  • func (r *WebsocketRequest) Fn() (service string, fn string)
  • func (r *WebsocketRequest) Hash() (code uint64)
  • func (r *WebsocketRequest) Header() (header service.RequestHeader)
  • func (r *WebsocketRequest) Id() (id string)
  • func (r *WebsocketRequest) Internal() (ok bool)
  • func (r *WebsocketRequest) Local() (local service.RequestLocal)
  • func (r *WebsocketRequest) RemoteIp() (v string)
  • func (r *WebsocketRequest) SetUser(id string, attr *json.Object)
  • func (r *WebsocketRequest) User() (user service.RequestUser)

Types

type Address

type Address struct {
	URL         string `json:"url"`
	Description string `json:"description"`
}

type Contact

type Contact struct {
	Name  string `json:"name"`
	Url   string `json:"url"`
	Email string `json:"email"`
}

type Document

type Document struct {
	Title       string    `json:"title"`
	Description string    `json:"description"`
	Terms       string    `json:"terms"`
	Contact     *Contact  `json:"contact"`
	License     *License  `json:"license"`
	Addresses   []Address `json:"servers"`
	// contains filtered or unexported fields
}

type DocumentHandlerOptions

type DocumentHandlerOptions struct {
	Version string
}

type FastHttp

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

func (*FastHttp) Build

func (srv *FastHttp) Build(options HttpOptions) (err error)

func (*FastHttp) Close

func (srv *FastHttp) Close() (err error)

func (*FastHttp) ListenAndServe

func (srv *FastHttp) ListenAndServe() (err error)

type Handler

type Handler interface {
	Name() (name string)
	Build(options *HandlerOptions) (err error)
	Handle(writer http.ResponseWriter, request *http.Request) (ok bool)
	Close()
}

func NewCorsHandler

func NewCorsHandler() (h Handler)

func NewDocumentHandler

func NewDocumentHandler(options DocumentHandlerOptions) (h Handler)

func NewHealthHandler

func NewHealthHandler(options HealthHandlerOptions) (h Handler)

func NewServiceHandler

func NewServiceHandler() (h Handler)

func NewWebsocketHandler

func NewWebsocketHandler() (h Handler)

func PprofHandler

func PprofHandler() (h Handler)

type HandlerOptions

type HandlerOptions struct {
	Log       logs.Logger
	Config    configures.Config
	Endpoints service.Endpoints
}

type Handlers

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

func NewHandlers

func NewHandlers(options *HandlerOptions) (handlers *Handlers)

func (*Handlers) Append

func (handlers *Handlers) Append(h Handler) (err error)

func (*Handlers) Close

func (handlers *Handlers) Close()

func (*Handlers) ServeHTTP

func (handlers *Handlers) ServeHTTP(writer http.ResponseWriter, request *http.Request)

type HealthHandlerOptions

type HealthHandlerOptions struct {
	AppId   string
	AppName string
	Version string
	Running *commons.SafeFlag
}

type Http

type Http interface {
	Build(options HttpOptions) (err error)
	ListenAndServe() (err error)
	Close() (err error)
}

type HttpClient

type HttpClient interface {
	Do(ctx context.Context, method string, url string, header http.Header, body []byte) (status int, respHeader http.Header, respBody []byte, err error)
	Close()
}

type HttpOptions

type HttpOptions struct {
	Port      int
	ServerTLS *tls.Config
	ClientTLS *tls.Config
	Handler   http.Handler
	Log       logs.Logger
	Raw       *json.Object
}

func (HttpOptions) GetOption

func (options HttpOptions) GetOption(key string, value interface{}) (has bool, err error)

type License

type License struct {
	Name string `json:"name"`
	Url  string `json:"url"`
}

type PprofArgument

type PprofArgument struct {
	Password string `json:"password"`
	Sec      int    `json:"sec"`
}

type PprofHandlerOptions

type PprofHandlerOptions struct {
	Password string
}

type WebsocketEndpoint

type WebsocketEndpoint interface {
	Id() (id string)
	Write(ctx context.Context, message interface{}) (err errors.CodeError)
	Close()
}

type WebsocketMessage

type WebsocketMessage struct {
	Header http.Header     `json:"header"`
	Body   json.RawMessage `json:"body"`
}

type WebsocketRequest

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

func NewWebsocketRequest

func NewWebsocketRequest(msg *WebsocketMessage, remoteIp string) (r *WebsocketRequest, err errors.CodeError)

func (*WebsocketRequest) Argument

func (r *WebsocketRequest) Argument() (argument service.Argument)

func (*WebsocketRequest) Authorization

func (r *WebsocketRequest) Authorization() (v string)

func (*WebsocketRequest) Fn

func (r *WebsocketRequest) Fn() (service string, fn string)

func (*WebsocketRequest) Hash

func (r *WebsocketRequest) Hash() (code uint64)

func (*WebsocketRequest) Header

func (r *WebsocketRequest) Header() (header service.RequestHeader)

func (*WebsocketRequest) Id

func (r *WebsocketRequest) Id() (id string)

func (*WebsocketRequest) Internal

func (r *WebsocketRequest) Internal() (ok bool)

func (*WebsocketRequest) Local

func (r *WebsocketRequest) Local() (local service.RequestLocal)

func (*WebsocketRequest) RemoteIp

func (r *WebsocketRequest) RemoteIp() (v string)

func (*WebsocketRequest) SetUser

func (r *WebsocketRequest) SetUser(id string, attr *json.Object)

func (*WebsocketRequest) User

func (r *WebsocketRequest) User() (user service.RequestUser)