vpcommonapi

package
v0.0.0-...-bf055c7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 6, 2019 License: GPL-3.0 Imports: 3 Imported by: 0

Documentation

Overview

Package vpcommonapi contains the common, base, shared by all api.

Index

Constants

View Source
const PackageCopyright = "Copyright (C)  2015, 2016  Christian Mauduit <ufoot@ufoot.org>" // PackageCopyright set by version.sh

PackageCopyright contains a short copyright notice.

View Source
const PackageEmail = "ufoot@ufoot.org" // PackageEmail set by version.sh

PackageEmail contains a contact email for the package.

View Source
const PackageLicense = "GNU GPL v3" // PackageLicense set by version.sh

PackageLicense contains a short license information.

View Source
const PackageName = "Vapor Toolkit" // PackageName set by version.sh

PackageName contains a readable name of the package, suitable for display.

View Source
const PackageTarname = "vapor" // PackageTarname set by version.sh

PackageTarname contains a short name of the package, suitable for a filename.

View Source
const PackageURL = "https://github.com/ufoot/vapor" // PackageURL set by version.sh

PackageURL contains the address of the project homepage.

View Source
const VersionMajor = 0 // VersionMajor set by version.sh

VersionMajor is the project major version.

View Source
const VersionMinor = 3 // VersionMinor set by version.sh

VersionMinor is the project minor version.

View Source
const VersionStamp = "c6a4298" // VersionStamp set by version.sh

VersionStamp is the project stamp, possibly changes for each build.

Variables

View Source
var GoUnusedProtection__ int
View Source
var VpCommonApiUptimeResult_Success_DEFAULT int64

Functions

This section is empty.

Types

type Package

type Package struct {
	Tarname   string `thrift:"Tarname,1" json:"Tarname"`
	Name      string `thrift:"Name,2" json:"Name"`
	Email     string `thrift:"Email,3" json:"Email"`
	URL       string `thrift:"URL,4" json:"URL"`
	Copyright string `thrift:"Copyright,5" json:"Copyright"`
	License   string `thrift:"License,6" json:"License"`
}

Package contains informations about the program package, such as its name, email maintainer, homepage.

Attributes:

  • Tarname
  • Name
  • Email
  • URL
  • Copyright
  • License
var VpCommonApiGetPackageResult_Success_DEFAULT *Package

func NewPackage

func NewPackage() *Package

func (*Package) GetCopyright

func (p *Package) GetCopyright() string

func (*Package) GetEmail

func (p *Package) GetEmail() string

func (*Package) GetLicense

func (p *Package) GetLicense() string

func (*Package) GetName

func (p *Package) GetName() string

func (*Package) GetTarname

func (p *Package) GetTarname() string

func (*Package) GetURL

func (p *Package) GetURL() string

func (*Package) Read

func (p *Package) Read(iprot thrift.TProtocol) error

func (*Package) String

func (p *Package) String() string

func (*Package) Write

func (p *Package) Write(oprot thrift.TProtocol) error

type Version

type Version struct {
	Major int32  `thrift:"Major,1" json:"Major"`
	Minor int32  `thrift:"Minor,2" json:"Minor"`
	Stamp string `thrift:"Stamp,3" json:"Stamp"`
}

Version contains the program version, usefull what it is capable of.

Attributes:

  • Major
  • Minor
  • Stamp
var VpCommonApiGetVersionResult_Success_DEFAULT *Version

func NewVersion

func NewVersion() *Version

func (*Version) GetMajor

func (p *Version) GetMajor() int32

func (*Version) GetMinor

func (p *Version) GetMinor() int32

func (*Version) GetStamp

func (p *Version) GetStamp() string

func (*Version) Read

func (p *Version) Read(iprot thrift.TProtocol) error

func (*Version) String

func (p *Version) String() string

func (*Version) Write

func (p *Version) Write(oprot thrift.TProtocol) error

type VpCommonApi

type VpCommonApi interface {

	// Ping is a basic ping function, just to check connection is up.
	Ping() (err error)
	// GetVersion returns the program version.
	GetVersion() (r *Version, err error)
	// GetPackage returns the program package information.
	GetPackage() (r *Package, err error)
	// Uptime returns the uptime in seconds.
	Uptime() (r int64, err error)
}

type VpCommonApiClient

type VpCommonApiClient struct {
	Transport       thrift.TTransport
	ProtocolFactory thrift.TProtocolFactory
	InputProtocol   thrift.TProtocol
	OutputProtocol  thrift.TProtocol
	SeqId           int32
}

VpCommonApi is the basic stuff any program should implement.

func NewVpCommonApiClientProtocol

func NewVpCommonApiClientProtocol(t thrift.TTransport, iprot thrift.TProtocol, oprot thrift.TProtocol) *VpCommonApiClient

func (*VpCommonApiClient) GetPackage

func (p *VpCommonApiClient) GetPackage() (r *Package, err error)

GetPackage returns the program package information.

func (*VpCommonApiClient) GetVersion

func (p *VpCommonApiClient) GetVersion() (r *Version, err error)

GetVersion returns the program version.

func (*VpCommonApiClient) Ping

func (p *VpCommonApiClient) Ping() (err error)

Ping is a basic ping function, just to check connection is up.

func (*VpCommonApiClient) Uptime

func (p *VpCommonApiClient) Uptime() (r int64, err error)

Uptime returns the uptime in seconds.

type VpCommonApiGetPackageArgs

type VpCommonApiGetPackageArgs struct {
}

func NewVpCommonApiGetPackageArgs

func NewVpCommonApiGetPackageArgs() *VpCommonApiGetPackageArgs

