client

Documentation

Index

• Constants
• func Ensure(reqID string, code int, message string) error
• type APIError
  • func (e *APIError) Error() string
• type CheckActionData
• type Client
  • func NewClient(config *config.Config) *Client
  • func (c *Client) CancelSealing(sealingID string) error
  • func (c *Client) CheckAction(sealingID, action string, t *int64) (*CheckActionData, error)
  • func (c *Client) GetSealing(sealingID string) (*SealingData, error)
  • func (c *Client) Request(method, path string, reqData interface{}, respData interface{}) (err error)
  • func (c *Client) UpdateAction(sealingID, action string, actionStatus string) error
• type RespBody
• type SealingData

Constants

const (
	// CodeNoPredictedData 说明目标时间点没有找到对应的短期预测数据
	CodeNoPredictedData = 20111
)

const CodeSuccess = 0

CodeSuccess 是请求正确响应时给出的 code 值

Functions

func Ensure

func Ensure(reqID string, code int, message string) error

Ensure 检查 code & message 并在响应不正确时构造错误实例

Types

type APIError

type APIError struct {
	ReqID   string
	Code    int
	Message string
}

APIError 是接口本身报错时给出的 error 类型

func (*APIError) Error

func (e *APIError) Error() string

type CheckActionData

type CheckActionData struct {
	Ok   bool `json:"ok"`
	Wait int  `json:"wait"`
}

CheckActionData 是检查 Action 是否可执行的返回结果

type Client

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

Client is the api client for Gas APIs

func NewClient

func NewClient(config *config.Config) *Client

NewClient creates Gas Client

func (*Client) CancelSealing

func (c *Client) CancelSealing(sealingID string) error

CancelSealing 标记取消 sealingID 对应

func (*Client) CheckAction

func (c *Client) CheckAction(sealingID, action string, t *int64) (*CheckActionData, error)

CheckAction 检查 Action 是否可执行

func (*Client) GetSealing

func (c *Client) GetSealing(sealingID string) (*SealingData, error)

GetSealing 获取 sealingID 对应的条目信息

func (*Client) Request

func (c *Client) Request(method, path string, reqData interface{}, respData interface{}) (err error)

Request 封装请求 gas 接口的公共逻辑

func (*Client) UpdateAction

func (c *Client) UpdateAction(sealingID, action string, actionStatus string) error

UpdateAction 调用接口更新 action 状态

type RespBody

type RespBody struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
}

RespBody 是所有接口响应 body 的标准格式

type SealingData

type SealingData struct {
	MinerID        string `json:"Miner_ID"`
	SealingID      string `json:"Sealing_ID"`
	PSSStartTime   int64  `json:"PSS_StartTime"`
	PSSWWaitTime   int64  `json:"PSSW_WaitTime"`
	PreCSStartTime int64  `json:"PreCS_StartTime"`
	WSTime         int64  `json:"WS_Time"`
	CStartTime     int64  `json:"C_StartTime"`
	CWTime         int64  `json:"CW_Time"`
	ProCSStartTime int64  `json:"ProCS_StartTime"`
	ProCSEndTime   int64  `json:"ProCS_EndTime"`
	SealingStatus  int    `json:"Sealing_Status"`
	CancelTime     int64  `json:"Cancel_Time"`
	CreateTime     int64  `json:"Create_Time"`
	UpdateTime     int64  `json:"Update_Time"`
}

SealingData 是 sealing 条目的内容