baseProtocol

Documentation

Index

• Constants
• Variables
• func Err(statusCode int) (e error)
• func Get(statusCode int) (int, error)
• func GetStatusMsg(statusCode int) (s string)
• func New(retStatusMap map[int]GroupRetStatusCode) error
• func Override(retStatusMap map[int]GroupRetStatusCode)
• type BaseRequest
• type BaseResponse
  • func (b BaseResponse) Error() string
• type GroupRetStatusCode
• type RetStatus
  • func Create(statusCode int) (retStatus *RetStatus)
  • func CreateSuccess() (retStatus *RetStatus)
  • func (retStatus *RetStatus) Err() (e error)
  • func (r RetStatus) Error() string
  • func (retStatus *RetStatus) Is(retStatusCode int) bool
  • func (retStatus *RetStatus) IsSuccess() bool
  • func (r RetStatus) MarshalJSON() ([]byte, error)
  • func (retStatus *RetStatus) SetSuccess()
  • func (retStatus *RetStatus) Update(statusCode int)

Constants

const (
	Mysql                      = 3300 // Mysql基礎號段
	Mysql_InvalidInput         = 3301 // 無效參數
	Mysql_ResourceNotFound     = 3302 // 資源不存在
	Mysql_Unknown              = 3303 // 未知錯誤
	Mysql_InternalServiceError = 3304 // 內部服務錯誤
	Mysql_ExternalServiceError = 3305 // 外部服務錯誤
)

const Success = 10000 // Success : 正常返回

const UnknownStatusCode = "Unknown Status Code"

UnknownStatusCode : 未知代碼(可能未宣告const或map)

Variables

var ErrKeyConflict = errors.New("key conflict")

ErrKeyConflict : retStatusCode衝突

var ErrKeyOutOfRange = errors.New("key out of range")

ErrKeyOutOfRange : retStatusCode 超出可自訂範圍(自訂範圍為6位數)

Functions

func Err

func Err(statusCode int) (e error)

Err : 將 statusCode 轉為 error (自動判斷)

func Get

func Get(statusCode int) (int, error)

Get : 取得基於 retStatus 的 error / 若為 10000 則輸出 nil

func GetStatusMsg

func GetStatusMsg(statusCode int) (s string)

GetStatusMsg : 將 statusCode 轉為 error msg

func New

func New(retStatusMap map[int]GroupRetStatusCode) error

New : 新增額外的retCode

func Override

func Override(retStatusMap map[int]GroupRetStatusCode)

取代掉預設的 retStatusCode

Types

type BaseRequest

type BaseRequest struct {
	BaseUrl      string `json:"baseUrl"`
	BaseSendTime int64  `json:"baseSendTime"`
	BaseScgToken string `json:"baseScgToken"`
	MemberId     string `json:"memberId"`
}

type BaseResponse

type BaseResponse struct {
	RetStatus RetStatus `json:"retStatus"`
}

BaseResponse : 基礎回應資料結構

func (BaseResponse) Error

func (b BaseResponse) Error() string

type GroupRetStatusCode

type GroupRetStatusCode struct {
	CheckCode int    `json:"StatusCode,omitempty"`
	StatusMsg string `json:"StatusMsg"`
}

type RetStatus

type RetStatus struct {
	StatusCode int    `json:"StatusCode" qs:"StatusCode"`
	StatusMsg  string `json:"StatusMsg" qs:"StatusMsg"`
	SystemTime int64  `json:"SystemTime" qs:"SystemTime"`
	CheckCode  int    `json:"CheckCode" qs:"CheckCode"`
}

func Create

func Create(statusCode int) (retStatus *RetStatus)

Create : 新增retStatus

func CreateSuccess

func CreateSuccess() (retStatus *RetStatus)

CreateSuccess : 建立一個 Success 的 RetStatus

func (*RetStatus) Err

func (retStatus *RetStatus) Err() (e error)

Err : 將 statusCode 轉為 error (自動判斷)

func (RetStatus) Error

func (r RetStatus) Error() string

func (*RetStatus) Is

func (retStatus *RetStatus) Is(retStatusCode int) bool

IsSuccess : 判斷是否為指定 Code

func (*RetStatus) IsSuccess

func (retStatus *RetStatus) IsSuccess() bool

IsSuccess : 判斷是否為 Success

func (RetStatus) MarshalJSON

func (r RetStatus) MarshalJSON() ([]byte, error)

func (*RetStatus) SetSuccess

func (retStatus *RetStatus) SetSuccess()

SetSuccess : 設定為 Success

func (*RetStatus) Update

func (retStatus *RetStatus) Update(statusCode int)

Update : 更新retStatus