vpbus

Documentation

Overview

Package vpbus contains the implementation of the Golang server callbacks called by the C++ client GUI.

Index

• Constants
• type VpBus
  • func New() *VpBus
  • func (bus *VpBus) GetPackage() (r *vpcommonapi.Package, err error)
  • func (bus *VpBus) GetVersion() (r *vpcommonapi.Version, err error)
  • func (bus *VpBus) Halt() (err error)
  • func (bus *VpBus) Ping() (err error)
  • func (bus *VpBus) Uptime() (r int64, err error)

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.

Types

type VpBus

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

VpBus is an implementation of VpBusApi interface.

func New

func New() *VpBus

New creates a new VpBus object, to act as a server callback.

func (*VpBus) GetPackage

func (bus *VpBus) GetPackage() (r *vpcommonapi.Package, err error)

GetPackage returns the version of the program.

func (*VpBus) GetVersion

func (bus *VpBus) GetVersion() (r *vpcommonapi.Version, err error)

GetVersion returns the version of the program.

func (*VpBus) Halt

func (bus *VpBus) Halt() (err error)

Halt stops the server.

func (*VpBus) Ping

func (bus *VpBus) Ping() (err error)

Ping is just here to make the server pingable, Thriftly speaking.

func (*VpBus) Uptime

func (bus *VpBus) Uptime() (r int64, err error)

Uptime returns how many seconds the server has been up.