Add note to constants

Adds a small note to the constants.go file for creating a new api call
within libvirt.go
This commit is contained in:
Charlie Drage 2016-08-31 13:34:49 -04:00
parent 0417eacbef
commit 4603ca308d

View File

@ -15,8 +15,7 @@
// Package constants provides shared data for the libvirt package. // Package constants provides shared data for the libvirt package.
package constants package constants
// magic program numbers // protocol procedure numbers
// see: https://libvirt.org/git/?p=libvirt.git;a=blob_plain;f=src/remote/remote_protocol.x;hb=HEAD
const ( const (
ProgramVersion = 1 ProgramVersion = 1
ProgramRemote = 0x20008086 ProgramRemote = 0x20008086
@ -25,6 +24,17 @@ const (
) )
// libvirt procedure identifiers // 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 ( const (
ProcConnectOpen = 1 ProcConnectOpen = 1
ProcConnectClose = 2 ProcConnectClose = 2