rpc

Documentation

Index

• type Auth
• type AuthChallengeData
  • func (acd AuthChallengeData) Bytes() []byte
• type CommonParams
• type CommonResult
  • func (cr CommonResult) Clear()
• type CommonResultWithSuccess
• type DKeyParams
• type PageData
• type PingParams
• type PingResult
• type RequestId
• type RequestsCount
• type Success

Types

type Auth

type Auth struct {
	// User's IP address, in a common textual format.
	// This field must always be set for all requests.
	UserIPA simple.IPAS `json:"userIPA"`

	// Parsed IP address of a user.	B = Byte array.
	// This field is used only in internal communications.
	UserIPAB net.IP `json:"-"`

	// Authorisation token.
	// This field is set for all requests of a logged user.
	Token simple.WebTokenString `json:"token"`
}

Auth is authorisation data. This field must always be set for all requests except 'Ping'.

type AuthChallengeData

type AuthChallengeData []byte

func (AuthChallengeData) Bytes

func (acd AuthChallengeData) Bytes() []byte

type CommonParams

type CommonParams struct {
	// Authorisation data.
	Auth *Auth `json:"auth"`
}

type CommonResult

type CommonResult struct {
	// Time taken to perform the request, in milliseconds.
	TimeSpent int64 `json:"timeSpent,omitempty"`
}

func (CommonResult) Clear

func (cr CommonResult) Clear()

Clear sets values to zeroed state so that it is removed from JSON output.

type CommonResultWithSuccess

type CommonResultWithSuccess struct {
	CommonResult
	Success
}

type DKeyParams

type DKeyParams struct {
	DKey cmb.Text `json:"dKey"`
}

type PageData

type PageData struct {
	// Number of current page of items.
	PageNumber cmb.Count `json:"pageNumber"`

	// Number of all available pages.
	TotalPages cmb.Count `json:"totalPages"`

	// Number of items on a full page.
	PageSize cmb.Count `json:"pageSize"`

	// Number of items on the current page.
	ItemsOnPage cmb.Count `json:"itemsOnPage"`

	// Total number of all items.
	TotalItems cmb.Count `json:"totalItems"`
}

type PingParams

type PingParams struct{}

type PingResult

type PingResult struct {
	Success
}

type RequestId

type RequestId = uint

type RequestsCount

type RequestsCount struct {
	TotalRequestsCount      cmb.Text `json:"totalRequestsCount"`
	SuccessfulRequestsCount cmb.Text `json:"successfulRequestsCount"`
}

type Success

type Success struct {
	OK cmb.Flag `json:"ok"`
}