func (*VpCommonApiGetPackageArgs) Read

func (*VpCommonApiGetPackageArgs) String

func (p *VpCommonApiGetPackageArgs) String() string

func (*VpCommonApiGetPackageArgs) Write

type VpCommonApiGetPackageResult

type VpCommonApiGetPackageResult struct {
	Success *Package `thrift:"success,0" json:"success,omitempty"`
}

Attributes:

  • Success

func NewVpCommonApiGetPackageResult

func NewVpCommonApiGetPackageResult() *VpCommonApiGetPackageResult

func (*VpCommonApiGetPackageResult) GetSuccess

func (p *VpCommonApiGetPackageResult) GetSuccess() *Package

func (*VpCommonApiGetPackageResult) IsSetSuccess

func (p *VpCommonApiGetPackageResult) IsSetSuccess() bool

func (*VpCommonApiGetPackageResult) Read

func (*VpCommonApiGetPackageResult) String

func (p *VpCommonApiGetPackageResult) String() string

func (*VpCommonApiGetPackageResult) Write

type VpCommonApiGetVersionArgs

type VpCommonApiGetVersionArgs struct {
}

func NewVpCommonApiGetVersionArgs

func NewVpCommonApiGetVersionArgs() *VpCommonApiGetVersionArgs

func (*VpCommonApiGetVersionArgs) Read

func (*VpCommonApiGetVersionArgs) String

func (p *VpCommonApiGetVersionArgs) String() string

func (*VpCommonApiGetVersionArgs) Write

type VpCommonApiGetVersionResult

type VpCommonApiGetVersionResult struct {
	Success *Version `thrift:"success,0" json:"success,omitempty"`
}

Attributes:

  • Success

func NewVpCommonApiGetVersionResult

func NewVpCommonApiGetVersionResult() *VpCommonApiGetVersionResult

func (*VpCommonApiGetVersionResult) GetSuccess

func (p *VpCommonApiGetVersionResult) GetSuccess() *Version

func (*VpCommonApiGetVersionResult) IsSetSuccess

func (p *VpCommonApiGetVersionResult) IsSetSuccess() bool

func (*VpCommonApiGetVersionResult) Read

func (*VpCommonApiGetVersionResult) String

func (p *VpCommonApiGetVersionResult) String() string

func (*VpCommonApiGetVersionResult) Write

type VpCommonApiPingArgs

type VpCommonApiPingArgs struct {
}

func NewVpCommonApiPingArgs

func NewVpCommonApiPingArgs() *VpCommonApiPingArgs

func (*VpCommonApiPingArgs) Read

func (p *VpCommonApiPingArgs) Read(iprot thrift.TProtocol) error

func (*VpCommonApiPingArgs) String

func (p *VpCommonApiPingArgs) String() string

func (*VpCommonApiPingArgs) Write

func (p *VpCommonApiPingArgs) Write(oprot thrift.TProtocol) error

type VpCommonApiPingResult

type VpCommonApiPingResult struct {
}

func NewVpCommonApiPingResult

func NewVpCommonApiPingResult() *VpCommonApiPingResult

func (*VpCommonApiPingResult) Read

func (*VpCommonApiPingResult) String

func (p *VpCommonApiPingResult) String() string

func (*VpCommonApiPingResult) Write

func (p *VpCommonApiPingResult) Write(oprot thrift.TProtocol) error

type VpCommonApiProcessor

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

func NewVpCommonApiProcessor

func NewVpCommonApiProcessor(handler VpCommonApi) *VpCommonApiProcessor

func (*VpCommonApiProcessor) AddToProcessorMap

func (p *VpCommonApiProcessor) AddToProcessorMap(key string, processor thrift.TProcessorFunction)

func (*VpCommonApiProcessor) GetProcessorFunction

func (p *VpCommonApiProcessor) GetProcessorFunction(key string) (processor thrift.TProcessorFunction, ok bool)

func (*VpCommonApiProcessor) Process

func (p *VpCommonApiProcessor) Process(iprot, oprot thrift.TProtocol) (success bool, err thrift.TException)

func (*VpCommonApiProcessor) ProcessorMap

func (p *VpCommonApiProcessor) ProcessorMap() map[string]thrift.TProcessorFunction

type VpCommonApiUptimeArgs

type VpCommonApiUptimeArgs struct {
}

func NewVpCommonApiUptimeArgs

func NewVpCommonApiUptimeArgs() *VpCommonApiUptimeArgs

func (*VpCommonApiUptimeArgs) Read

func (*VpCommonApiUptimeArgs) String

func (p *VpCommonApiUptimeArgs) String() string

func (*VpCommonApiUptimeArgs) Write

func (p *VpCommonApiUptimeArgs) Write(oprot thrift.TProtocol) error

type VpCommonApiUptimeResult

type VpCommonApiUptimeResult struct {
	Success *int64 `thrift:"success,0" json:"success,omitempty"`
}

Attributes:

  • Success

func NewVpCommonApiUptimeResult

func NewVpCommonApiUptimeResult() *VpCommonApiUptimeResult

func (*VpCommonApiUptimeResult) GetSuccess

func (p *VpCommonApiUptimeResult) GetSuccess() int64

func (*VpCommonApiUptimeResult) IsSetSuccess

func (p *VpCommonApiUptimeResult) IsSetSuccess() bool

func (*VpCommonApiUptimeResult) Read

func (*VpCommonApiUptimeResult) String

func (p *VpCommonApiUptimeResult) String() string

func (*VpCommonApiUptimeResult) Write

Jump to

Keyboard shortcuts

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