web

Documentation

Index

• func Marshal(m proto.Message) ([]byte, error)
• func Unmarshal(b []byte, m proto.Message) error
• type Error
• type Forward
  • func NewForward(req func(counted uint64, messageType int, p []byte) error, ...) Forward
• type Helper
  • func (h Helper) Bind(c *gin.Context, obj interface{}) error
  • func (h Helper) BindQuery(c *gin.Context, obj interface{}) error
  • func (h Helper) BindSession(c *gin.Context) (session *sessionid.Session, e error)
  • func (h Helper) BindURI(c *gin.Context, obj interface{}) (e error)
  • func (h Helper) BindUserdata(c *gin.Context) (userdata *sessionid.Session, e error)
  • func (h Helper) BindWith(c *gin.Context, obj interface{}, b binding.Binding) (e error)
  • func (h Helper) CheckRoot(c *gin.Context)
  • func (h Helper) CheckWebsocket(c *gin.Context)
  • func (h Helper) Compression() gin.HandlerFunc
  • func (h Helper) Error(c *gin.Context, e error)
  • func (h Helper) GetToken(c *gin.Context) string
  • func (h Helper) NegotiateFilesystem(c *gin.Context, fs http.FileSystem, path string, index bool)
  • func (h Helper) NegotiateObject(c *gin.Context, modtime time.Time, name string, obj interface{})
  • func (h Helper) NewContext(c *gin.Context) context.Context
  • func (h Helper) Response(c *gin.Context, code int, data interface{})
  • func (h Helper) ResponseError(c *gin.Context, err Error)
  • func (h Helper) ShouldBindSession(c *gin.Context) (session *sessionid.Session, e error)
  • func (h Helper) ShouldBindUserdata(c *gin.Context) (userdata *sessionid.Session, e error)
  • func (h Helper) ToHTTPError(c *gin.Context, name string, e error)
  • func (h Helper) Websocket(c *gin.Context, responseHeader http.Header) (conn Websocket, e error)
• type IHelper
• type Websocket
  • func (w Websocket) Error(e error) error
  • func (w Websocket) Forward(f Forward)
  • func (w Websocket) Send(v interface{}) error
  • func (w Websocket) SendBinary(b []byte) error
  • func (w Websocket) SendMessage(m proto.Message) error
  • func (w Websocket) Success() error

Functions

func Marshal

func Marshal(m proto.Message) ([]byte, error)

func Unmarshal

func Unmarshal(b []byte, m proto.Message) error

Types

type Error

type Error struct {
	Code    codes.Code `json:"code,omitempty"`
	Message string     `json:"message,omitempty"`
}

type Forward

type Forward interface {
	Request(counted uint64, messageType int, p []byte) error
	Response(counted uint64) (e error)
	CloseSend() error
}

func NewForward

func NewForward(req func(counted uint64, messageType int, p []byte) error,
	resp func(counted uint64) (e error),
	closeSend func() error,
) Forward

type Helper

type Helper int

func (Helper) Bind

func (h Helper) Bind(c *gin.Context, obj interface{}) error

func (Helper) BindQuery

func (h Helper) BindQuery(c *gin.Context, obj interface{}) error

func (Helper) BindSession

func (h Helper) BindSession(c *gin.Context) (session *sessionid.Session, e error)

func (Helper) BindURI

func (h Helper) BindURI(c *gin.Context, obj interface{}) (e error)

func (Helper) BindUserdata

func (h Helper) BindUserdata(c *gin.Context) (userdata *sessionid.Session, e error)

func (Helper) BindWith

func (h Helper) BindWith(c *gin.Context, obj interface{}, b binding.Binding) (e error)

func (Helper) CheckRoot

func (h Helper) CheckRoot(c *gin.Context)

func (Helper) CheckWebsocket

func (h Helper) CheckWebsocket(c *gin.Context)

func (Helper) Compression

func (h Helper) Compression() gin.HandlerFunc

func (Helper) Error

func (h Helper) Error(c *gin.Context, e error)

func (Helper) GetToken

func (h Helper) GetToken(c *gin.Context) string

func (Helper) NegotiateFilesystem

func (h Helper) NegotiateFilesystem(c *gin.Context, fs http.FileSystem, path string, index bool)

func (Helper) NegotiateObject

func (h Helper) NegotiateObject(c *gin.Context, modtime time.Time, name string, obj interface{})

func (Helper) NewContext

func (h Helper) NewContext(c *gin.Context) context.Context

func (Helper) Response

func (h Helper) Response(c *gin.Context, code int, data interface{})

func (Helper) ResponseError

func (h Helper) ResponseError(c *gin.Context, err Error)

func (Helper) ShouldBindSession

func (h Helper) ShouldBindSession(c *gin.Context) (session *sessionid.Session, e error)

func (Helper) ShouldBindUserdata

func (h Helper) ShouldBindUserdata(c *gin.Context) (userdata *sessionid.Session, e error)

func (Helper) ToHTTPError

func (h Helper) ToHTTPError(c *gin.Context, name string, e error)

func (Helper) Websocket

func (h Helper) Websocket(c *gin.Context, responseHeader http.Header) (conn Websocket, e error)

type IHelper

type IHelper interface {
	Register(*grpc.ClientConn, *gin.RouterGroup)
}

type Websocket

type Websocket struct {
	*websocket.Conn
}

func (Websocket) Error

func (w Websocket) Error(e error) error

func (Websocket) Forward

func (w Websocket) Forward(f Forward)

func (Websocket) Send

func (w Websocket) Send(v interface{}) error

func (Websocket) SendBinary

func (w Websocket) SendBinary(b []byte) error

func (Websocket) SendMessage

func (w Websocket) SendMessage(m proto.Message) error

func (Websocket) Success

func (w Websocket) Success() error