Documentation ¶
Overview ¶
Package vpcommonapi contains the common, base, shared by all api.
Index ¶
- Constants
- Variables
- type Package
- func (p *Package) GetCopyright() string
- func (p *Package) GetEmail() string
- func (p *Package) GetLicense() string
- func (p *Package) GetName() string
- func (p *Package) GetTarname() string
- func (p *Package) GetURL() string
- func (p *Package) Read(iprot thrift.TProtocol) error
- func (p *Package) String() string
- func (p *Package) Write(oprot thrift.TProtocol) error
- type Version
- type VpCommonApi
- type VpCommonApiClient
- type VpCommonApiGetPackageArgs
- type VpCommonApiGetPackageResult
- func (p *VpCommonApiGetPackageResult) GetSuccess() *Package
- func (p *VpCommonApiGetPackageResult) IsSetSuccess() bool
- func (p *VpCommonApiGetPackageResult) Read(iprot thrift.TProtocol) error
- func (p *VpCommonApiGetPackageResult) String() string
- func (p *VpCommonApiGetPackageResult) Write(oprot thrift.TProtocol) error
- type VpCommonApiGetVersionArgs
- type VpCommonApiGetVersionResult
- func (p *VpCommonApiGetVersionResult) GetSuccess() *Version
- func (p *VpCommonApiGetVersionResult) IsSetSuccess() bool
- func (p *VpCommonApiGetVersionResult) Read(iprot thrift.TProtocol) error
- func (p *VpCommonApiGetVersionResult) String() string
- func (p *VpCommonApiGetVersionResult) Write(oprot thrift.TProtocol) error
- type VpCommonApiPingArgs
- type VpCommonApiPingResult
- type VpCommonApiProcessor
- func (p *VpCommonApiProcessor) AddToProcessorMap(key string, processor thrift.TProcessorFunction)
- func (p *VpCommonApiProcessor) GetProcessorFunction(key string) (processor thrift.TProcessorFunction, ok bool)
- func (p *VpCommonApiProcessor) Process(iprot, oprot thrift.TProtocol) (success bool, err thrift.TException)
- func (p *VpCommonApiProcessor) ProcessorMap() map[string]thrift.TProcessorFunction
- type VpCommonApiUptimeArgs
- type VpCommonApiUptimeResult
Constants ¶
const PackageCopyright = "Copyright (C) 2015, 2016 Christian Mauduit <ufoot@ufoot.org>" // PackageCopyright set by version.sh
PackageCopyright contains a short copyright notice.
const PackageEmail = "ufoot@ufoot.org" // PackageEmail set by version.sh
PackageEmail contains a contact email for the package.
const PackageLicense = "GNU GPL v3" // PackageLicense set by version.sh
PackageLicense contains a short license information.
const PackageName = "Vapor Toolkit" // PackageName set by version.sh
PackageName contains a readable name of the package, suitable for display.
const PackageTarname = "vapor" // PackageTarname set by version.sh
PackageTarname contains a short name of the package, suitable for a filename.
const PackageURL = "https://github.com/ufoot/vapor" // PackageURL set by version.sh
PackageURL contains the address of the project homepage.
const VersionMajor = 0 // VersionMajor set by version.sh
VersionMajor is the project major version.
const VersionMinor = 3 // VersionMinor set by version.sh
VersionMinor is the project minor version.
const VersionStamp = "c6a4298" // VersionStamp set by version.sh
VersionStamp is the project stamp, possibly changes for each build.
Variables ¶
var GoUnusedProtection__ int
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
- URL
- Copyright
- License
var VpCommonApiGetPackageResult_Success_DEFAULT *Package
func NewPackage ¶
func NewPackage() *Package
func (*Package) GetCopyright ¶
func (*Package) GetLicense ¶
func (*Package) GetTarname ¶
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
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 NewVpCommonApiClientFactory ¶
func NewVpCommonApiClientFactory(t thrift.TTransport, f thrift.TProtocolFactory) *VpCommonApiClient
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 (p *VpCommonApiGetPackageArgs) Read(iprot thrift.TProtocol) error
func (*VpCommonApiGetPackageArgs) String ¶
func (p *VpCommonApiGetPackageArgs) String() string
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 (p *VpCommonApiGetPackageResult) Read(iprot thrift.TProtocol) error
func (*VpCommonApiGetPackageResult) String ¶
func (p *VpCommonApiGetPackageResult) String() string
type VpCommonApiGetVersionArgs ¶
type VpCommonApiGetVersionArgs struct { }
func NewVpCommonApiGetVersionArgs ¶
func NewVpCommonApiGetVersionArgs() *VpCommonApiGetVersionArgs
func (*VpCommonApiGetVersionArgs) Read ¶
func (p *VpCommonApiGetVersionArgs) Read(iprot thrift.TProtocol) error
func (*VpCommonApiGetVersionArgs) String ¶
func (p *VpCommonApiGetVersionArgs) String() string
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 (p *VpCommonApiGetVersionResult) Read(iprot thrift.TProtocol) error
func (*VpCommonApiGetVersionResult) String ¶
func (p *VpCommonApiGetVersionResult) String() string
type VpCommonApiPingArgs ¶
type VpCommonApiPingArgs struct { }
func NewVpCommonApiPingArgs ¶
func NewVpCommonApiPingArgs() *VpCommonApiPingArgs
func (*VpCommonApiPingArgs) String ¶
func (p *VpCommonApiPingArgs) String() string
type VpCommonApiPingResult ¶
type VpCommonApiPingResult struct { }
func NewVpCommonApiPingResult ¶
func NewVpCommonApiPingResult() *VpCommonApiPingResult
func (*VpCommonApiPingResult) Read ¶
func (p *VpCommonApiPingResult) Read(iprot thrift.TProtocol) error
func (*VpCommonApiPingResult) String ¶
func (p *VpCommonApiPingResult) String() string
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 (p *VpCommonApiUptimeArgs) Read(iprot thrift.TProtocol) error
func (*VpCommonApiUptimeArgs) String ¶
func (p *VpCommonApiUptimeArgs) String() string
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 (p *VpCommonApiUptimeResult) Read(iprot thrift.TProtocol) error
func (*VpCommonApiUptimeResult) String ¶
func (p *VpCommonApiUptimeResult) String() string