common

package

v0.0.29 Latest Latest Go to latest Published: May 13, 2024 License: GPL-3.0 Imports: 12 Imported by: 13

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/VaalaCat/frp-panel

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ErrResp[T RespType](c *gin.Context, origin *T, err string)
func ErrUnAuthorized(c *gin.Context, err string)
func GetProtoRequest[T ReqType](c *gin.Context) (r *T, err error)
func GetServerMessageRequest[T ReqType](b []byte, r *T, trans func(b []byte, m protoreflect.ProtoMessage) error) (err error)
func GetUserInfo(c context.Context) models.UserInfo
func GlobalClientID(username, clientType, clientID string) string
func OKResp[T RespType](c *gin.Context, origin *T)
func ProtoResp[T RespType](origin *T) (*pb.ClientMessage, error)
func Wrapper[T ReqType, U RespType](handler func(context.Context, *T) (*U, error)) func(c *gin.Context)
func WrapperServerMsg[T ReqType, U RespType](req *pb.ServerMessage, handler func(context.Context, *T) (*U, error)) *pb.ClientMessage
type ReqType
type RespType
type Result

Constants ¶

View Source

const (
	AuthorizationKey    = "authorization"
	SetAuthorizationKey = "x-set-authorization"
	MsgKey              = "msg"
	UserIDKey           = "x-vaala-userid"
	EndpointKey         = "endpoint"
	IpAddrKey           = "ipaddr"
	HeaderKey           = "header"
	MethodKey           = "method"
	UAKey               = "User-Agent"
	ContentTypeKey      = "Content-Type"
	TraceIDKey          = "TraceID"
	TokenKey            = "token"
	FRPAuthTokenKey     = "token"
	ErrKey              = "err"
	UserInfoKey         = "x-vaala-userinfo"
	FRPClientIDKey      = "x-vaala-frp-client-id"
)

View Source

const (
	ErrInvalidRequest   = "invalid request"
	ErrUserInfoNotValid = "user info not valid"
	ErrInternalError    = "internal error"
	ErrParamNotValid    = "param not valid"
	ErrDB               = "database error"
	ErrNotFound         = "data not found"
	ErrCodeNotFound     = "code not found"
	ErrCodeAlreadyUsed  = "code already used"
)

View Source

const (
	StatusPending = "pending"
	StatusSuccess = "success"
	StatusFailed  = "failed"
	StatusDone    = "done"
)

View Source

const (
	CliTypeServer = "server"
	CliTypeClient = "client"
)

View Source

const (
	DefaultServerID    = "default"
	DefaultAdminUserID = 1
)

View Source

const (
	ReqSuccess = "success"
)

View Source

const (
	TimeLayout = time.RFC3339
)

Variables ¶

This section is empty.

Functions ¶

func ErrResp ¶

func ErrResp[T RespType](c *gin.Context, origin *T, err string)

func ErrUnAuthorized ¶

func ErrUnAuthorized(c *gin.Context, err string)

func GetProtoRequest ¶

func GetProtoRequest[T ReqType](c *gin.Context) (r *T, err error)

func GetServerMessageRequest ¶

func GetServerMessageRequest[T ReqType](b []byte, r *T, trans func(b []byte, m protoreflect.ProtoMessage) error) (err error)

func GetUserInfo ¶

func GetUserInfo(c context.Context) models.UserInfo

func GlobalClientID ¶

func GlobalClientID(username, clientType, clientID string) string

func OKResp ¶

func OKResp[T RespType](c *gin.Context, origin *T)

func ProtoResp ¶

func ProtoResp[T RespType](origin *T) (*pb.ClientMessage, error)

func Wrapper ¶

func Wrapper[T ReqType, U RespType](handler func(context.Context, *T) (*U, error)) func(c *gin.Context)

func WrapperServerMsg ¶

func WrapperServerMsg[T ReqType, U RespType](req *pb.ServerMessage, handler func(context.Context, *T) (*U, error)) *pb.ClientMessage

Types ¶

type ReqType ¶

type ReqType interface {
	pb.UpdateFRPCRequest | pb.RemoveFRPCRequest |
		pb.UpdateFRPSRequest | pb.RemoveFRPSRequest |
		pb.CommonRequest | pb.RegisterRequest | pb.LoginRequest |
		pb.InitClientRequest | pb.ListClientsRequest | pb.GetClientRequest |
		pb.DeleteClientRequest |
		pb.InitServerRequest | pb.ListServersRequest | pb.GetServerRequest |
		pb.DeleteServerRequest |
		pb.GetUserInfoRequest | pb.UpdateUserInfoRequest |
		pb.GetPlatformInfoRequest | pb.GetClientsStatusRequest |
		pb.GetClientCertRequest |
		pb.StartFRPCRequest | pb.StopFRPCRequest | pb.StartFRPSRequest | pb.StopFRPSRequest
}

type RespType ¶

type RespType interface {
	pb.UpdateFRPCResponse | pb.RemoveFRPCResponse |
		pb.UpdateFRPSResponse | pb.RemoveFRPSResponse |
		pb.CommonResponse | pb.RegisterResponse | pb.LoginResponse |
		pb.InitClientResponse | pb.ListClientsResponse | pb.GetClientResponse |
		pb.DeleteClientResponse |
		pb.InitServerResponse | pb.ListServersResponse | pb.GetServerResponse |
		pb.DeleteServerResponse |
		pb.GetUserInfoResponse | pb.UpdateUserInfoResponse |
		pb.GetPlatformInfoResponse | pb.GetClientsStatusResponse |
		pb.GetClientCertResponse |
		pb.StartFRPCResponse | pb.StopFRPCResponse | pb.StartFRPSResponse | pb.StopFRPSResponse
}

type Result ¶

type Result struct {
	Code int         `json:"code,omitempty"`
	Msg  string      `json:"msg,omitempty"`
	Data gin.H       `json:"data,omitempty"`
	Body interface{} `json:"body,omitempty"`
}

func Err ¶

func Err(msg string) *Result

func OK ¶

func OK(msg string) *Result

func UnAuth ¶

func UnAuth(msg string) *Result

func (*Result) WithBody ¶

func (r *Result) WithBody(body interface{}) *Result

func (*Result) WithData ¶

func (r *Result) WithData(data gin.H) *Result

func (*Result) WithKeyValue ¶

func (r *Result) WithKeyValue(key string, value interface{}) *Result

func (*Result) WithMsg ¶

func (r *Result) WithMsg(message string) *Result

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL