Merge pull request #8 from cdrage/update-docs

Add note to constants
This commit is contained in:
Matt Layher 2016-08-31 16:34:22 -04:00 committed by GitHub
commit 016a7d47c3
2 changed files with 13 additions and 2 deletions

View File

@ -11,3 +11,4 @@ Contributors
------------
Justin Kim <justin@digitalocean.com>
Ricky Medina <rm@do.co>
Charlie Drage <charlie@charliedrage.com>

View File

@ -15,8 +15,7 @@
// Package constants provides shared data for the libvirt package.
package constants
// magic program numbers
// see: https://libvirt.org/git/?p=libvirt.git;a=blob_plain;f=src/remote/remote_protocol.x;hb=HEAD
// protocol procedure numbers
const (
ProgramVersion = 1
ProgramRemote = 0x20008086
@ -25,6 +24,17 @@ const (
)
// libvirt procedure identifiers
// These are libvirt procedure numbers which correspond to each respective
// API call between remote_internal driver and libvirtd. Although stable.
// Each call is identified by a unique number which *may change at any time*.
//
// Examples:
// REMOTE_PROC_CONNECT_OPEN = 1
// REMOTE_PROC_DOMAIN_DEFINE_XML = 11
// REMOTE_PROC_DOMAIN_MIGRATE_SET_MAX_SPEED = 207,
//
// See:
// https://libvirt.org/git/?p=libvirt.git;a=blob_plain;f=src/remote/remote_protocol.x;hb=HEAD
const (
ProcConnectOpen = 1
ProcConnectClose = 2