rpc

Documentation

Index

• type Auth
• type CommonParams
• type CommonResult
  • func (cr CommonResult) Clear()
• type DKeyParams
• type PingParams
• type PingResult
• type RequestsCount

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 string `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 string `json:"token"`
}

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

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 DKeyParams

type DKeyParams struct {
	DKey string `json:"dKey"`
}

type PingParams

type PingParams struct{}

type PingResult

type PingResult struct {
	OK bool `json:"ok"`
}

type RequestsCount

type RequestsCount struct {
	TotalRequestsCount      string `json:"totalRequestsCount"`
	SuccessfulRequestsCount string `json:"successfulRequestsCount"`
}