External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 05:35:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

docstring: remove 'v' from since metadata

Browse Source 
Since: v1.2.3 -> Since: 1.2.3

Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
This commit is contained in:
Victor Toso 2022-05-04 13:11:23 +02:00 committed by Andrea Bolognani
parent 97ef63860a
commit dddf047dd1
34 changed files with 2189 additions and 2189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
include/libvirt/libvirt-admin.h
View File

@ -38,7 +38,7 @@ extern "C" {
* a virAdmConnect is a private structure representing a connection to
* libvirt daemon.
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef struct _virAdmConnect virAdmConnect;
@ -48,7 +48,7 @@ typedef struct _virAdmConnect virAdmConnect;
* a virAdmServer is a private structure and client-side representation of
* a remote server object
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef struct _virAdmServer virAdmServer;
@ -58,7 +58,7 @@ typedef struct _virAdmServer virAdmServer;
* a virAdmClient is a private structure and client-side representation of
* a remote server's client object (as server sees clients connected to it)
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef struct _virAdmClient virAdmClient;
@ -69,7 +69,7 @@ typedef struct _virAdmClient virAdmClient;
* this is the type used to reference a connection to the daemon
* in the API.
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef virAdmConnect *virAdmConnectPtr;
@ -80,7 +80,7 @@ typedef virAdmConnect *virAdmConnectPtr;
* this is the type used to reference client-side representation of a
* remote server object throughout all the APIs.
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef virAdmServer *virAdmServerPtr;
@ -91,7 +91,7 @@ typedef virAdmServer *virAdmServerPtr;
* this is the type used to reference client-side representation of a
* client object throughout all the APIs.
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef virAdmClient *virAdmClientPtr;
@ -121,7 +121,7 @@ int virAdmConnectGetLibVersion(virAdmConnectPtr conn,
*
* A callback to be registered, in case a connection was closed.
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef void (*virAdmConnectCloseFunc)(virAdmConnectPtr conn,
int reason,
@ -147,7 +147,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn,
* Macro for the threadpool minWorkers limit: represents the bottom limit to
* number of active workers in threadpool, as VIR_TYPED_PARAM_UINT.
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_THREADPOOL_WORKERS_MIN "minWorkers"
@ -159,7 +159,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn,
* The value of this limit has to be greater than VIR_THREADPOOL_WORKERS_MIN
* at all times.
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_THREADPOOL_WORKERS_MAX "maxWorkers"
@ -169,7 +169,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn,
* Macro for the threadpool nPrioWorkers attribute: represents the current number
* of active priority workers in threadpool, as VIR_TYPED_PARAM_UINT.
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_THREADPOOL_WORKERS_PRIORITY "prioWorkers"
@ -182,7 +182,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_THREADPOOL_WORKERS_FREE "freeWorkers"
@ -195,7 +195,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_THREADPOOL_WORKERS_CURRENT "nWorkers"
@ -208,7 +208,7 @@ virAdmServerPtr virAdmConnectLookupServer(virAdmConnectPtr conn,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_THREADPOOL_JOB_QUEUE_DEPTH "jobQueueDepth"
@ -233,15 +233,15 @@ int virAdmClientFree(virAdmClientPtr client);
/**
* virClientTransport:
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef enum {
VIR_CLIENT_TRANS_UNIX = 0, /* connection via UNIX socket (Since: v2.0.0) */
VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (Since: v2.0.0) */
VIR_CLIENT_TRANS_TLS, /* connection via encrypted TCP socket (Since: v2.0.0) */
VIR_CLIENT_TRANS_UNIX = 0, /* connection via UNIX socket (Since: 2.0.0) */
VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (Since: 2.0.0) */
VIR_CLIENT_TRANS_TLS, /* connection via encrypted TCP socket (Since: 2.0.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_CLIENT_TRANS_LAST /* (Since: v2.0.0) */
VIR_CLIENT_TRANS_LAST /* (Since: 2.0.0) */
# endif
} virClientTransport;
@ -265,7 +265,7 @@ virAdmServerLookupClient(virAdmServerPtr srv,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_CLIENT_INFO_READONLY "readonly"
@ -278,7 +278,7 @@ virAdmServerLookupClient(virAdmServerPtr srv,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_CLIENT_INFO_SOCKET_ADDR "sock_addr"
@ -291,7 +291,7 @@ virAdmServerLookupClient(virAdmServerPtr srv,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_CLIENT_INFO_SASL_USER_NAME "sasl_user_name"
@ -305,7 +305,7 @@ virAdmServerLookupClient(virAdmServerPtr srv,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_CLIENT_INFO_X509_DISTINGUISHED_NAME "tls_x509_dname"
@ -319,7 +319,7 @@ virAdmServerLookupClient(virAdmServerPtr srv,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_CLIENT_INFO_UNIX_USER_ID "unix_user_id"
@ -333,7 +333,7 @@ virAdmServerLookupClient(virAdmServerPtr srv,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_CLIENT_INFO_UNIX_USER_NAME "unix_user_name"
@ -347,7 +347,7 @@ virAdmServerLookupClient(virAdmServerPtr srv,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_CLIENT_INFO_UNIX_GROUP_ID "unix_group_id"
@ -361,7 +361,7 @@ virAdmServerLookupClient(virAdmServerPtr srv,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_CLIENT_INFO_UNIX_GROUP_NAME "unix_group_name"
@ -375,7 +375,7 @@ virAdmServerLookupClient(virAdmServerPtr srv,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_CLIENT_INFO_UNIX_PROCESS_ID "unix_process_id"
@ -389,7 +389,7 @@ virAdmServerLookupClient(virAdmServerPtr srv,
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_CLIENT_INFO_SELINUX_CONTEXT "selinux_context"
@ -408,7 +408,7 @@ int virAdmClientClose(virAdmClientPtr client, unsigned int flags);
* Macro for per-server nclients_max limit: represents the upper limit to
* number of clients connected to the server, as uint.
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_SERVER_CLIENTS_MAX "nclients_max"
@ -421,7 +421,7 @@ int virAdmClientClose(virAdmClientPtr client, unsigned int flags);
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_SERVER_CLIENTS_CURRENT "nclients"
@ -432,7 +432,7 @@ int virAdmClientClose(virAdmClientPtr client, unsigned int flags);
* to number of clients connected to the server, but not authenticated yet,
* as VIR_TYPED_PARAM_UINT.
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_SERVER_CLIENTS_UNAUTH_MAX "nclients_unauth_max"
@ -446,7 +446,7 @@ int virAdmClientClose(virAdmClientPtr client, unsigned int flags);
* NOTE: This attribute is read-only and any attempt to set it will be denied
* by daemon
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_SERVER_CLIENTS_UNAUTH_CURRENT "nclients_unauth"

46
include/libvirt/libvirt-common.h.in
View File

@ -71,7 +71,7 @@ extern "C" {
* Macro providing the version of the library as
* version * 1,000,000 + minor * 1000 + micro
*
* Since: v0.0.1
* Since: 0.0.1
*/
# define LIBVIR_VERSION_NUMBER @LIBVIRT_VERSION_NUMBER@
@ -88,7 +88,7 @@ extern "C" {
* // some code that only works in 1.1.3 and newer
* #endif
*
* Since: v1.2.0
* Since: 1.2.0
*/
# define LIBVIR_CHECK_VERSION(major, minor, micro) \
((major) * 1000000 + (minor) * 1000 + (micro) <= LIBVIR_VERSION_NUMBER)
@ -108,23 +108,23 @@ extern "C" {
* abide by this requirement may lead to application deadlocks
* or crashes.
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef void (*virFreeCallback)(void *opaque);
/**
* virConnectCloseReason:
*
* Since: v0.10.0
* Since: 0.10.0
*/
typedef enum {
VIR_CONNECT_CLOSE_REASON_ERROR = 0, /* Misc I/O error (Since: v0.10.0) */
VIR_CONNECT_CLOSE_REASON_EOF = 1, /* End-of-file from server (Since: v0.10.0) */
VIR_CONNECT_CLOSE_REASON_KEEPALIVE = 2, /* Keepalive timer triggered (Since: v0.10.0) */
VIR_CONNECT_CLOSE_REASON_CLIENT = 3, /* Client requested it (Since: v0.10.0) */
VIR_CONNECT_CLOSE_REASON_ERROR = 0, /* Misc I/O error (Since: 0.10.0) */
VIR_CONNECT_CLOSE_REASON_EOF = 1, /* End-of-file from server (Since: 0.10.0) */
VIR_CONNECT_CLOSE_REASON_KEEPALIVE = 2, /* Keepalive timer triggered (Since: 0.10.0) */
VIR_CONNECT_CLOSE_REASON_CLIENT = 3, /* Client requested it (Since: 0.10.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_CONNECT_CLOSE_REASON_LAST /* (Since: v0.10.0) */
VIR_CONNECT_CLOSE_REASON_LAST /* (Since: 0.10.0) */
# endif
} virConnectCloseReason;
@ -133,19 +133,19 @@ typedef enum {
*
* Express the type of a virTypedParameter
*
* Since: v0.9.2
* Since: 0.9.2
*/
typedef enum {
VIR_TYPED_PARAM_INT = 1, /* integer case (Since: v0.9.2) */
VIR_TYPED_PARAM_UINT = 2, /* unsigned integer case (Since: v0.9.2) */
VIR_TYPED_PARAM_LLONG = 3, /* long long case (Since: v0.9.2) */
VIR_TYPED_PARAM_ULLONG = 4, /* unsigned long long case (Since: v0.9.2) */
VIR_TYPED_PARAM_DOUBLE = 5, /* double case (Since: v0.9.2) */
VIR_TYPED_PARAM_BOOLEAN = 6, /* boolean(character) case (Since: v0.9.2) */
VIR_TYPED_PARAM_STRING = 7, /* string case (Since: v0.9.8) */
VIR_TYPED_PARAM_INT = 1, /* integer case (Since: 0.9.2) */
VIR_TYPED_PARAM_UINT = 2, /* unsigned integer case (Since: 0.9.2) */
VIR_TYPED_PARAM_LLONG = 3, /* long long case (Since: 0.9.2) */
VIR_TYPED_PARAM_ULLONG = 4, /* unsigned long long case (Since: 0.9.2) */
VIR_TYPED_PARAM_DOUBLE = 5, /* double case (Since: 0.9.2) */
VIR_TYPED_PARAM_BOOLEAN = 6, /* boolean(character) case (Since: 0.9.2) */
VIR_TYPED_PARAM_STRING = 7, /* string case (Since: 0.9.8) */
# ifdef VIR_ENUM_SENTINELS
VIR_TYPED_PARAM_LAST /* (Since: v0.9.10) */
VIR_TYPED_PARAM_LAST /* (Since: 0.9.10) */
# endif
} virTypedParameterType;
@ -156,7 +156,7 @@ typedef enum {
*
* These enums should not conflict with those of virDomainModificationImpact.
*
* Since: v0.9.8
* Since: 0.9.8
*/
typedef enum {
/* 1 << 0 is reserved for virDomainModificationImpact */
@ -172,7 +172,7 @@ typedef enum {
* setting the flag can be used to reject servers that cannot
* return typed strings, even if no strings would be returned.
*
* Since: v0.9.8
* Since: 0.9.8
*/
VIR_TYPED_PARAM_STRING_OKAY = 1 << 2,
@ -183,7 +183,7 @@ typedef enum {
*
* Macro providing the field length of virTypedParameter name
*
* Since: v0.9.2
* Since: 0.9.2
*/
# define VIR_TYPED_PARAM_FIELD_LENGTH 80
@ -196,7 +196,7 @@ typedef enum {
* virMemoryParameter are aliases of this type, for use when
* targeting libvirt earlier than 0.9.2.
*
* Since: v0.9.2
* Since: 0.9.2
*/
typedef struct _virTypedParameter virTypedParameter;
@ -219,7 +219,7 @@ struct _virTypedParameter {
*
* a pointer to a virTypedParameter structure.
*
* Since: v0.9.2
* Since: 0.9.2
*/
typedef virTypedParameter *virTypedParameterPtr;

40
include/libvirt/libvirt-domain-checkpoint.h
View File

@ -35,7 +35,7 @@
* domain disks have been altered since a point in time, but by itself does
* not allow reverting back to that point in time.
*
* Since: v5.2.0
* Since: 5.2.0
*/
typedef struct _virDomainCheckpoint virDomainCheckpoint;
@ -46,7 +46,7 @@ typedef struct _virDomainCheckpoint virDomainCheckpoint;
* private structure, and is the type used to reference a domain
* checkpoint in the API.
*
* Since: v5.2.0
* Since: 5.2.0
*/
typedef virDomainCheckpoint *virDomainCheckpointPtr;
@ -57,17 +57,17 @@ virConnectPtr virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpoint);
/**
* virDomainCheckpointCreateFlags:
*
* Since: v5.6.0
* Since: 5.6.0
*/
typedef enum {
VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE = (1 << 0), /* Restore or alter
metadata (Since: v5.6.0) */
metadata (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_CREATE_QUIESCE = (1 << 1), /* use guest agent to
quiesce all mounted
file systems within
the domain (Since: v5.6.0) */
the domain (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_CREATE_REDEFINE_VALIDATE = (1 << 2), /* validate disk data state
when redefining a checkpoint (Since: v6.10.0) */
when redefining a checkpoint (Since: 6.10.0) */
} virDomainCheckpointCreateFlags;
/* Create a checkpoint using the current VM state. */
@ -77,14 +77,14 @@ virDomainCheckpointPtr virDomainCheckpointCreateXML(virDomainPtr domain,
/**
* virDomainCheckpointXMLFlags:
*
* Since: v5.6.0
* Since: 5.6.0
*/
typedef enum {
VIR_DOMAIN_CHECKPOINT_XML_SECURE = (1 << 0), /* Include sensitive data (Since: v5.6.0) */
VIR_DOMAIN_CHECKPOINT_XML_SECURE = (1 << 0), /* Include sensitive data (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_XML_NO_DOMAIN = (1 << 1), /* Suppress <domain>
subelement (Since: v5.6.0) */
subelement (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_XML_SIZE = (1 << 2), /* Include dynamic
per-<disk> size (Since: v5.6.0) */
per-<disk> size (Since: 5.6.0) */
} virDomainCheckpointXMLFlags;
/* Dump the XML of a checkpoint */
@ -101,23 +101,23 @@ char *virDomainCheckpointGetXMLDesc(virDomainCheckpointPtr checkpoint,
* recursive. Remaining bits come in groups; if all bits from a group
* are 0, then that group is not used to filter results.
*
* Since: v5.6.0
* Since: 5.6.0
*/
typedef enum {
VIR_DOMAIN_CHECKPOINT_LIST_ROOTS = (1 << 0), /* Filter by checkpoints
with no parents, when
listing a domain (Since: v5.6.0) */
listing a domain (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_LIST_DESCENDANTS = (1 << 0), /* List all descendants,
not just children, when
listing a checkpoint (Since: v5.6.0) */
listing a checkpoint (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_LIST_TOPOLOGICAL = (1 << 1), /* Ensure parents occur
before children in
the resulting list (Since: v5.6.0) */
the resulting list (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_LIST_LEAVES = (1 << 2), /* Filter by checkpoints
with no children (Since: v5.6.0) */
with no children (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_LIST_NO_LEAVES = (1 << 3), /* Filter by checkpoints
that have children (Since: v5.6.0) */
that have children (Since: 5.6.0) */
} virDomainCheckpointListFlags;
/* Get all checkpoint objects for this domain */
@ -144,12 +144,12 @@ virDomainCheckpointPtr virDomainCheckpointGetParent(virDomainCheckpointPtr check
*
* Delete a checkpoint
*
* Since: v5.6.0
* Since: 5.6.0
*/
typedef enum {
VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: v5.6.0) */
VIR_DOMAIN_CHECKPOINT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: v5.6.0) */
VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: v5.6.0) */
VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: 5.6.0) */
VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: 5.6.0) */
} virDomainCheckpointDeleteFlags;
int virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint,

74
include/libvirt/libvirt-domain-snapshot.h
View File

@ -35,7 +35,7 @@
* time, with the intent that the guest can be reverted back to that
* state at a later time.
*
* Since: v0.8.0
* Since: 0.8.0
*/
typedef struct _virDomainSnapshot virDomainSnapshot;
@ -45,7 +45,7 @@ typedef struct _virDomainSnapshot virDomainSnapshot;
* A virDomainSnapshotPtr is pointer to a virDomainSnapshot private structure,
* and is the type used to reference a domain snapshot in the API.
*
* Since: v0.8.0
* Since: 0.8.0
*/
typedef virDomainSnapshot *virDomainSnapshotPtr;
@ -56,32 +56,32 @@ virConnectPtr virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot);
/**
* virDomainSnapshotCreateFlags:
*
* Since: v0.9.5
* Since: 0.9.5
*/
typedef enum {
VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE = (1 << 0), /* Restore or alter
metadata (Since: v0.9.5) */
metadata (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT = (1 << 1), /* With redefine, make
snapshot current (Since: v0.9.5) */
snapshot current (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA = (1 << 2), /* Make snapshot without
remembering it (Since: v0.9.5) */
remembering it (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_CREATE_HALT = (1 << 3), /* Stop running guest
after snapshot (Since: v0.9.5) */
after snapshot (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY = (1 << 4), /* disk snapshot, not
full system (Since: v0.9.5) */
full system (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_CREATE_REUSE_EXT = (1 << 5), /* reuse any existing
external files (Since: v0.9.10) */
external files (Since: 0.9.10) */
VIR_DOMAIN_SNAPSHOT_CREATE_QUIESCE = (1 << 6), /* use guest agent to
quiesce all mounted
file systems within
the domain (Since: v0.9.10) */
the domain (Since: 0.9.10) */
VIR_DOMAIN_SNAPSHOT_CREATE_ATOMIC = (1 << 7), /* atomically avoid
partial changes (Since: v0.9.11) */
partial changes (Since: 0.9.11) */
VIR_DOMAIN_SNAPSHOT_CREATE_LIVE = (1 << 8), /* create the snapshot
while the guest is
running (Since: v1.0.1) */
running (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_CREATE_VALIDATE = (1 << 9), /* validate the XML
against the schema (Since: v5.6.0) */
against the schema (Since: 5.6.0) */
} virDomainSnapshotCreateFlags;
/* Take a snapshot of the current VM state */
@ -91,10 +91,10 @@ virDomainSnapshotPtr virDomainSnapshotCreateXML(virDomainPtr domain,
/**
* virDomainSnapshotXMLFlags:
*
* Since: v5.1.0
* Since: 5.1.0
*/
typedef enum {
VIR_DOMAIN_SNAPSHOT_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: v5.1.0) */
VIR_DOMAIN_SNAPSHOT_XML_SECURE = VIR_DOMAIN_XML_SECURE, /* dump security sensitive information too (Since: 5.1.0) */
} virDomainSnapshotXMLFlags;
/* Dump the XML of a snapshot */
@ -113,48 +113,48 @@ char *virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot,
* recursive. Remaining bits come in groups; if all bits from a group are
* 0, then that group is not used to filter results.
*
* Since: v0.9.5
* Since: 0.9.5
*/
typedef enum {
VIR_DOMAIN_SNAPSHOT_LIST_ROOTS = (1 << 0), /* Filter by snapshots
with no parents, when
listing a domain (Since: v0.9.5) */
listing a domain (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS = (1 << 0), /* List all descendants,
not just children, when
listing a snapshot (Since: v0.9.7) */
listing a snapshot (Since: 0.9.7) */
VIR_DOMAIN_SNAPSHOT_LIST_LEAVES = (1 << 2), /* Filter by snapshots
with no children (Since: v0.9.7) */
with no children (Since: 0.9.7) */
VIR_DOMAIN_SNAPSHOT_LIST_NO_LEAVES = (1 << 3), /* Filter by snapshots
that have children (Since: v0.9.13) */
that have children (Since: 0.9.13) */
VIR_DOMAIN_SNAPSHOT_LIST_METADATA = (1 << 1), /* Filter by snapshots
which have metadata (Since: v0.9.5) */
which have metadata (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_LIST_NO_METADATA = (1 << 4), /* Filter by snapshots
with no metadata (Since: v0.9.13) */
with no metadata (Since: 0.9.13) */
VIR_DOMAIN_SNAPSHOT_LIST_INACTIVE = (1 << 5), /* Filter by snapshots
taken while guest was
shut off (Since: v1.0.1) */
shut off (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_LIST_ACTIVE = (1 << 6), /* Filter by snapshots
taken while guest was
active, and with
memory state (Since: v1.0.1) */
memory state (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_LIST_DISK_ONLY = (1 << 7), /* Filter by snapshots
taken while guest was
active, but without
memory state (Since: v1.0.1) */
memory state (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_LIST_INTERNAL = (1 << 8), /* Filter by snapshots
stored internal to
disk images (Since: v1.0.1) */
disk images (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_LIST_EXTERNAL = (1 << 9), /* Filter by snapshots
that use files external
to disk images (Since: v1.0.1) */
to disk images (Since: 1.0.1) */
VIR_DOMAIN_SNAPSHOT_LIST_TOPOLOGICAL = (1 << 10), /* Ensure parents occur
before children in
the resulting list (Since: v5.2.0) */
the resulting list (Since: 5.2.0) */
} virDomainSnapshotListFlags;
/* Return the number of snapshots for this domain */
@ -211,13 +211,13 @@ int virDomainSnapshotHasMetadata(virDomainSnapshotPtr snapshot,
/**
* virDomainSnapshotRevertFlags:
*
* Since: v0.9.5
* Since: 0.9.5
*/
typedef enum {
VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING = 1 << 0, /* Run after revert (Since: v0.9.5) */
VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED = 1 << 1, /* Pause after revert (Since: v0.9.5) */
VIR_DOMAIN_SNAPSHOT_REVERT_FORCE = 1 << 2, /* Allow risky reverts (Since: v0.9.7) */
VIR_DOMAIN_SNAPSHOT_REVERT_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: v8.1.0) */
VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING = 1 << 0, /* Run after revert (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED = 1 << 1, /* Pause after revert (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_REVERT_FORCE = 1 << 2, /* Allow risky reverts (Since: 0.9.7) */
VIR_DOMAIN_SNAPSHOT_REVERT_RESET_NVRAM = 1 << 3, /* Re-initialize NVRAM from template (Since: 8.1.0) */
} virDomainSnapshotRevertFlags;
/* Revert the domain to a point-in-time snapshot. The
@ -232,12 +232,12 @@ int virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
*
* Delete a snapshot
*
* Since: v0.8.0
* Since: 0.8.0
*/
typedef enum {
VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: v0.8.0) */
VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: v0.9.5) */
VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: v0.9.5) */
VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN = (1 << 0), /* Also delete children (Since: 0.8.0) */
VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY = (1 << 1), /* Delete just metadata (Since: 0.9.5) */
VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY = (1 << 2), /* Delete just children (Since: 0.9.5) */
} virDomainSnapshotDeleteFlags;
int virDomainSnapshotDelete(virDomainSnapshotPtr snapshot,

1850
include/libvirt/libvirt-domain.h
View File

File diff suppressed because it is too large Load Diff

26
include/libvirt/libvirt-event.h
View File

@ -35,13 +35,13 @@
* to libvirt. A client app must translate to, and from POLL events when using
* this construct.
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef enum {
VIR_EVENT_HANDLE_READABLE = (1 << 0), /* (Since: v0.5.0) */
VIR_EVENT_HANDLE_WRITABLE = (1 << 1), /* (Since: v0.5.0) */
VIR_EVENT_HANDLE_ERROR = (1 << 2), /* (Since: v0.5.0) */
VIR_EVENT_HANDLE_HANGUP = (1 << 3), /* (Since: v0.5.0) */
VIR_EVENT_HANDLE_READABLE = (1 << 0), /* (Since: 0.5.0) */
VIR_EVENT_HANDLE_WRITABLE = (1 << 1), /* (Since: 0.5.0) */
VIR_EVENT_HANDLE_ERROR = (1 << 2), /* (Since: 0.5.0) */
VIR_EVENT_HANDLE_HANGUP = (1 << 3), /* (Since: 0.5.0) */
} virEventHandleType;
/**
@ -55,7 +55,7 @@ typedef enum {
* Callback for receiving file handle events. The callback will
* be invoked once for each event which is pending.
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef void (*virEventHandleCallback)(int watch, int fd, int events, void *opaque);
@ -84,7 +84,7 @@ typedef void (*virEventHandleCallback)(int watch, int fd, int events, void *opaq
* Returns -1 if the file handle cannot be registered, otherwise a handle
* watch number to be used for updating and unregistering for events
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef int (*virEventAddHandleFunc)(int fd, int event,
virEventHandleCallback cb,
@ -99,7 +99,7 @@ typedef int (*virEventAddHandleFunc)(int fd, int event,
* Part of the EventImpl, this user-provided callback is notified when
* events to listen on change
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef void (*virEventUpdateHandleFunc)(int watch, int event);
@ -116,7 +116,7 @@ typedef void (*virEventUpdateHandleFunc)(int watch, int event);
*
* Returns -1 if the file handle was not registered, 0 upon success
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef int (*virEventRemoveHandleFunc)(int watch);
@ -128,7 +128,7 @@ typedef int (*virEventRemoveHandleFunc)(int watch);
*
* callback for receiving timer events
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef void (*virEventTimeoutCallback)(int timer, void *opaque);
@ -148,7 +148,7 @@ typedef void (*virEventTimeoutCallback)(int timer, void *opaque);
*
* Returns a timer value
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef int (*virEventAddTimeoutFunc)(int timeout,
virEventTimeoutCallback cb,
@ -163,7 +163,7 @@ typedef int (*virEventAddTimeoutFunc)(int timeout,
* Part of the EventImpl, this user-defined callback updates an
* event timeout.
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef void (*virEventUpdateTimeoutFunc)(int timer, int timeout);
@ -179,7 +179,7 @@ typedef void (*virEventUpdateTimeoutFunc)(int timer, int timeout);
*
* Returns 0 on success, -1 on failure
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef int (*virEventRemoveTimeoutFunc)(int timer);

200
include/libvirt/libvirt-host.h
View File

@ -34,7 +34,7 @@
* a virConnect is a private structure representing a connection to
* the Hypervisor.
*
* Since: v0.0.1
* Since: 0.0.1
*/
typedef struct _virConnect virConnect;
@ -44,7 +44,7 @@ typedef struct _virConnect virConnect;
* a virConnectPtr is pointer to a virConnect private structure, this is the
* type used to reference a connection to the Hypervisor in the API.
*
* Since: v0.0.1
* Since: 0.0.1
*/
typedef virConnect *virConnectPtr;
@ -54,15 +54,15 @@ typedef virConnect *virConnectPtr;
* Flags to indicate which system-wide sleep state the host must be
* transitioned to.
*
* Since: v0.9.8
* Since: 0.9.8
*/
typedef enum {
VIR_NODE_SUSPEND_TARGET_MEM = 0, /* (Since: v0.9.8) */
VIR_NODE_SUSPEND_TARGET_DISK = 1, /* (Since: v0.9.8) */
VIR_NODE_SUSPEND_TARGET_HYBRID = 2, /* (Since: v0.9.8) */
VIR_NODE_SUSPEND_TARGET_MEM = 0, /* (Since: 0.9.8) */
VIR_NODE_SUSPEND_TARGET_DISK = 1, /* (Since: 0.9.8) */
VIR_NODE_SUSPEND_TARGET_HYBRID = 2, /* (Since: 0.9.8) */
# ifdef VIR_ENUM_SENTINELS
VIR_NODE_SUSPEND_TARGET_LAST /* This constant is subject to change (Since: v0.9.8) */
VIR_NODE_SUSPEND_TARGET_LAST /* This constant is subject to change (Since: 0.9.8) */
# endif
} virNodeSuspendTarget;
@ -71,7 +71,7 @@ typedef enum {
*
* a virStream is a private structure representing a data stream.
*
* Since: v0.7.2
* Since: 0.7.2
*/
typedef struct _virStream virStream;
@ -81,7 +81,7 @@ typedef struct _virStream virStream;
* a virStreamPtr is pointer to a virStream private structure, this is the
* type used to reference a data stream in the API.
*
* Since: v0.7.2
* Since: 0.7.2
*/
typedef virStream *virStreamPtr;
@ -91,7 +91,7 @@ typedef virStream *virStreamPtr;
* Macro providing the maximum length of the virSecurityLabel label string.
* Note that this value is based on that used by Labeled NFS.
*
* Since: v0.6.1
* Since: 0.6.1
*/
# define VIR_SECURITY_LABEL_BUFLEN (4096 + 1)
@ -102,7 +102,7 @@ typedef virStream *virStreamPtr;
* providing the security label and associated attributes for the specified
* domain.
*
* Since: v0.6.1
* Since: 0.6.1
*/
typedef struct _virSecurityLabel virSecurityLabel;
@ -116,7 +116,7 @@ struct _virSecurityLabel {
*
* a virSecurityLabelPtr is a pointer to a virSecurityLabel.
*
* Since: v0.6.1
* Since: 0.6.1
*/
typedef virSecurityLabel *virSecurityLabelPtr;
@ -125,7 +125,7 @@ typedef virSecurityLabel *virSecurityLabelPtr;
*
* Macro providing the maximum length of the virSecurityModel model string.
*
* Since: v0.6.1
* Since: 0.6.1
*/
# define VIR_SECURITY_MODEL_BUFLEN (256 + 1)
@ -134,7 +134,7 @@ typedef virSecurityLabel *virSecurityLabelPtr;
*
* Macro providing the maximum length of the virSecurityModel doi string.
*
* Since: v0.6.1
* Since: 0.6.1
*/
# define VIR_SECURITY_DOI_BUFLEN (256 + 1)
@ -145,7 +145,7 @@ typedef virSecurityLabel *virSecurityLabelPtr;
* providing the per-hypervisor security model and DOI attributes for the
* specified domain.
*
* Since: v0.6.1
* Since: 0.6.1
*/
typedef struct _virSecurityModel virSecurityModel;
@ -159,7 +159,7 @@ struct _virSecurityModel {
*
* a virSecurityModelPtr is a pointer to a virSecurityModel.
*
* Since: v0.6.1
* Since: 0.6.1
*/
typedef virSecurityModel *virSecurityModelPtr;
@ -176,7 +176,7 @@ typedef virSecurityModel *virSecurityModelPtr;
* accurate relection of the system hardware. See the virNodeGetInfo()
* API documentation for further guidance.
*
* Since: v0.1.0
* Since: 0.1.0
*/
typedef struct _virNodeInfo virNodeInfo;
@ -202,7 +202,7 @@ struct _virNodeInfo {
*
* Macro providing the field length of virNodeCPUStats
*
* Since: v0.9.3
* Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_FIELD_LENGTH 80
@ -211,10 +211,10 @@ struct _virNodeInfo {
*
* Value for specifying request for the total CPU time/utilization
*
* Since: v0.9.8
* Since: 0.9.8
*/
typedef enum {
VIR_NODE_CPU_STATS_ALL_CPUS = -1, /* (Since: v0.9.3) */
VIR_NODE_CPU_STATS_ALL_CPUS = -1, /* (Since: 0.9.3) */
} virNodeGetCPUStatsAllCPUs;
/**
@ -223,7 +223,7 @@ typedef enum {
* Macro for the cumulative CPU time which was spent by the kernel,
* since the node booting up (in nanoseconds).
*
* Since: v0.9.3
* Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_KERNEL "kernel"
@ -233,7 +233,7 @@ typedef enum {
* The cumulative CPU time which was spent by user processes,
* since the node booting up (in nanoseconds).
*
* Since: v0.9.3
* Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_USER "user"
@ -243,7 +243,7 @@ typedef enum {
* The cumulative idle CPU time,
* since the node booting up (in nanoseconds).
*
* Since: v0.9.3
* Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_IDLE "idle"
@ -253,7 +253,7 @@ typedef enum {
* The cumulative I/O wait CPU time,
* since the node booting up (in nanoseconds).
*
* Since: v0.9.3
* Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_IOWAIT "iowait"
@ -263,7 +263,7 @@ typedef enum {
* The cumulative interrupt CPU time,
* since the node booting up (in nanoseconds).
*
* Since: v1.2.2
* Since: 1.2.2
*/
# define VIR_NODE_CPU_STATS_INTR "intr"
@ -274,7 +274,7 @@ typedef enum {
* The usage value is in percent and 100% represents all CPUs of
* the node.
*
* Since: v0.9.3
* Since: 0.9.3
*/
# define VIR_NODE_CPU_STATS_UTILIZATION "utilization"
@ -284,7 +284,7 @@ typedef enum {
* a virNodeCPUStats is a structure filled by virNodeGetCPUStats()
* providing information about the CPU stats of the node.
*
* Since: v0.9.3
* Since: 0.9.3
*/
typedef struct _virNodeCPUStats virNodeCPUStats;
@ -298,7 +298,7 @@ struct _virNodeCPUStats {
*
* Macro providing the field length of virNodeMemoryStats
*
* Since: v0.9.3
* Since: 0.9.3
*/
# define VIR_NODE_MEMORY_STATS_FIELD_LENGTH 80
@ -307,10 +307,10 @@ struct _virNodeCPUStats {
*
* Value for specifying request for the total memory of all cells.
*
* Since: v0.9.8
* Since: 0.9.8
*/
typedef enum {
VIR_NODE_MEMORY_STATS_ALL_CELLS = -1, /* (Since: v0.9.3) */
VIR_NODE_MEMORY_STATS_ALL_CELLS = -1, /* (Since: 0.9.3) */
} virNodeGetMemoryStatsAllCells;
/**
@ -319,7 +319,7 @@ typedef enum {
* Macro for the total memory of specified cell:
* it represents the maximum memory.
*
* Since: v0.9.3
* Since: 0.9.3
*/
# define VIR_NODE_MEMORY_STATS_TOTAL "total"
@ -330,7 +330,7 @@ typedef enum {
* On Linux, it includes buffer and cached memory, in case of
* VIR_NODE_MEMORY_STATS_ALL_CELLS.
*
* Since: v0.9.3
* Since: 0.9.3
*/
# define VIR_NODE_MEMORY_STATS_FREE "free"
@ -340,7 +340,7 @@ typedef enum {
* Macro for the buffer memory: On Linux, it is only returned in case of
* VIR_NODE_MEMORY_STATS_ALL_CELLS.
*
* Since: v0.9.3
* Since: 0.9.3
*/
# define VIR_NODE_MEMORY_STATS_BUFFERS "buffers"
@ -350,7 +350,7 @@ typedef enum {
* Macro for the cached memory: On Linux, it is only returned in case of
* VIR_NODE_MEMORY_STATS_ALL_CELLS.
*
* Since: v0.9.3
* Since: 0.9.3
*/
# define VIR_NODE_MEMORY_STATS_CACHED "cached"
@ -360,7 +360,7 @@ typedef enum {
* a virNodeMemoryStats is a structure filled by virNodeGetMemoryStats()
* providing information about the memory of the node.
*
* Since: v0.9.3
* Since: 0.9.3
*/
typedef struct _virNodeMemoryStats virNodeMemoryStats;
@ -375,7 +375,7 @@ struct _virNodeMemoryStats {
* Macro for typed parameter that represents how many present pages
* to scan before the shared memory service goes to sleep.
*
* Since: v0.10.2
* Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_PAGES_TO_SCAN "shm_pages_to_scan"
@ -385,7 +385,7 @@ struct _virNodeMemoryStats {
* Macro for typed parameter that represents how many milliseconds
* the shared memory service should sleep before next scan.
*
* Since: v0.10.2
* Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_SLEEP_MILLISECS "shm_sleep_millisecs"
@ -395,7 +395,7 @@ struct _virNodeMemoryStats {
* Macro for typed parameter that represents how many the shared
* memory pages are being used.
*
* Since: v0.10.2
* Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_PAGES_SHARED "shm_pages_shared"
@ -405,7 +405,7 @@ struct _virNodeMemoryStats {
* Macro for typed parameter that represents how many sites are
* sharing the pages i.e. how much saved.
*
* Since: v0.10.2
* Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_PAGES_SHARING "shm_pages_sharing"
@ -415,7 +415,7 @@ struct _virNodeMemoryStats {
* Macro for typed parameter that represents how many pages unique
* but repeatedly checked for merging.
*
* Since: v0.10.2
* Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_PAGES_UNSHARED "shm_pages_unshared"
@ -425,7 +425,7 @@ struct _virNodeMemoryStats {
* Macro for typed parameter that represents how many pages changing
* too fast to be placed in a tree.
*
* Since: v0.10.2
* Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_PAGES_VOLATILE "shm_pages_volatile"
@ -435,7 +435,7 @@ struct _virNodeMemoryStats {
* Macro for typed parameter that represents how many times all
* mergeable areas have been scanned.
*
* Since: v0.10.2
* Since: 0.10.2
*/
# define VIR_NODE_MEMORY_SHARED_FULL_SCANS "shm_full_scans"
@ -449,7 +449,7 @@ struct _virNodeMemoryStats {
* pages from all nodes can be merged. Other values are reserved
* for future use.
*
* Since: v1.0.0
* Since: 1.0.0
*/
# define VIR_NODE_MEMORY_SHARED_MERGE_ACROSS_NODES "shm_merge_across_nodes"
@ -480,7 +480,7 @@ int virNodeGetCPUMap(virConnectPtr conn,
* This macro is to calculate the total number of CPUs supported
* but not necessary active in the host.
*
* Since: v0.1.4
* Since: 0.1.4
*/
# define VIR_NODEINFO_MAXCPUS(nodeinfo) ((nodeinfo).nodes*(nodeinfo).sockets*(nodeinfo).cores*(nodeinfo).threads)
@ -489,7 +489,7 @@ int virNodeGetCPUMap(virConnectPtr conn,
*
* a virNodeInfoPtr is a pointer to a virNodeInfo structure.
*
* Since: v0.1.0
* Since: 0.1.0
*/
typedef virNodeInfo *virNodeInfoPtr;
@ -498,7 +498,7 @@ typedef virNodeInfo *virNodeInfoPtr;
*
* a virNodeCPUStatsPtr is a pointer to a virNodeCPUStats structure.
*
* Since: v0.9.3
* Since: 0.9.3
*/
typedef virNodeCPUStats *virNodeCPUStatsPtr;
@ -507,7 +507,7 @@ typedef virNodeCPUStats *virNodeCPUStatsPtr;
*
* a virNodeMemoryStatsPtr is a pointer to a virNodeMemoryStats structure.
*
* Since: v0.9.3
* Since: 0.9.3
*/
typedef virNodeMemoryStats *virNodeMemoryStatsPtr;
@ -522,7 +522,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr;
*
* Macro represents the Platform Diffie-Hellman key, as VIR_TYPED_PARAMS_STRING.
*
* Since: v4.5.0
* Since: 4.5.0
*/
# define VIR_NODE_SEV_PDH "pdh"
@ -533,7 +533,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr;
* endorsement key (PEK), owner certificate authority (OCD) and chip
* endorsement key (CEK), as VIR_TYPED_PARAMS_STRING.
*
* Since: v4.5.0
* Since: 4.5.0
*/
# define VIR_NODE_SEV_CERT_CHAIN "cert-chain"
@ -542,7 +542,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr;
*
* Macro represents the CBit Position used by hypervisor when SEV is enabled.
*
* Since: v4.5.0
* Since: 4.5.0
*/
# define VIR_NODE_SEV_CBITPOS "cbitpos"
@ -552,7 +552,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr;
* Macro represents the number of bits we lose in physical address space
* when SEV is enabled in the guest.
*
* Since: v4.5.0
* Since: 4.5.0
*/
# define VIR_NODE_SEV_REDUCED_PHYS_BITS "reduced-phys-bits"
@ -562,7 +562,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr;
* Macro represents the number of SEV guests that can
* be run on the host, as a VIR_TYPED_PARAM_UINT.
*
* Since: v8.0.0
* Since: 8.0.0
*/
# define VIR_NODE_SEV_MAX_GUESTS "max-guests"
@ -572,7 +572,7 @@ typedef virNodeMemoryStats *virNodeMemoryStatsPtr;
* Macro represents the number of SEV-ES guests that can
* be run on the host, as a VIR_TYPED_PARAM_UINT.
*
* Since: v8.0.0
* Since: 8.0.0
*/
# define VIR_NODE_SEV_MAX_ES_GUESTS "max-es-guests"
@ -586,31 +586,31 @@ int virNodeGetSEVInfo (virConnectPtr conn,
*
* Flags when opening a connection to a hypervisor
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef enum {
VIR_CONNECT_RO = (1 << 0), /* A readonly connection (Since: v0.4.1) */
VIR_CONNECT_NO_ALIASES = (1 << 1), /* Don't try to resolve URI aliases (Since: v0.9.7) */
VIR_CONNECT_RO = (1 << 0), /* A readonly connection (Since: 0.4.1) */
VIR_CONNECT_NO_ALIASES = (1 << 1), /* Don't try to resolve URI aliases (Since: 0.9.7) */
} virConnectFlags;
/**
* virConnectCredentialType:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef enum {
VIR_CRED_USERNAME = 1, /* Identity to act as (Since: v0.4.1) */
VIR_CRED_AUTHNAME = 2, /* Identify to authorize as (Since: v0.4.1) */
VIR_CRED_LANGUAGE = 3, /* RFC 1766 languages, comma separated (Since: v0.4.1) */
VIR_CRED_CNONCE = 4, /* client supplies a nonce (Since: v0.4.1) */
VIR_CRED_PASSPHRASE = 5, /* Passphrase secret (Since: v0.4.1) */
VIR_CRED_ECHOPROMPT = 6, /* Challenge response (Since: v0.4.1) */
VIR_CRED_NOECHOPROMPT = 7, /* Challenge response (Since: v0.4.1) */
VIR_CRED_REALM = 8, /* Authentication realm (Since: v0.4.1) */
VIR_CRED_EXTERNAL = 9, /* Externally managed credential (Since: v0.4.1) */
VIR_CRED_USERNAME = 1, /* Identity to act as (Since: 0.4.1) */
VIR_CRED_AUTHNAME = 2, /* Identify to authorize as (Since: 0.4.1) */
VIR_CRED_LANGUAGE = 3, /* RFC 1766 languages, comma separated (Since: 0.4.1) */
VIR_CRED_CNONCE = 4, /* client supplies a nonce (Since: 0.4.1) */
VIR_CRED_PASSPHRASE = 5, /* Passphrase secret (Since: 0.4.1) */
VIR_CRED_ECHOPROMPT = 6, /* Challenge response (Since: 0.4.1) */
VIR_CRED_NOECHOPROMPT = 7, /* Challenge response (Since: 0.4.1) */
VIR_CRED_REALM = 8, /* Authentication realm (Since: 0.4.1) */
VIR_CRED_EXTERNAL = 9, /* Externally managed credential (Since: 0.4.1) */
# ifdef VIR_ENUM_SENTINELS
VIR_CRED_LAST /* More may be added - expect the unexpected (Since: v0.9.10) */
VIR_CRED_LAST /* More may be added - expect the unexpected (Since: 0.9.10) */
# endif
} virConnectCredentialType;
@ -626,14 +626,14 @@ struct _virConnectCredential {
/**
* virConnectCredential:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef struct _virConnectCredential virConnectCredential;
/**
* virConnectCredentialPtr:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef virConnectCredential *virConnectCredentialPtr;
@ -651,7 +651,7 @@ typedef virConnectCredential *virConnectCredentialPtr;
*
* Returns 0 if all interactions were filled, or -1 upon error
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef int (*virConnectAuthCallbackPtr)(virConnectCredentialPtr cred,
unsigned int ncred,
@ -668,14 +668,14 @@ struct _virConnectAuth {
/**
* virConnectAuth:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef struct _virConnectAuth virConnectAuth;
/**
* virConnectAuthPtr:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef virConnectAuth *virConnectAuthPtr;
@ -689,7 +689,7 @@ typedef virConnectAuth *virConnectAuthPtr;
* suitable for the application's needs an alternative implementation
* should be provided.
*
* Since: v0.4.1
* Since: 0.4.1
*/
VIR_EXPORT_VAR virConnectAuthPtr virConnectAuthPtrDefault;
@ -699,7 +699,7 @@ VIR_EXPORT_VAR virConnectAuthPtr virConnectAuthPtrDefault;
* This macro provides the length of the buffer required
* for virDomainGetUUID()
*
* Since: v0.2.0
* Since: 0.2.0
*/
# define VIR_UUID_BUFLEN (16)
@ -709,7 +709,7 @@ VIR_EXPORT_VAR virConnectAuthPtr virConnectAuthPtrDefault;
* This macro provides the length of the buffer required
* for virDomainGetUUIDString()
*
* Since: v0.2.0
* Since: 0.2.0
*/
# define VIR_UUID_STRING_BUFLEN (36+1)
@ -736,7 +736,7 @@ int virConnectClose (virConnectPtr conn);
*
* The operating system user name as VIR_TYPED_PARAM_STRING.
*
* Since: v5.8.0
* Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_USER_NAME "user-name"
@ -745,7 +745,7 @@ int virConnectClose (virConnectPtr conn);
*
* The UNIX user ID as VIR_TYPED_PARAM_ULLONG.
*
* Since: v5.8.0
* Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_UNIX_USER_ID "unix-user-id"
@ -754,7 +754,7 @@ int virConnectClose (virConnectPtr conn);
*
* The operating system group name as VIR_TYPED_PARAM_STRING.
*
* Since: v5.8.0
* Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_GROUP_NAME "group-name"
@ -763,7 +763,7 @@ int virConnectClose (virConnectPtr conn);
*
* The UNIX group ID as VIR_TYPED_PARAM_ULLONG.
*
* Since: v5.8.0
* Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_UNIX_GROUP_ID "unix-group-id"
@ -772,7 +772,7 @@ int virConnectClose (virConnectPtr conn);
*
* The operating system process ID as VIR_TYPED_PARAM_LLONG.
*
* Since: v5.8.0
* Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_PROCESS_ID "process-id"
@ -785,7 +785,7 @@ int virConnectClose (virConnectPtr conn);
* host operating system. On Linux this is usually clock
* ticks (as reported in /proc/$PID/stat field 22).
*
* Since: v5.8.0
* Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_PROCESS_TIME "process-time"
@ -794,7 +794,7 @@ int virConnectClose (virConnectPtr conn);
*
* The SASL authenticated username as VIR_TYPED_PARAM_STRING
*
* Since: v5.8.0
* Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_SASL_USER_NAME "sasl-user-name"
@ -803,7 +803,7 @@ int virConnectClose (virConnectPtr conn);
*
* The TLS x509 certificate distinguished named as VIR_TYPED_PARAM_STRING
*
* Since: v5.8.0
* Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_X509_DISTINGUISHED_NAME "x509-distinguished-name"
@ -812,7 +812,7 @@ int virConnectClose (virConnectPtr conn);
*
* The application's SELinux context as VIR_TYPED_PARAM_STRING.
*
* Since: v5.8.0
* Since: 5.8.0
*/
# define VIR_CONNECT_IDENTITY_SELINUX_CONTEXT "selinux-context"
@ -844,7 +844,7 @@ int virConnectSetKeepAlive(virConnectPtr conn,
* A callback function to be registered, and called when the connection
* is closed.
*
* Since: v0.10.0
* Since: 0.10.0
*/
typedef void (*virConnectCloseFunc)(virConnectPtr conn,
int reason,
@ -910,29 +910,29 @@ int virConnectIsAlive(virConnectPtr conn);
/**
* virCPUCompareResult:
*
* Since: v0.7.5
* Since: 0.7.5
*/
typedef enum {
VIR_CPU_COMPARE_ERROR = -1, /* (Since: v0.7.5) */
VIR_CPU_COMPARE_INCOMPATIBLE = 0, /* (Since: v0.7.5) */
VIR_CPU_COMPARE_IDENTICAL = 1, /* (Since: v0.7.5) */
VIR_CPU_COMPARE_SUPERSET = 2, /* (Since: v0.7.5) */
VIR_CPU_COMPARE_ERROR = -1, /* (Since: 0.7.5) */
VIR_CPU_COMPARE_INCOMPATIBLE = 0, /* (Since: 0.7.5) */
VIR_CPU_COMPARE_IDENTICAL = 1, /* (Since: 0.7.5) */
VIR_CPU_COMPARE_SUPERSET = 2, /* (Since: 0.7.5) */
# ifdef VIR_ENUM_SENTINELS
VIR_CPU_COMPARE_LAST /* (Since: v0.9.10) */
VIR_CPU_COMPARE_LAST /* (Since: 0.9.10) */
# endif
} virCPUCompareResult;
/**
* virConnectCompareCPUFlags:
*
* Since: v1.2.6
* Since: 1.2.6
*/
typedef enum {
VIR_CONNECT_COMPARE_CPU_FAIL_INCOMPATIBLE = (1 << 0), /* treat incompatible
CPUs as failure (Since: v1.2.6) */
CPUs as failure (Since: 1.2.6) */
VIR_CONNECT_COMPARE_CPU_VALIDATE_XML = (1 << 1), /* validate the xml
document (Since: v6.9.0) */
document (Since: 6.9.0) */
} virConnectCompareCPUFlags;
int virConnectCompareCPU(virConnectPtr conn,
@ -956,11 +956,11 @@ int virConnectGetCPUModelNames(virConnectPtr conn,
*
* Flags when getting XML description of a computed CPU
*
* Since: v1.1.2
* Since: 1.1.2
*/
typedef enum {
VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = (1 << 0), /* show all features (Since: v1.1.2) */
VIR_CONNECT_BASELINE_CPU_MIGRATABLE = (1 << 1), /* filter out non-migratable features (Since: v1.2.14) */
VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = (1 << 0), /* show all features (Since: 1.1.2) */
VIR_CONNECT_BASELINE_CPU_MIGRATABLE = (1 << 1), /* filter out non-migratable features (Since: 1.2.14) */
} virConnectBaselineCPUFlags;
char *virConnectBaselineCPU(virConnectPtr conn,
@ -987,14 +987,14 @@ int virNodeGetFreePages(virConnectPtr conn,
/**
* virNodeAllocPagesFlags:
*
* Since: v1.2.9
* Since: 1.2.9
*/
typedef enum {
VIR_NODE_ALLOC_PAGES_ADD = 0, /* Add @pageCounts to the pages pool. This
can be used only to size up the pool. (Since: v1.2.9) */
can be used only to size up the pool. (Since: 1.2.9) */
VIR_NODE_ALLOC_PAGES_SET = (1 << 0), /* Don't add @pageCounts, instead set
passed number of pages. This can be
used to free allocated pages. (Since: v1.2.9) */
used to free allocated pages. (Since: 1.2.9) */
} virNodeAllocPagesFlags;
int virNodeAllocPages(virConnectPtr conn,

18
include/libvirt/libvirt-interface.h
View File

@ -32,7 +32,7 @@
*
* a virInterface is a private structure representing a virtual interface.
*
* Since: v0.6.4
* Since: 0.6.4
*/
typedef struct _virInterface virInterface;
@ -42,7 +42,7 @@ typedef struct _virInterface virInterface;
* a virInterfacePtr is pointer to a virInterface private structure, this is the
* type used to reference a virtual interface in the API.
*
* Since: v0.6.4
* Since: 0.6.4
*/
typedef virInterface *virInterfacePtr;
@ -62,11 +62,11 @@ int virConnectListDefinedInterfaces (virConnectPtr conn,
*
* Flags used to filter the returned interfaces.
*
* Since: v0.10.2
* Since: 0.10.2
*/
typedef enum {
VIR_CONNECT_LIST_INTERFACES_INACTIVE = 1 << 0, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_INTERFACES_ACTIVE = 1 << 1, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_INTERFACES_INACTIVE = 1 << 0, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_INTERFACES_ACTIVE = 1 << 1, /* (Since: 0.10.2) */
} virConnectListAllInterfacesFlags;
int virConnectListAllInterfaces (virConnectPtr conn,
@ -84,19 +84,19 @@ const char* virInterfaceGetMACString (virInterfacePtr iface);
/**
* virInterfaceXMLFlags:
*
* Since: v0.7.3
* Since: 0.7.3
*/
typedef enum {
VIR_INTERFACE_XML_INACTIVE = 1 << 0 /* dump inactive interface information (Since: v0.7.3) */
VIR_INTERFACE_XML_INACTIVE = 1 << 0 /* dump inactive interface information (Since: 0.7.3) */
} virInterfaceXMLFlags;
/**
* virInterfaceDefineFlags:
*
* Since: v7.7.0
* Since: 7.7.0
*/
typedef enum {
VIR_INTERFACE_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */
VIR_INTERFACE_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */
} virInterfaceDefineFlags;
char * virInterfaceGetXMLDesc (virInterfacePtr iface,

142
include/libvirt/libvirt-network.h
View File

@ -30,10 +30,10 @@
/**
* virNetworkXMLFlags:
*
* Since: v0.9.10
* Since: 0.9.10
*/
typedef enum {
VIR_NETWORK_XML_INACTIVE = (1 << 0), /* dump inactive network information (Since: v0.9.10) */
VIR_NETWORK_XML_INACTIVE = (1 << 0), /* dump inactive network information (Since: 0.9.10) */
} virNetworkXMLFlags;
/**
@ -41,7 +41,7 @@ typedef enum {
*
* a virNetwork is a private structure representing a virtual network.
*
* Since: v0.2.0
* Since: 0.2.0
*/
typedef struct _virNetwork virNetwork;
@ -51,7 +51,7 @@ typedef struct _virNetwork virNetwork;
* a virNetworkPtr is pointer to a virNetwork private structure, this is the
* type used to reference a virtual network in the API.
*
* Since: v0.2.0
* Since: 0.2.0
*/
typedef virNetwork *virNetworkPtr;
@ -61,7 +61,7 @@ typedef virNetwork *virNetworkPtr;
* a virNetworkPort is a private structure representing a virtual network
* port
*
* Since: v5.5.0
* Since: 5.5.0
*/
typedef struct _virNetworkPort virNetworkPort;
@ -71,7 +71,7 @@ typedef struct _virNetworkPort virNetworkPort;
* a virNetworkPortPtr is pointer to a virNetworkPort private structure,
* this is the type used to reference a virtual network port in the API.
*
* Since: v5.5.0
* Since: 5.5.0
*/
typedef virNetworkPort *virNetworkPortPtr;
@ -101,17 +101,17 @@ int virConnectListDefinedNetworks (virConnectPtr conn,
* Flags used to filter the returned networks. Flags in each group
* are exclusive attributes of a network.
*
* Since: v0.10.2
* Since: 0.10.2
*/
typedef enum {
VIR_CONNECT_LIST_NETWORKS_INACTIVE = 1 << 0, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_NETWORKS_ACTIVE = 1 << 1, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_NETWORKS_INACTIVE = 1 << 0, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_NETWORKS_ACTIVE = 1 << 1, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_NETWORKS_PERSISTENT = 1 << 2, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_NETWORKS_TRANSIENT = 1 << 3, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_NETWORKS_PERSISTENT = 1 << 2, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_NETWORKS_TRANSIENT = 1 << 3, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_NETWORKS_AUTOSTART = 1 << 4, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART = 1 << 5, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_NETWORKS_AUTOSTART = 1 << 4, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART = 1 << 5, /* (Since: 0.10.2) */
} virConnectListAllNetworksFlags;
int virConnectListAllNetworks (virConnectPtr conn,
@ -130,10 +130,10 @@ virNetworkPtr virNetworkLookupByUUIDString (virConnectPtr conn,
/**
* virNetworkCreateFlags:
*
* Since: v7.8.0
* Since: 7.8.0
*/
typedef enum {
VIR_NETWORK_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.8.0) */
VIR_NETWORK_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.8.0) */
} virNetworkCreateFlags;
/*
@ -147,10 +147,10 @@ virNetworkPtr virNetworkCreateXMLFlags(virConnectPtr conn,
/**
* virNetworkDefineFlags:
*
* Since: v7.7.0
* Since: 7.7.0
*/
typedef enum {
VIR_NETWORK_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */
VIR_NETWORK_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */
} virNetworkDefineFlags;
/*
@ -173,16 +173,16 @@ int virNetworkUndefine (virNetworkPtr network);
* describes which type of update to perform on a <network>
* definition.
*
* Since: v0.10.2
* Since: 0.10.2
*/
typedef enum {
VIR_NETWORK_UPDATE_COMMAND_NONE = 0, /* (invalid (Since: v0.10.2) */
VIR_NETWORK_UPDATE_COMMAND_MODIFY = 1, /* modify an existing element (Since: v0.10.2) */
VIR_NETWORK_UPDATE_COMMAND_DELETE = 2, /* delete an existing element (Since: v0.10.2) */
VIR_NETWORK_UPDATE_COMMAND_ADD_LAST = 3, /* add an element at end of list (Since: v0.10.2) */
VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST = 4, /* add an element at start of list (Since: v0.10.2) */
VIR_NETWORK_UPDATE_COMMAND_NONE = 0, /* (invalid (Since: 0.10.2) */
VIR_NETWORK_UPDATE_COMMAND_MODIFY = 1, /* modify an existing element (Since: 0.10.2) */
VIR_NETWORK_UPDATE_COMMAND_DELETE = 2, /* delete an existing element (Since: 0.10.2) */
VIR_NETWORK_UPDATE_COMMAND_ADD_LAST = 3, /* add an element at end of list (Since: 0.10.2) */
VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST = 4, /* add an element at start of list (Since: 0.10.2) */
# ifdef VIR_ENUM_SENTINELS
VIR_NETWORK_UPDATE_COMMAND_LAST /* (Since: v0.10.2) */
VIR_NETWORK_UPDATE_COMMAND_LAST /* (Since: 0.10.2) */
# endif
} virNetworkUpdateCommand;
@ -192,24 +192,24 @@ typedef enum {
* describes which section of a <network> definition the provided
* xml should be applied to.
*
* Since: v0.10.2
* Since: 0.10.2
*/
typedef enum {
VIR_NETWORK_SECTION_NONE = 0, /* (invalid (Since: v0.10.2) */
VIR_NETWORK_SECTION_BRIDGE = 1, /* <bridge> (Since: v0.10.2) */
VIR_NETWORK_SECTION_DOMAIN = 2, /* <domain> (Since: v0.10.2) */
VIR_NETWORK_SECTION_IP = 3, /* <ip> (Since: v0.10.2) */
VIR_NETWORK_SECTION_IP_DHCP_HOST = 4, /* <ip>/<dhcp>/<host> (Since: v0.10.2) */
VIR_NETWORK_SECTION_IP_DHCP_RANGE = 5, /* <ip>/<dhcp>/<range> (Since: v0.10.2) */
VIR_NETWORK_SECTION_FORWARD = 6, /* <forward> (Since: v0.10.2) */
VIR_NETWORK_SECTION_FORWARD_INTERFACE = 7, /* <forward>/<interface> (Since: v0.10.2) */
VIR_NETWORK_SECTION_FORWARD_PF = 8, /* <forward>/<pf> (Since: v0.10.2) */
VIR_NETWORK_SECTION_PORTGROUP = 9, /* <portgroup> (Since: v0.10.2) */
VIR_NETWORK_SECTION_DNS_HOST = 10, /* <dns>/<host> (Since: v0.10.2) */
VIR_NETWORK_SECTION_DNS_TXT = 11, /* <dns>/<txt> (Since: v0.10.2) */
VIR_NETWORK_SECTION_DNS_SRV = 12, /* <dns>/<srv> (Since: v0.10.2) */
VIR_NETWORK_SECTION_NONE = 0, /* (invalid (Since: 0.10.2) */
VIR_NETWORK_SECTION_BRIDGE = 1, /* <bridge> (Since: 0.10.2) */
VIR_NETWORK_SECTION_DOMAIN = 2, /* <domain> (Since: 0.10.2) */
VIR_NETWORK_SECTION_IP = 3, /* <ip> (Since: 0.10.2) */
VIR_NETWORK_SECTION_IP_DHCP_HOST = 4, /* <ip>/<dhcp>/<host> (Since: 0.10.2) */
VIR_NETWORK_SECTION_IP_DHCP_RANGE = 5, /* <ip>/<dhcp>/<range> (Since: 0.10.2) */
VIR_NETWORK_SECTION_FORWARD = 6, /* <forward> (Since: 0.10.2) */
VIR_NETWORK_SECTION_FORWARD_INTERFACE = 7, /* <forward>/<interface> (Since: 0.10.2) */
VIR_NETWORK_SECTION_FORWARD_PF = 8, /* <forward>/<pf> (Since: 0.10.2) */
VIR_NETWORK_SECTION_PORTGROUP = 9, /* <portgroup> (Since: 0.10.2) */
VIR_NETWORK_SECTION_DNS_HOST = 10, /* <dns>/<host> (Since: 0.10.2) */
VIR_NETWORK_SECTION_DNS_TXT = 11, /* <dns>/<txt> (Since: 0.10.2) */
VIR_NETWORK_SECTION_DNS_SRV = 12, /* <dns>/<srv> (Since: 0.10.2) */
# ifdef VIR_ENUM_SENTINELS
VIR_NETWORK_SECTION_LAST /* (Since: v0.10.2) */
VIR_NETWORK_SECTION_LAST /* (Since: 0.10.2) */
# endif
} virNetworkUpdateSection;
@ -218,13 +218,13 @@ typedef enum {
*
* Flags to control options for virNetworkUpdate()
*
* Since: v0.10.2
* Since: 0.10.2
*/
typedef enum {
VIR_NETWORK_UPDATE_AFFECT_CURRENT = 0, /* affect live if network is active,
config if it's not active (Since: v0.10.2) */
VIR_NETWORK_UPDATE_AFFECT_LIVE = 1 << 0, /* affect live state of network only (Since: v0.10.2) */
VIR_NETWORK_UPDATE_AFFECT_CONFIG = 1 << 1, /* affect persistent config only (Since: v0.10.2) */
config if it's not active (Since: 0.10.2) */
VIR_NETWORK_UPDATE_AFFECT_LIVE = 1 << 0, /* affect live state of network only (Since: 0.10.2) */
VIR_NETWORK_UPDATE_AFFECT_CONFIG = 1 << 1, /* affect persistent config only (Since: 0.10.2) */
} virNetworkUpdateFlags;
/*
@ -274,16 +274,16 @@ int virNetworkIsPersistent(virNetworkPtr net);
*
* a virNetworkEventLifecycleType is emitted during network lifecycle events
*
* Since: v1.2.1
* Since: 1.2.1
*/
typedef enum {
VIR_NETWORK_EVENT_DEFINED = 0, /* (Since: v1.2.1) */
VIR_NETWORK_EVENT_UNDEFINED = 1, /* (Since: v1.2.1) */
VIR_NETWORK_EVENT_STARTED = 2, /* (Since: v1.2.1) */
VIR_NETWORK_EVENT_STOPPED = 3, /* (Since: v1.2.1) */
VIR_NETWORK_EVENT_DEFINED = 0, /* (Since: 1.2.1) */
VIR_NETWORK_EVENT_UNDEFINED = 1, /* (Since: 1.2.1) */
VIR_NETWORK_EVENT_STARTED = 2, /* (Since: 1.2.1) */
VIR_NETWORK_EVENT_STOPPED = 3, /* (Since: 1.2.1) */
# ifdef VIR_ENUM_SENTINELS
VIR_NETWORK_EVENT_LAST /* (Since: v1.2.1) */
VIR_NETWORK_EVENT_LAST /* (Since: 1.2.1) */
# endif
} virNetworkEventLifecycleType;
@ -301,7 +301,7 @@ typedef enum {
* The callback signature to use when registering for an event of type
* VIR_NETWORK_EVENT_ID_LIFECYCLE with virConnectNetworkEventRegisterAny()
*
* Since: v1.2.1
* Since: 1.2.1
*/
typedef void (*virConnectNetworkEventLifecycleCallback)(virConnectPtr conn,
virNetworkPtr net,
@ -315,7 +315,7 @@ typedef void (*virConnectNetworkEventLifecycleCallback)(virConnectPtr conn,
* Used to cast the event specific callback into the generic one
* for use for virConnectNetworkEventRegisterAny()
*
* Since: v1.2.1
* Since: 1.2.1
*/
# define VIR_NETWORK_EVENT_CALLBACK(cb) ((virConnectNetworkEventGenericCallback)(cb))
@ -326,10 +326,10 @@ typedef void (*virConnectNetworkEventLifecycleCallback)(virConnectPtr conn,
* virConnectNetworkEventRegisterAny(). Each event id determines which
* signature of callback function will be used.
*
* Since: v1.2.1
* Since: 1.2.1
*/
typedef enum {
VIR_NETWORK_EVENT_ID_LIFECYCLE = 0, /* virConnectNetworkEventLifecycleCallback (Since: v1.2.1) */
VIR_NETWORK_EVENT_ID_LIFECYCLE = 0, /* virConnectNetworkEventLifecycleCallback (Since: 1.2.1) */
# ifdef VIR_ENUM_SENTINELS
VIR_NETWORK_EVENT_ID_LAST
@ -338,7 +338,7 @@ typedef enum {
* added to the libvirt API. It reflects the last event ID supported
* by this version of the libvirt API.
*
* Since: v1.2.1
* Since: 1.2.1
*/
# endif
} virNetworkEventID;
@ -346,28 +346,28 @@ typedef enum {
/**
* virIPAddrType:
*
* Since: v1.2.6
* Since: 1.2.6
*/
typedef enum {
VIR_IP_ADDR_TYPE_IPV4, /* (Since: v1.2.6) */
VIR_IP_ADDR_TYPE_IPV6, /* (Since: v1.2.6) */
VIR_IP_ADDR_TYPE_IPV4, /* (Since: 1.2.6) */
VIR_IP_ADDR_TYPE_IPV6, /* (Since: 1.2.6) */
# ifdef VIR_ENUM_SENTINELS
VIR_IP_ADDR_TYPE_LAST /* (Since: v1.2.6) */
VIR_IP_ADDR_TYPE_LAST /* (Since: 1.2.6) */
# endif
} virIPAddrType;
/**
* virNetworkDHCPLease:
*
* Since: v1.2.6
* Since: 1.2.6
*/
typedef struct _virNetworkDHCPLease virNetworkDHCPLease;
/**
* virNetworkDHCPLeasePtr:
*
* Since: v1.2.6
* Since: 1.2.6
*/
typedef virNetworkDHCPLease *virNetworkDHCPLeasePtr;
struct _virNetworkDHCPLease {
@ -401,7 +401,7 @@ int virNetworkGetDHCPLeases(virNetworkPtr network,
* passed in a different parameter position; use VIR_NETWORK_EVENT_CALLBACK()
* when registering an appropriate handler.
*
* Since: v1.2.1
* Since: 1.2.1
*/
typedef void (*virConnectNetworkEventGenericCallback)(virConnectPtr conn,
virNetworkPtr net,
@ -430,11 +430,11 @@ virNetworkPortLookupByUUIDString(virNetworkPtr net,
/**
* virNetworkPortCreateFlags:
*
* Since: v5.5.0
* Since: 5.5.0
*/
typedef enum {
VIR_NETWORK_PORT_CREATE_RECLAIM = (1 << 0), /* reclaim existing used resources (Since: v5.5.0) */
VIR_NETWORK_PORT_CREATE_VALIDATE = (1 << 1), /* Validate the XML document against schema (Since: v7.8.0) */
VIR_NETWORK_PORT_CREATE_RECLAIM = (1 << 0), /* reclaim existing used resources (Since: 5.5.0) */
VIR_NETWORK_PORT_CREATE_VALIDATE = (1 << 1), /* Validate the XML document against schema (Since: 7.8.0) */
} virNetworkPortCreateFlags;
virNetworkPortPtr
@ -463,7 +463,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port,
*
* Macro represents the inbound average of NIC bandwidth, as a uint.
*
* Since: v5.5.0
* Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_IN_AVERAGE "inbound.average"
@ -472,7 +472,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port,
*
* Macro represents the inbound peak of NIC bandwidth, as a uint.
*
* Since: v5.5.0
* Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_IN_PEAK "inbound.peak"
@ -481,7 +481,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port,
*
* Macro represents the inbound burst of NIC bandwidth, as a uint.
*
* Since: v5.5.0
* Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_IN_BURST "inbound.burst"
@ -490,7 +490,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port,
*
* Macro represents the inbound floor of NIC bandwidth, as a uint.
*
* Since: v5.5.0
* Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_IN_FLOOR "inbound.floor"
@ -499,7 +499,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port,
*
* Macro represents the outbound average of NIC bandwidth, as a uint.
*
* Since: v5.5.0
* Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_OUT_AVERAGE "outbound.average"
@ -508,7 +508,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port,
*
* Macro represents the outbound peak of NIC bandwidth, as a uint.
*
* Since: v5.5.0
* Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_OUT_PEAK "outbound.peak"
@ -517,7 +517,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port,
*
* Macro represents the outbound burst of NIC bandwidth, as a uint.
*
* Since: v5.5.0
* Since: 5.5.0
*/
# define VIR_NETWORK_PORT_BANDWIDTH_OUT_BURST "outbound.burst"

80
include/libvirt/libvirt-nodedev.h
View File

@ -33,7 +33,7 @@
*
* A virNodeDevice contains a node (host) device details.
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef struct _virNodeDevice virNodeDevice;
@ -45,7 +45,7 @@ typedef struct _virNodeDevice virNodeDevice;
* to call virNodeDeviceFree when done using a virNodeDevicePtr obtained
* from any of the above functions to avoid leaking memory.
*
* Since: v0.5.0
* Since: 0.5.0
*/
typedef virNodeDevice *virNodeDevicePtr;
@ -65,34 +65,34 @@ int virNodeListDevices (virConnectPtr conn,
* Flags used to filter either by capability or active state, the
* returned node devices.
*
* Since: v0.10.2
* Since: 0.10.2
*/
typedef enum {
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM = 1 << 0, /* System capability (Since: v0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV = 1 << 1, /* PCI device (Since: v0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV = 1 << 2, /* USB device (Since: v0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE = 1 << 3, /* USB interface (Since: v0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET = 1 << 4, /* Network device (Since: v0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST = 1 << 5, /* SCSI Host Bus Adapter (Since: v0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET = 1 << 6, /* SCSI Target (Since: v0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI = 1 << 7, /* SCSI device (Since: v0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE = 1 << 8, /* Storage device (Since: v0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_FC_HOST = 1 << 9, /* FC Host Bus Adapter (Since: v1.0.4) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPORTS = 1 << 10, /* Capable of vport (Since: v1.0.4) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC = 1 << 11, /* Capable of scsi_generic (Since: v1.1.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_DRM = 1 << 12, /* DRM device (Since: v3.1.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV_TYPES = 1 << 13, /* Capable of mediated devices (Since: v3.4.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV = 1 << 14, /* Mediated device (Since: v3.4.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_CCW_DEV = 1 << 15, /* CCW device (Since: v3.4.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_CSS_DEV = 1 << 16, /* CSS device (Since: v6.8.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_VDPA = 1 << 17, /* vDPA device (Since: v6.9.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_CARD = 1 << 18, /* s390 AP Card device (Since: v7.0.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_QUEUE = 1 << 19, /* s390 AP Queue (Since: v7.0.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX = 1 << 20, /* s390 AP Matrix (Since: v7.0.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD = 1 << 21, /* Device with VPD (Since: v7.9.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM = 1 << 0, /* System capability (Since: 0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV = 1 << 1, /* PCI device (Since: 0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV = 1 << 2, /* USB device (Since: 0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE = 1 << 3, /* USB interface (Since: 0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET = 1 << 4, /* Network device (Since: 0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST = 1 << 5, /* SCSI Host Bus Adapter (Since: 0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET = 1 << 6, /* SCSI Target (Since: 0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI = 1 << 7, /* SCSI device (Since: 0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE = 1 << 8, /* Storage device (Since: 0.10.2) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_FC_HOST = 1 << 9, /* FC Host Bus Adapter (Since: 1.0.4) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPORTS = 1 << 10, /* Capable of vport (Since: 1.0.4) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_GENERIC = 1 << 11, /* Capable of scsi_generic (Since: 1.1.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_DRM = 1 << 12, /* DRM device (Since: 3.1.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV_TYPES = 1 << 13, /* Capable of mediated devices (Since: 3.4.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_MDEV = 1 << 14, /* Mediated device (Since: 3.4.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_CCW_DEV = 1 << 15, /* CCW device (Since: 3.4.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_CSS_DEV = 1 << 16, /* CSS device (Since: 6.8.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_VDPA = 1 << 17, /* vDPA device (Since: 6.9.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_CARD = 1 << 18, /* s390 AP Card device (Since: 7.0.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_QUEUE = 1 << 19, /* s390 AP Queue (Since: 7.0.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_AP_MATRIX = 1 << 20, /* s390 AP Matrix (Since: 7.0.0) */
VIR_CONNECT_LIST_NODE_DEVICES_CAP_VPD = 1 << 21, /* Device with VPD (Since: 7.9.0) */
VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE = 1 << 30, /* Inactive devices (Since: v7.3.0) */
VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE = 1U << 31, /* Active devices (Since: v7.3.0) */
VIR_CONNECT_LIST_NODE_DEVICES_INACTIVE = 1 << 30, /* Inactive devices (Since: 7.3.0) */
VIR_CONNECT_LIST_NODE_DEVICES_ACTIVE = 1U << 31, /* Active devices (Since: 7.3.0) */
} virConnectListAllNodeDeviceFlags;
int virConnectListAllNodeDevices (virConnectPtr conn,
@ -162,7 +162,7 @@ int virNodeDeviceIsActive(virNodeDevicePtr dev);
* Used to cast the event specific callback into the generic one
* for use for virConnectNodeDeviceEventRegisterAny()
*
* Since: v2.2.0
* Since: 2.2.0
*/
# define VIR_NODE_DEVICE_EVENT_CALLBACK(cb)((virConnectNodeDeviceEventGenericCallback)(cb))
@ -173,11 +173,11 @@ int virNodeDeviceIsActive(virNodeDevicePtr dev);
* virConnectNodeDeviceEventRegisterAny(). Each event id determines which
* signature of callback function will be used.
*
* Since: v2.2.0
* Since: 2.2.0
*/
typedef enum {
VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE = 0, /* virConnectNodeDeviceEventLifecycleCallback (Since: v2.2.0) */
VIR_NODE_DEVICE_EVENT_ID_UPDATE = 1, /* virConnectNodeDeviceEventGenericCallback (Since: v2.2.0) */
VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE = 0, /* virConnectNodeDeviceEventLifecycleCallback (Since: 2.2.0) */
VIR_NODE_DEVICE_EVENT_ID_UPDATE = 1, /* virConnectNodeDeviceEventGenericCallback (Since: 2.2.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_NODE_DEVICE_EVENT_ID_LAST
@ -186,7 +186,7 @@ typedef enum {
* added to the libvirt API. It reflects the last event ID supported
* by this version of the libvirt API.
*
* Since: v2.2.0
* Since: 2.2.0
*/
# endif
} virNodeDeviceEventID;
@ -203,7 +203,7 @@ typedef enum {
* passed in a different parameter position; use
* VIR_NODE_DEVICE_EVENT_CALLBACK() when registering an appropriate handler.
*
* Since: v2.2.0
* Since: 2.2.0
*/
typedef void (*virConnectNodeDeviceEventGenericCallback)(virConnectPtr conn,
virNodeDevicePtr dev,
@ -226,16 +226,16 @@ int virConnectNodeDeviceEventDeregisterAny(virConnectPtr conn,
* a virNodeDeviceEventLifecycleType is emitted during node device
* lifecycle events
*
* Since: v2.2.0
* Since: 2.2.0
*/
typedef enum {
VIR_NODE_DEVICE_EVENT_CREATED = 0, /* (Since: v2.2.0) */
VIR_NODE_DEVICE_EVENT_DELETED = 1, /* (Since: v2.2.0) */
VIR_NODE_DEVICE_EVENT_DEFINED = 2, /* (Since: v7.3.0) */
VIR_NODE_DEVICE_EVENT_UNDEFINED = 3, /* (Since: v7.3.0) */
VIR_NODE_DEVICE_EVENT_CREATED = 0, /* (Since: 2.2.0) */
VIR_NODE_DEVICE_EVENT_DELETED = 1, /* (Since: 2.2.0) */
VIR_NODE_DEVICE_EVENT_DEFINED = 2, /* (Since: 7.3.0) */
VIR_NODE_DEVICE_EVENT_UNDEFINED = 3, /* (Since: 7.3.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_NODE_DEVICE_EVENT_LAST /* (Since: v2.2.0) */
VIR_NODE_DEVICE_EVENT_LAST /* (Since: 2.2.0) */
# endif
} virNodeDeviceEventLifecycleType;
@ -254,7 +254,7 @@ typedef enum {
* VIR_NODE_DEVICE_EVENT_ID_LIFECYCLE with
* virConnectNodeDeviceEventRegisterAny()
*
* Since: v2.2.0
* Since: 2.2.0
*/
typedef void (*virConnectNodeDeviceEventLifecycleCallback)(virConnectPtr conn,
virNodeDevicePtr dev,

16
include/libvirt/libvirt-nwfilter.h
View File

@ -32,7 +32,7 @@
*
* a virNWFilter is a private structure representing a network filter
*
* Since: v0.8.0
* Since: 0.8.0
*/
typedef struct _virNWFilter virNWFilter;
@ -42,7 +42,7 @@ typedef struct _virNWFilter virNWFilter;
* a virNWFilterPtr is pointer to a virNWFilter private structure,
* this is the type used to reference a network filter in the API.
*
* Since: v0.8.0
* Since: 0.8.0
*/
typedef virNWFilter *virNWFilterPtr;
@ -52,7 +52,7 @@ typedef virNWFilter *virNWFilterPtr;
* a virNWFilterBinding is a private structure representing a network
* filter binding to a port
*
* Since: v4.5.0
* Since: 4.5.0
*/
typedef struct _virNWFilterBinding virNWFilterBinding;
@ -63,7 +63,7 @@ typedef struct _virNWFilterBinding virNWFilterBinding;
* structure, this is the type used to reference a network filter
* port binding in the API.
*
* Since: v4.5.0
* Since: 4.5.0
*/
typedef virNWFilterBinding *virNWFilterBindingPtr;
@ -90,10 +90,10 @@ virNWFilterPtr virNWFilterLookupByUUIDString (virConnectPtr conn,
/**
* virNWFilterDefineFlags:
*
* Since: v7.7.0
* Since: 7.7.0
*/
typedef enum {
VIR_NWFILTER_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */
VIR_NWFILTER_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */
} virNWFilterDefineFlags;
/*
@ -123,10 +123,10 @@ int virNWFilterFree (virNWFilterPtr nwfilter);
/**
* virNWFilterBindingCreateFlags:
*
* Since: v7.8.0
* Since: 7.8.0
*/
typedef enum {
VIR_NWFILTER_BINDING_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.8.0) */
VIR_NWFILTER_BINDING_CREATE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.8.0) */
} virNWFilterBindingCreateFlags;
const char* virNWFilterGetName (virNWFilterPtr nwfilter);

26
include/libvirt/libvirt-qemu.h
View File

@ -33,11 +33,11 @@ extern "C" {
/**
* virDomainQemuMonitorCommandFlags:
*
* Since: v0.8.8
* Since: 0.8.8
*/
typedef enum {
VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT = 0, /* (Since: v0.8.8) */
VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP = (1 << 0), /* cmd is in HMP (Since: v0.8.8) */
VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT = 0, /* (Since: 0.8.8) */
VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP = (1 << 0), /* cmd is in HMP (Since: 0.8.8) */
} virDomainQemuMonitorCommandFlags;
int virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd,
@ -58,14 +58,14 @@ virDomainPtr virDomainQemuAttach(virConnectPtr domain,
/**
* virDomainQemuAgentCommandTimeoutValues:
*
* Since: v0.10.0
* Since: 0.10.0
*/
typedef enum {
VIR_DOMAIN_QEMU_AGENT_COMMAND_MIN = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: v0.10.0) */
VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: v0.10.0) */
VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT, /* (Since: v0.10.0) */
VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT, /* (Since: v0.10.0) */
VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN = 60, /* (Since: v1.2.15) */
VIR_DOMAIN_QEMU_AGENT_COMMAND_MIN = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: 0.10.0) */
VIR_DOMAIN_QEMU_AGENT_COMMAND_BLOCK = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_BLOCK, /* (Since: 0.10.0) */
VIR_DOMAIN_QEMU_AGENT_COMMAND_DEFAULT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_DEFAULT, /* (Since: 0.10.0) */
VIR_DOMAIN_QEMU_AGENT_COMMAND_NOWAIT = VIR_DOMAIN_AGENT_RESPONSE_TIMEOUT_NOWAIT, /* (Since: 0.10.0) */
VIR_DOMAIN_QEMU_AGENT_COMMAND_SHUTDOWN = 60, /* (Since: 1.2.15) */
} virDomainQemuAgentCommandTimeoutValues;
char *virDomainQemuAgentCommand(virDomainPtr domain, const char *cmd,
@ -85,7 +85,7 @@ char *virDomainQemuAgentCommand(virDomainPtr domain, const char *cmd,
* The callback signature to use when registering for a qemu monitor
* event with virConnectDomainQemuMonitorEventRegister().
*
* Since: v1.2.3
* Since: 1.2.3
*/
typedef void (*virConnectDomainQemuMonitorEventCallback)(virConnectPtr conn,
virDomainPtr dom,
@ -99,13 +99,13 @@ typedef void (*virConnectDomainQemuMonitorEventCallback)(virConnectPtr conn,
/**
* virConnectDomainQemuMonitorEventRegisterFlags:
*
* Since: v1.2.3
* Since: 1.2.3
*/
typedef enum {
/* Event filter is a regex rather than a literal string (Since: v1.2.3) */
/* Event filter is a regex rather than a literal string (Since: 1.2.3) */
VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_REGEX = (1 << 0),
/* Event filter is case insensitive (Since: v1.2.3) */
/* Event filter is case insensitive (Since: 1.2.3) */
VIR_CONNECT_DOMAIN_QEMU_MONITOR_EVENT_REGISTER_NOCASE = (1 << 1),
} virConnectDomainQemuMonitorEventRegisterFlags;

56
include/libvirt/libvirt-secret.h
View File

@ -34,29 +34,29 @@
* A virSecret stores a secret value (e.g. a passphrase or encryption key)
* and associated metadata.
*
* Since: v0.7.1
* Since: 0.7.1
*/
typedef struct _virSecret virSecret;
/**
* virSecretPtr:
*
* Since: v0.7.1
* Since: 0.7.1
*/
typedef virSecret *virSecretPtr;
/**
* virSecretUsageType:
*
* Since: v0.7.1
* Since: 0.7.1
*/
typedef enum {
VIR_SECRET_USAGE_TYPE_NONE = 0, /* (Since: v0.7.1) */
VIR_SECRET_USAGE_TYPE_VOLUME = 1, /* (Since: v0.7.1) */
VIR_SECRET_USAGE_TYPE_CEPH = 2, /* (Since: v0.9.7) */
VIR_SECRET_USAGE_TYPE_ISCSI = 3, /* (Since: v1.0.4) */
VIR_SECRET_USAGE_TYPE_TLS = 4, /* (Since: v2.3.0) */
VIR_SECRET_USAGE_TYPE_VTPM = 5, /* (Since: v5.6.0) */
VIR_SECRET_USAGE_TYPE_NONE = 0, /* (Since: 0.7.1) */
VIR_SECRET_USAGE_TYPE_VOLUME = 1, /* (Since: 0.7.1) */
VIR_SECRET_USAGE_TYPE_CEPH = 2, /* (Since: 0.9.7) */
VIR_SECRET_USAGE_TYPE_ISCSI = 3, /* (Since: 1.0.4) */
VIR_SECRET_USAGE_TYPE_TLS = 4, /* (Since: 2.3.0) */
VIR_SECRET_USAGE_TYPE_VTPM = 5, /* (Since: 5.6.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_SECRET_USAGE_TYPE_LAST
@ -65,7 +65,7 @@ typedef enum {
* added to the libvirt API. It reflects the last usage type supported
* by this version of the libvirt API.
*
* Since: v0.9.7
* Since: 0.9.7
*/
# endif
} virSecretUsageType;
@ -82,17 +82,17 @@ int virConnectListSecrets (virConnectPtr conn,
* Flags used to filter the returned secrets. Flags in each group
* are exclusive attributes of a secret.
*
* Since: v0.10.2
* Since: 0.10.2
*/
typedef enum {
VIR_CONNECT_LIST_SECRETS_EPHEMERAL = 1 << 0, /* kept in memory, never
stored persistently (Since: v0.10.2) */
VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL = 1 << 1, /* (Since: v0.10.2) */
stored persistently (Since: 0.10.2) */
VIR_CONNECT_LIST_SECRETS_NO_EPHEMERAL = 1 << 1, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_SECRETS_PRIVATE = 1 << 2, /* not revealed to any caller
of libvirt, nor to any other
node (Since: v0.10.2) */
VIR_CONNECT_LIST_SECRETS_NO_PRIVATE = 1 << 3, /* (Since: v0.10.2) */
node (Since: 0.10.2) */
VIR_CONNECT_LIST_SECRETS_NO_PRIVATE = 1 << 3, /* (Since: 0.10.2) */
} virConnectListAllSecretsFlags;
int virConnectListAllSecrets(virConnectPtr conn,
@ -108,10 +108,10 @@ virSecretPtr virSecretLookupByUsage(virConnectPtr conn,
/**
* virSecretDefineFlags:
*
* Since: v7.7.0
* Since: 7.7.0
*/
typedef enum {
VIR_SECRET_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */
VIR_SECRET_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */
} virSecretDefineFlags;
virSecretPtr virSecretDefineXML (virConnectPtr conn,
@ -142,7 +142,7 @@ int virSecretFree (virSecretPtr secret);
* Used to cast the event specific callback into the generic one
* for use for virConnectSecretEventRegisterAny()
*
* Since: v3.0.0
* Since: 3.0.0
*/
# define VIR_SECRET_EVENT_CALLBACK(cb)((virConnectSecretEventGenericCallback)(cb))
@ -153,11 +153,11 @@ int virSecretFree (virSecretPtr secret);
* virConnectSecretEventRegisterAny(). Each event id determines which
* signature of callback function will be used.
*
* Since: v3.0.0
* Since: 3.0.0
*/
typedef enum {
VIR_SECRET_EVENT_ID_LIFECYCLE = 0, /* virConnectSecretEventLifecycleCallback (Since: v3.0.0) */
VIR_SECRET_EVENT_ID_VALUE_CHANGED = 1, /* virConnectSecretEventGenericCallback (Since: v3.0.0) */
VIR_SECRET_EVENT_ID_LIFECYCLE = 0, /* virConnectSecretEventLifecycleCallback (Since: 3.0.0) */
VIR_SECRET_EVENT_ID_VALUE_CHANGED = 1, /* virConnectSecretEventGenericCallback (Since: 3.0.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_SECRET_EVENT_ID_LAST
@ -166,7 +166,7 @@ typedef enum {
* added to the libvirt API. It reflects the last event ID supported
* by this version of the libvirt API.
*
* Since: v3.0.0
* Since: 3.0.0
*/
# endif
} virSecretEventID;
@ -183,7 +183,7 @@ typedef enum {
* passed in a different parameter position; use
* VIR_SECRET_EVENT_CALLBACK() when registering an appropriate handler.
*
* Since: v3.0.0
* Since: 3.0.0
*/
typedef void (*virConnectSecretEventGenericCallback)(virConnectPtr conn,
virSecretPtr secret,
@ -206,14 +206,14 @@ int virConnectSecretEventDeregisterAny(virConnectPtr conn,
* a virSecretEventLifecycleType is emitted during secret
* lifecycle events
*
* Since: v3.0.0
* Since: 3.0.0
*/
typedef enum {
VIR_SECRET_EVENT_DEFINED = 0, /* (Since: v3.0.0) */
VIR_SECRET_EVENT_UNDEFINED = 1, /* (Since: v3.0.0) */
VIR_SECRET_EVENT_DEFINED = 0, /* (Since: 3.0.0) */
VIR_SECRET_EVENT_UNDEFINED = 1, /* (Since: 3.0.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_SECRET_EVENT_LAST /* (Since: v3.0.0) */
VIR_SECRET_EVENT_LAST /* (Since: 3.0.0) */
# endif
} virSecretEventLifecycleType;
@ -232,7 +232,7 @@ typedef enum {
* VIR_SECRET_EVENT_ID_LIFECYCLE with
* virConnectSecretEventRegisterAny()
*
* Since: v3.0.0
* Since: 3.0.0
*/
typedef void (*virConnectSecretEventLifecycleCallback)(virConnectPtr conn,
virSecretPtr secret,

214
include/libvirt/libvirt-storage.h
View File

@ -33,7 +33,7 @@
*
* a virStoragePool is a private structure representing a storage pool
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef struct _virStoragePool virStoragePool;
@ -43,7 +43,7 @@ typedef struct _virStoragePool virStoragePool;
* a virStoragePoolPtr is pointer to a virStoragePool private structure, this is the
* type used to reference a storage pool in the API.
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef virStoragePool *virStoragePoolPtr;
@ -51,60 +51,60 @@ typedef virStoragePool *virStoragePoolPtr;
/**
* virStoragePoolState:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef enum {
VIR_STORAGE_POOL_INACTIVE = 0, /* Not running (Since: v0.4.1) */
VIR_STORAGE_POOL_BUILDING = 1, /* Initializing pool, not available (Since: v0.4.1) */
VIR_STORAGE_POOL_RUNNING = 2, /* Running normally (Since: v0.4.1) */
VIR_STORAGE_POOL_DEGRADED = 3, /* Running degraded (Since: v0.4.1) */
VIR_STORAGE_POOL_INACCESSIBLE = 4, /* Running, but not accessible (Since: v0.8.2) */
VIR_STORAGE_POOL_INACTIVE = 0, /* Not running (Since: 0.4.1) */
VIR_STORAGE_POOL_BUILDING = 1, /* Initializing pool, not available (Since: 0.4.1) */
VIR_STORAGE_POOL_RUNNING = 2, /* Running normally (Since: 0.4.1) */
VIR_STORAGE_POOL_DEGRADED = 3, /* Running degraded (Since: 0.4.1) */
VIR_STORAGE_POOL_INACCESSIBLE = 4, /* Running, but not accessible (Since: 0.8.2) */
# ifdef VIR_ENUM_SENTINELS
VIR_STORAGE_POOL_STATE_LAST /* (Since: v0.9.10) */
VIR_STORAGE_POOL_STATE_LAST /* (Since: 0.9.10) */
# endif
} virStoragePoolState;
/**
* virStoragePoolBuildFlags:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef enum {
VIR_STORAGE_POOL_BUILD_NEW = 0, /* Regular build from scratch (Since: v0.4.1) */
VIR_STORAGE_POOL_BUILD_REPAIR = (1 << 0), /* Repair / reinitialize (Since: v0.4.1) */
VIR_STORAGE_POOL_BUILD_RESIZE = (1 << 1), /* Extend existing pool (Since: v0.4.1) */
VIR_STORAGE_POOL_BUILD_NO_OVERWRITE = (1 << 2), /* Do not overwrite existing pool (Since: v0.9.5) */
VIR_STORAGE_POOL_BUILD_OVERWRITE = (1 << 3), /* Overwrite data (Since: v0.9.5) */
VIR_STORAGE_POOL_BUILD_NEW = 0, /* Regular build from scratch (Since: 0.4.1) */
VIR_STORAGE_POOL_BUILD_REPAIR = (1 << 0), /* Repair / reinitialize (Since: 0.4.1) */
VIR_STORAGE_POOL_BUILD_RESIZE = (1 << 1), /* Extend existing pool (Since: 0.4.1) */
VIR_STORAGE_POOL_BUILD_NO_OVERWRITE = (1 << 2), /* Do not overwrite existing pool (Since: 0.9.5) */
VIR_STORAGE_POOL_BUILD_OVERWRITE = (1 << 3), /* Overwrite data (Since: 0.9.5) */
} virStoragePoolBuildFlags;
/**
* virStoragePoolDeleteFlags:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef enum {
VIR_STORAGE_POOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: v0.4.1) */
VIR_STORAGE_POOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: v0.4.1) */
VIR_STORAGE_POOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: 0.4.1) */
VIR_STORAGE_POOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: 0.4.1) */
} virStoragePoolDeleteFlags;
/**
* virStoragePoolCreateFlags:
*
* Since: v1.3.1
* Since: 1.3.1
*/
typedef enum {
/* Create the pool but do not perform pool build (Since: v1.3.1) */
/* Create the pool but do not perform pool build (Since: 1.3.1) */
VIR_STORAGE_POOL_CREATE_NORMAL = 0,
/* Create the pool and perform pool build without any flags (Since: v1.3.1) */
/* Create the pool and perform pool build without any flags (Since: 1.3.1) */
VIR_STORAGE_POOL_CREATE_WITH_BUILD = 1 << 0,
/* Create the pool and perform pool build using the
* VIR_STORAGE_POOL_BUILD_OVERWRITE flag. This is mutually
* exclusive to VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE
*
* Since: v1.3.1
* Since: 1.3.1
*/
VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE = 1 << 1,
@ -112,7 +112,7 @@ typedef enum {
* VIR_STORAGE_POOL_BUILD_NO_OVERWRITE flag. This is mutually
* exclusive to VIR_STORAGE_POOL_CREATE_WITH_BUILD_OVERWRITE
*
* Since: v1.3.1
* Since: 1.3.1
*/
VIR_STORAGE_POOL_CREATE_WITH_BUILD_NO_OVERWRITE = 1 << 2,
} virStoragePoolCreateFlags;
@ -120,7 +120,7 @@ typedef enum {
/**
* virStoragePoolInfo:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef struct _virStoragePoolInfo virStoragePoolInfo;
@ -134,7 +134,7 @@ struct _virStoragePoolInfo {
/**
* virStoragePoolInfoPtr:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef virStoragePoolInfo *virStoragePoolInfoPtr;
@ -144,7 +144,7 @@ typedef virStoragePoolInfo *virStoragePoolInfoPtr;
*
* a virStorageVol is a private structure representing a storage volume
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef struct _virStorageVol virStorageVol;
@ -154,7 +154,7 @@ typedef struct _virStorageVol virStorageVol;
* a virStorageVolPtr is pointer to a virStorageVol private structure, this is the
* type used to reference a storage volume in the API.
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef virStorageVol *virStorageVolPtr;
@ -162,59 +162,59 @@ typedef virStorageVol *virStorageVolPtr;
/**
* virStorageVolType:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef enum {
VIR_STORAGE_VOL_FILE = 0, /* Regular file based volumes (Since: v0.4.1) */
VIR_STORAGE_VOL_BLOCK = 1, /* Block based volumes (Since: v0.4.1) */
VIR_STORAGE_VOL_DIR = 2, /* Directory-passthrough based volume (Since: v0.9.5) */
VIR_STORAGE_VOL_NETWORK = 3, /* Network volumes like RBD (RADOS Block Device) (Since: v0.9.13) */
VIR_STORAGE_VOL_FILE = 0, /* Regular file based volumes (Since: 0.4.1) */
VIR_STORAGE_VOL_BLOCK = 1, /* Block based volumes (Since: 0.4.1) */
VIR_STORAGE_VOL_DIR = 2, /* Directory-passthrough based volume (Since: 0.9.5) */
VIR_STORAGE_VOL_NETWORK = 3, /* Network volumes like RBD (RADOS Block Device) (Since: 0.9.13) */
VIR_STORAGE_VOL_NETDIR = 4, /* Network accessible directory that can
* contain other network volumes (Since: v1.2.0) */
VIR_STORAGE_VOL_PLOOP = 5, /* Ploop based volumes (Since: v1.3.4) */
* contain other network volumes (Since: 1.2.0) */
VIR_STORAGE_VOL_PLOOP = 5, /* Ploop based volumes (Since: 1.3.4) */
# ifdef VIR_ENUM_SENTINELS
VIR_STORAGE_VOL_LAST /* (Since: v0.9.10) */
VIR_STORAGE_VOL_LAST /* (Since: 0.9.10) */
# endif
} virStorageVolType;
/**
* virStorageVolDeleteFlags:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef enum {
VIR_STORAGE_VOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: v0.4.1) */
VIR_STORAGE_VOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: v0.4.1) */
VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS = 1 << 1, /* Force removal of volume, even if in use (Since: v1.2.21) */
VIR_STORAGE_VOL_DELETE_NORMAL = 0, /* Delete metadata only (fast) (Since: 0.4.1) */
VIR_STORAGE_VOL_DELETE_ZEROED = 1 << 0, /* Clear all data to zeros (slow) (Since: 0.4.1) */
VIR_STORAGE_VOL_DELETE_WITH_SNAPSHOTS = 1 << 1, /* Force removal of volume, even if in use (Since: 1.2.21) */
} virStorageVolDeleteFlags;
/**
* virStorageVolWipeAlgorithm:
*
* Since: v0.9.10
* Since: 0.9.10
*/
typedef enum {
VIR_STORAGE_VOL_WIPE_ALG_ZERO = 0, /* 1-pass, all zeroes (Since: v0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_ZERO = 0, /* 1-pass, all zeroes (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_NNSA = 1, /* 4-pass NNSA Policy Letter
NAP-14.1-C (XVI-8) (Since: v0.9.10) */
NAP-14.1-C (XVI-8) (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_DOD = 2, /* 4-pass DoD 5220.22-M section
8-306 procedure (Since: v0.9.10) */
8-306 procedure (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_BSI = 3, /* 9-pass method recommended by the
German Center of Security in
Information Technologies (Since: v0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_GUTMANN = 4, /* The canonical 35-pass sequence (Since: v0.9.10) */
Information Technologies (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_GUTMANN = 4, /* The canonical 35-pass sequence (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_SCHNEIER = 5, /* 7-pass method described by
Bruce Schneier in "Applied
Cryptography" (1996) (Since: v0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 = 6, /* 7-pass random data (Since: v0.9.10) */
Cryptography" (1996) (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_PFITZNER7 = 6, /* 7-pass random data (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 = 7, /* 33-pass random data (Since: v0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_PFITZNER33 = 7, /* 33-pass random data (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_RANDOM = 8, /* 1-pass random data (Since: v0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_RANDOM = 8, /* 1-pass random data (Since: 0.9.10) */
VIR_STORAGE_VOL_WIPE_ALG_TRIM = 9, /* 1-pass, trim all data on the
volume by using TRIM or DISCARD (Since: v1.3.2) */
volume by using TRIM or DISCARD (Since: 1.3.2) */
# ifdef VIR_ENUM_SENTINELS
VIR_STORAGE_VOL_WIPE_ALG_LAST
@ -223,7 +223,7 @@ typedef enum {
* added to the libvirt API. It reflects the last algorithm supported
* by this version of the libvirt API.
*
* Since: v0.9.10
* Since: 0.9.10
*/
# endif
} virStorageVolWipeAlgorithm;
@ -231,17 +231,17 @@ typedef enum {
/**
* virStorageVolInfoFlags:
*
* Since: v3.0.0
* Since: 3.0.0
*/
typedef enum {
VIR_STORAGE_VOL_USE_ALLOCATION = 0, /* (Since: v3.0.0) */
VIR_STORAGE_VOL_GET_PHYSICAL = 1 << 0, /* Return the physical size in allocation (Since: v3.0.0) */
VIR_STORAGE_VOL_USE_ALLOCATION = 0, /* (Since: 3.0.0) */
VIR_STORAGE_VOL_GET_PHYSICAL = 1 << 0, /* Return the physical size in allocation (Since: 3.0.0) */
} virStorageVolInfoFlags;
/**
* virStorageVolInfo:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef struct _virStorageVolInfo virStorageVolInfo;
@ -255,17 +255,17 @@ struct _virStorageVolInfo {
/**
* virStorageVolInfoPtr:
*
* Since: v0.4.1
* Since: 0.4.1
*/
typedef virStorageVolInfo *virStorageVolInfoPtr;
/**
* virStorageXMLFlags:
*
* Since: v0.9.13
* Since: 0.9.13
*/
typedef enum {
VIR_STORAGE_XML_INACTIVE = (1 << 0), /* dump inactive pool/volume information (Since: v0.9.13) */
VIR_STORAGE_XML_INACTIVE = (1 << 0), /* dump inactive pool/volume information (Since: 0.9.13) */
} virStorageXMLFlags;
/*
@ -300,32 +300,32 @@ int virConnectListDefinedStoragePools(virConnectPtr conn,
* Note that these flags come in groups; if all bits from a group are 0,
* then that group is not used to filter results.
*
* Since: v0.10.2
* Since: 0.10.2
*/
typedef enum {
VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE = 1 << 0, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE = 1 << 1, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE = 1 << 0, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE = 1 << 1, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT = 1 << 2, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT = 1 << 3, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT = 1 << 2, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT = 1 << 3, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART = 1 << 4, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART = 1 << 5, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART = 1 << 4, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART = 1 << 5, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_DIR = 1 << 6, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_FS = 1 << 7, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_NETFS = 1 << 8, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL = 1 << 9, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_DISK = 1 << 10, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI = 1 << 11, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_SCSI = 1 << 12, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_MPATH = 1 << 13, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_RBD = 1 << 14, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG = 1 << 15, /* (Since: v0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER = 1 << 16, /* (Since: v1.2.1) */
VIR_CONNECT_LIST_STORAGE_POOLS_ZFS = 1 << 17, /* (Since: v1.2.8) */
VIR_CONNECT_LIST_STORAGE_POOLS_VSTORAGE = 1 << 18, /* (Since: v3.1.0) */
VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI_DIRECT = 1 << 19, /* (Since: v5.6.0) */
VIR_CONNECT_LIST_STORAGE_POOLS_DIR = 1 << 6, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_FS = 1 << 7, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_NETFS = 1 << 8, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL = 1 << 9, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_DISK = 1 << 10, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI = 1 << 11, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_SCSI = 1 << 12, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_MPATH = 1 << 13, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_RBD = 1 << 14, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG = 1 << 15, /* (Since: 0.10.2) */
VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER = 1 << 16, /* (Since: 1.2.1) */
VIR_CONNECT_LIST_STORAGE_POOLS_ZFS = 1 << 17, /* (Since: 1.2.8) */
VIR_CONNECT_LIST_STORAGE_POOLS_VSTORAGE = 1 << 18, /* (Since: 3.1.0) */
VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI_DIRECT = 1 << 19, /* (Since: 5.6.0) */
} virConnectListAllStoragePoolsFlags;
int virConnectListAllStoragePools(virConnectPtr conn,
@ -354,10 +354,10 @@ virStoragePoolPtr virStoragePoolLookupByTargetPath(virConnectPtr conn,
/**
* virStoragePoolDefineFlags:
*
* Since: v7.7.0
* Since: 7.7.0
*/
typedef enum {
VIR_STORAGE_POOL_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: v7.7.0) */
VIR_STORAGE_POOL_DEFINE_VALIDATE = 1 << 0, /* Validate the XML document against schema (Since: 7.7.0) */
} virStoragePoolDefineFlags;
/*
@ -432,11 +432,11 @@ const char* virStorageVolGetKey (virStorageVolPtr vol);
/**
* virStorageVolCreateFlags:
*
* Since: v1.0.1
* Since: 1.0.1
*/
typedef enum {
VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA = 1 << 0, /* (Since: v1.0.1) */
VIR_STORAGE_VOL_CREATE_REFLINK = 1 << 1, /* perform a btrfs lightweight copy (Since: v1.2.13) */
VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA = 1 << 0, /* (Since: 1.0.1) */
VIR_STORAGE_VOL_CREATE_REFLINK = 1 << 1, /* perform a btrfs lightweight copy (Since: 1.2.13) */
} virStorageVolCreateFlags;
virStorageVolPtr virStorageVolCreateXML (virStoragePoolPtr pool,
@ -449,10 +449,10 @@ virStorageVolPtr virStorageVolCreateXMLFrom (virStoragePoolPtr pool,
/**
* virStorageVolDownloadFlags:
*
* Since: v3.4.0
* Since: 3.4.0
*/
typedef enum {
VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: v3.4.0) */
VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: 3.4.0) */
} virStorageVolDownloadFlags;
int virStorageVolDownload (virStorageVolPtr vol,
@ -464,10 +464,10 @@ int virStorageVolDownload (virStorageVolPtr vol,
/**
* virStorageVolUploadFlags:
*
* Since: v3.4.0
* Since: 3.4.0
*/
typedef enum {
VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: v3.4.0) */
VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM = 1 << 0, /* Use sparse stream (Since: 3.4.0) */
} virStorageVolUploadFlags;
int virStorageVolUpload (virStorageVolPtr vol,
@ -498,12 +498,12 @@ char * virStorageVolGetPath (virStorageVolPtr vol);
/**
* virStorageVolResizeFlags:
*
* Since: v0.9.10
* Since: 0.9.10
*/
typedef enum {
VIR_STORAGE_VOL_RESIZE_ALLOCATE = 1 << 0, /* force allocation of new size (Since: v0.9.10) */
VIR_STORAGE_VOL_RESIZE_DELTA = 1 << 1, /* size is relative to current (Since: v0.9.10) */
VIR_STORAGE_VOL_RESIZE_SHRINK = 1 << 2, /* allow decrease in capacity (Since: v0.9.10) */
VIR_STORAGE_VOL_RESIZE_ALLOCATE = 1 << 0, /* force allocation of new size (Since: 0.9.10) */
VIR_STORAGE_VOL_RESIZE_DELTA = 1 << 1, /* size is relative to current (Since: 0.9.10) */
VIR_STORAGE_VOL_RESIZE_SHRINK = 1 << 2, /* allow decrease in capacity (Since: 0.9.10) */
} virStorageVolResizeFlags;
int virStorageVolResize (virStorageVolPtr vol,
@ -519,7 +519,7 @@ int virStoragePoolIsPersistent(virStoragePoolPtr pool);
* Used to cast the event specific callback into the generic one
* for use for virConnectStoragePoolEventRegisterAny()
*
* Since: v2.0.0
* Since: 2.0.0
*/
# define VIR_STORAGE_POOL_EVENT_CALLBACK(cb)((virConnectStoragePoolEventGenericCallback)(cb))
@ -530,11 +530,11 @@ int virStoragePoolIsPersistent(virStoragePoolPtr pool);
* virConnectStoragePoolEventRegisterAny(). Each event id determines which
* signature of callback function will be used.
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef enum {
VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE = 0, /* virConnectStoragePoolEventLifecycleCallback (Since: v2.0.0) */
VIR_STORAGE_POOL_EVENT_ID_REFRESH = 1, /* virConnectStoragePoolEventGenericCallback (Since: v2.0.0) */
VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE = 0, /* virConnectStoragePoolEventLifecycleCallback (Since: 2.0.0) */
VIR_STORAGE_POOL_EVENT_ID_REFRESH = 1, /* virConnectStoragePoolEventGenericCallback (Since: 2.0.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_STORAGE_POOL_EVENT_ID_LAST
@ -543,7 +543,7 @@ typedef enum {
* added to the libvirt API. It reflects the last event ID supported
* by this version of the libvirt API.
*
* Since: v2.0.0
* Since: 2.0.0
*/
# endif
} virStoragePoolEventID;
@ -560,7 +560,7 @@ typedef enum {
* passed in a different parameter position; use
* VIR_STORAGE_POOL_EVENT_CALLBACK() when registering an appropriate handler.
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef void (*virConnectStoragePoolEventGenericCallback)(virConnectPtr conn,
virStoragePoolPtr pool,
@ -583,18 +583,18 @@ int virConnectStoragePoolEventDeregisterAny(virConnectPtr conn,
* a virStoragePoolEventLifecycleType is emitted during storage pool
* lifecycle events
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef enum {
VIR_STORAGE_POOL_EVENT_DEFINED = 0, /* (Since: v2.0.0) */
VIR_STORAGE_POOL_EVENT_UNDEFINED = 1, /* (Since: v2.0.0) */
VIR_STORAGE_POOL_EVENT_STARTED = 2, /* (Since: v2.0.0) */
VIR_STORAGE_POOL_EVENT_STOPPED = 3, /* (Since: v2.0.0) */
VIR_STORAGE_POOL_EVENT_CREATED = 4, /* (Since: v3.8.0) */
VIR_STORAGE_POOL_EVENT_DELETED = 5, /* (Since: v3.8.0) */
VIR_STORAGE_POOL_EVENT_DEFINED = 0, /* (Since: 2.0.0) */
VIR_STORAGE_POOL_EVENT_UNDEFINED = 1, /* (Since: 2.0.0) */
VIR_STORAGE_POOL_EVENT_STARTED = 2, /* (Since: 2.0.0) */
VIR_STORAGE_POOL_EVENT_STOPPED = 3, /* (Since: 2.0.0) */
VIR_STORAGE_POOL_EVENT_CREATED = 4, /* (Since: 3.8.0) */
VIR_STORAGE_POOL_EVENT_DELETED = 5, /* (Since: 3.8.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_STORAGE_POOL_EVENT_LAST /* (Since: v2.0.0) */
VIR_STORAGE_POOL_EVENT_LAST /* (Since: 2.0.0) */
# endif
} virStoragePoolEventLifecycleType;
@ -613,7 +613,7 @@ typedef enum {
* VIR_STORAGE_POOL_EVENT_ID_LIFECYCLE with
* virConnectStoragePoolEventRegisterAny()
*
* Since: v2.0.0
* Since: 2.0.0
*/
typedef void (*virConnectStoragePoolEventLifecycleCallback)(virConnectPtr conn,
virStoragePoolPtr pool,

30
include/libvirt/libvirt-stream.h
View File

@ -31,10 +31,10 @@
/**
* virStreamFlags:
*
* Since: v0.7.2
* Since: 0.7.2
*/
typedef enum {
VIR_STREAM_NONBLOCK = (1 << 0), /* (Since: v0.7.2) */
VIR_STREAM_NONBLOCK = (1 << 0), /* (Since: 0.7.2) */
} virStreamFlags;
virStreamPtr virStreamNew(virConnectPtr conn,
@ -52,10 +52,10 @@ int virStreamRecv(virStreamPtr st,
/**
* virStreamRecvFlagsValues:
*
* Since: v3.4.0
* Since: 3.4.0
*/
typedef enum {
VIR_STREAM_RECV_STOP_AT_HOLE = (1 << 0), /* (Since: v3.4.0) */
VIR_STREAM_RECV_STOP_AT_HOLE = (1 << 0), /* (Since: 3.4.0) */
} virStreamRecvFlagsValues;
int virStreamRecvFlags(virStreamPtr st,
@ -99,7 +99,7 @@ int virStreamRecvHole(virStreamPtr,
* Returns the number of bytes filled, 0 upon end
* of file, or -1 upon error
*
* Since: v0.7.2
* Since: 0.7.2
*/
typedef int (*virStreamSourceFunc)(virStreamPtr st,
char *data,
@ -139,7 +139,7 @@ int virStreamSendAll(virStreamPtr st,
* Returns 0 on success,
* -1 upon error
*
* Since: v3.4.0
* Since: 3.4.0
*/
typedef int (*virStreamSourceHoleFunc)(virStreamPtr st,
int *inData,
@ -167,7 +167,7 @@ typedef int (*virStreamSourceHoleFunc)(virStreamPtr st,
* Returns 0 on success,
* -1 upon error.
*
* Since: v3.4.0
* Since: 3.4.0
*/
typedef int (*virStreamSourceSkipFunc)(virStreamPtr st,
long long length,
@ -206,7 +206,7 @@ int virStreamSparseSendAll(virStreamPtr st,
* Returns the number of bytes consumed or -1 upon
* error
*
* Since: v0.7.2
* Since: 0.7.2
*/
typedef int (*virStreamSinkFunc)(virStreamPtr st,
const char *data,
@ -238,7 +238,7 @@ int virStreamRecvAll(virStreamPtr st,
* Returns 0 on success,
* -1 upon error
*
* Since: v3.4.0
* Since: 3.4.0
*/
typedef int (*virStreamSinkHoleFunc)(virStreamPtr st,
long long length,
@ -252,13 +252,13 @@ int virStreamSparseRecvAll(virStreamPtr stream,
/**
* virStreamEventType:
*
* Since: v0.7.2
* Since: 0.7.2
*/
typedef enum {
VIR_STREAM_EVENT_READABLE = (1 << 0), /* (Since: v0.7.2) */
VIR_STREAM_EVENT_WRITABLE = (1 << 1), /* (Since: v0.7.2) */
VIR_STREAM_EVENT_ERROR = (1 << 2), /* (Since: v0.7.2) */
VIR_STREAM_EVENT_HANGUP = (1 << 3), /* (Since: v0.7.2) */
VIR_STREAM_EVENT_READABLE = (1 << 0), /* (Since: 0.7.2) */
VIR_STREAM_EVENT_WRITABLE = (1 << 1), /* (Since: 0.7.2) */
VIR_STREAM_EVENT_ERROR = (1 << 2), /* (Since: 0.7.2) */
VIR_STREAM_EVENT_HANGUP = (1 << 3), /* (Since: 0.7.2) */
} virStreamEventType;
@ -272,7 +272,7 @@ typedef enum {
* Callback for receiving stream events. The callback will
* be invoked once for each event which is pending.
*
* Since: v0.7.2
* Since: 0.7.2
*/
typedef void (*virStreamEventCallback)(virStreamPtr stream, int events, void *opaque);

390
include/libvirt/virterror.h
View File

@ -35,12 +35,12 @@ extern "C" {
*
* Indicates the level of an error
*
* Since: v0.1.0
* Since: 0.1.0
*/
typedef enum {
VIR_ERR_NONE = 0, /* (Since: v0.1.0) */
VIR_ERR_WARNING = 1, /* A simple warning (Since: v0.1.0) */
VIR_ERR_ERROR = 2 /* An error (Since: v0.1.0) */
VIR_ERR_NONE = 0, /* (Since: 0.1.0) */
VIR_ERR_WARNING = 1, /* A simple warning (Since: 0.1.0) */
VIR_ERR_ERROR = 2 /* An error (Since: 0.1.0) */
} virErrorLevel;
/**
@ -49,101 +49,101 @@ typedef enum {
* Indicates where an error may have come from. This should remain
* stable, with all additions placed at the end since libvirt 0.1.0.
*
* Since: v0.1.0
* Since: 0.1.0
*/
typedef enum {
VIR_FROM_NONE = 0, /* (Since: v0.1.0) */
VIR_FROM_XEN = 1, /* Error at Xen hypervisor layer (Since: v0.1.0) */
VIR_FROM_XEND = 2, /* Error at connection with xend daemon (Since: v0.1.0) */
VIR_FROM_XENSTORE = 3, /* Error at connection with xen store (Since: v0.1.0) */
VIR_FROM_SEXPR = 4, /* Error in the S-Expression code (Since: v0.1.0) */
VIR_FROM_NONE = 0, /* (Since: 0.1.0) */
VIR_FROM_XEN = 1, /* Error at Xen hypervisor layer (Since: 0.1.0) */
VIR_FROM_XEND = 2, /* Error at connection with xend daemon (Since: 0.1.0) */
VIR_FROM_XENSTORE = 3, /* Error at connection with xen store (Since: 0.1.0) */
VIR_FROM_SEXPR = 4, /* Error in the S-Expression code (Since: 0.1.0) */
VIR_FROM_XML = 5, /* Error in the XML code (Since: v0.1.0) */
VIR_FROM_DOM = 6, /* Error when operating on a domain (Since: v0.1.0) */
VIR_FROM_RPC = 7, /* Error in the XML-RPC code (Since: v0.1.1) */
VIR_FROM_XML = 5, /* Error in the XML code (Since: 0.1.0) */
VIR_FROM_DOM = 6, /* Error when operating on a domain (Since: 0.1.0) */
VIR_FROM_RPC = 7, /* Error in the XML-RPC code (Since: 0.1.1) */
VIR_FROM_PROXY = 8, /* Error in the proxy code; unused since
0.8.6 (Since: v0.1.3) */
VIR_FROM_CONF = 9, /* Error in the configuration file handling (Since: v0.1.6) */
0.8.6 (Since: 0.1.3) */
VIR_FROM_CONF = 9, /* Error in the configuration file handling (Since: 0.1.6) */
VIR_FROM_QEMU = 10, /* Error at the QEMU daemon (Since: v0.2.0) */
VIR_FROM_NET = 11, /* Error when operating on a network (Since: v0.2.0) */
VIR_FROM_TEST = 12, /* Error from test driver (Since: v0.2.3) */
VIR_FROM_REMOTE = 13, /* Error from remote driver (Since: v0.2.3) */
VIR_FROM_OPENVZ = 14, /* Error from OpenVZ driver (Since: v0.3.1) */
VIR_FROM_QEMU = 10, /* Error at the QEMU daemon (Since: 0.2.0) */
VIR_FROM_NET = 11, /* Error when operating on a network (Since: 0.2.0) */
VIR_FROM_TEST = 12, /* Error from test driver (Since: 0.2.3) */
VIR_FROM_REMOTE = 13, /* Error from remote driver (Since: 0.2.3) */
VIR_FROM_OPENVZ = 14, /* Error from OpenVZ driver (Since: 0.3.1) */
VIR_FROM_XENXM = 15, /* Error at Xen XM layer (Since: v0.4.1) */
VIR_FROM_STATS_LINUX = 16, /* Error in the Linux Stats code (Since: v0.4.1) */
VIR_FROM_LXC = 17, /* Error from Linux Container driver (Since: v0.4.2) */
VIR_FROM_STORAGE = 18, /* Error from storage driver (Since: v0.4.1) */
VIR_FROM_NETWORK = 19, /* Error from network config (Since: v0.4.6) */
VIR_FROM_XENXM = 15, /* Error at Xen XM layer (Since: 0.4.1) */
VIR_FROM_STATS_LINUX = 16, /* Error in the Linux Stats code (Since: 0.4.1) */
VIR_FROM_LXC = 17, /* Error from Linux Container driver (Since: 0.4.2) */
VIR_FROM_STORAGE = 18, /* Error from storage driver (Since: 0.4.1) */
VIR_FROM_NETWORK = 19, /* Error from network config (Since: 0.4.6) */
VIR_FROM_DOMAIN = 20, /* Error from domain config (Since: v0.4.6) */
VIR_FROM_UML = 21, /* Error at the UML driver; unused since 5.0.0 (Since: v0.5.0) */
VIR_FROM_NODEDEV = 22, /* Error from node device monitor (Since: v0.5.0) */
VIR_FROM_XEN_INOTIFY = 23, /* Error from xen inotify layer (Since: v0.5.0) */
VIR_FROM_SECURITY = 24, /* Error from security framework (Since: v0.6.1) */
VIR_FROM_DOMAIN = 20, /* Error from domain config (Since: 0.4.6) */
VIR_FROM_UML = 21, /* Error at the UML driver; unused since 5.0.0 (Since: 0.5.0) */
VIR_FROM_NODEDEV = 22, /* Error from node device monitor (Since: 0.5.0) */
VIR_FROM_XEN_INOTIFY = 23, /* Error from xen inotify layer (Since: 0.5.0) */
VIR_FROM_SECURITY = 24, /* Error from security framework (Since: 0.6.1) */
VIR_FROM_VBOX = 25, /* Error from VirtualBox driver (Since: v0.6.3) */
VIR_FROM_INTERFACE = 26, /* Error when operating on an interface (Since: v0.6.4) */
VIR_FROM_VBOX = 25, /* Error from VirtualBox driver (Since: 0.6.3) */
VIR_FROM_INTERFACE = 26, /* Error when operating on an interface (Since: 0.6.4) */
VIR_FROM_ONE = 27, /* The OpenNebula driver no longer exists.
Retained for ABI/API compat only (Since: v0.6.4) */
VIR_FROM_ESX = 28, /* Error from ESX driver (Since: v0.7.0) */
VIR_FROM_PHYP = 29, /* Error from the phyp driver, unused since 6.0.0 (Since: v0.7.0) */
Retained for ABI/API compat only (Since: 0.6.4) */
VIR_FROM_ESX = 28, /* Error from ESX driver (Since: 0.7.0) */
VIR_FROM_PHYP = 29, /* Error from the phyp driver, unused since 6.0.0 (Since: 0.7.0) */
VIR_FROM_SECRET = 30, /* Error from secret storage (Since: v0.7.1) */
VIR_FROM_CPU = 31, /* Error from CPU driver (Since: v0.7.5) */
VIR_FROM_XENAPI = 32, /* Error from XenAPI (Since: v0.8.0) */
VIR_FROM_NWFILTER = 33, /* Error from network filter driver (Since: v0.8.0) */
VIR_FROM_HOOK = 34, /* Error from Synchronous hooks (Since: v0.8.0) */
VIR_FROM_SECRET = 30, /* Error from secret storage (Since: 0.7.1) */
VIR_FROM_CPU = 31, /* Error from CPU driver (Since: 0.7.5) */
VIR_FROM_XENAPI = 32, /* Error from XenAPI (Since: 0.8.0) */
VIR_FROM_NWFILTER = 33, /* Error from network filter driver (Since: 0.8.0) */
VIR_FROM_HOOK = 34, /* Error from Synchronous hooks (Since: 0.8.0) */
VIR_FROM_DOMAIN_SNAPSHOT = 35,/* Error from domain snapshot (Since: v0.8.0) */
VIR_FROM_AUDIT = 36, /* Error from auditing subsystem (Since: v0.8.5) */
VIR_FROM_SYSINFO = 37, /* Error from sysinfo/SMBIOS (Since: v0.8.6) */
VIR_FROM_STREAMS = 38, /* Error from I/O streams (Since: v0.8.6) */
VIR_FROM_VMWARE = 39, /* Error from VMware driver (Since: v0.8.7) */
VIR_FROM_DOMAIN_SNAPSHOT = 35,/* Error from domain snapshot (Since: 0.8.0) */
VIR_FROM_AUDIT = 36, /* Error from auditing subsystem (Since: 0.8.5) */
VIR_FROM_SYSINFO = 37, /* Error from sysinfo/SMBIOS (Since: 0.8.6) */
VIR_FROM_STREAMS = 38, /* Error from I/O streams (Since: 0.8.6) */
VIR_FROM_VMWARE = 39, /* Error from VMware driver (Since: 0.8.7) */
VIR_FROM_EVENT = 40, /* Error from event loop impl (Since: v0.9.0) */
VIR_FROM_LIBXL = 41, /* Error from libxenlight driver (Since: v0.9.0) */
VIR_FROM_LOCKING = 42, /* Error from lock manager (Since: v0.9.2) */
VIR_FROM_HYPERV = 43, /* Error from Hyper-V driver (Since: v0.9.5) */
VIR_FROM_CAPABILITIES = 44, /* Error from capabilities (Since: v0.9.8) */
VIR_FROM_EVENT = 40, /* Error from event loop impl (Since: 0.9.0) */
VIR_FROM_LIBXL = 41, /* Error from libxenlight driver (Since: 0.9.0) */
VIR_FROM_LOCKING = 42, /* Error from lock manager (Since: 0.9.2) */
VIR_FROM_HYPERV = 43, /* Error from Hyper-V driver (Since: 0.9.5) */
VIR_FROM_CAPABILITIES = 44, /* Error from capabilities (Since: 0.9.8) */
VIR_FROM_URI = 45, /* Error from URI handling (Since: v0.9.11) */
VIR_FROM_AUTH = 46, /* Error from auth handling (Since: v0.9.11) */
VIR_FROM_DBUS = 47, /* Error from DBus (Since: v0.9.12) */
VIR_FROM_PARALLELS = 48, /* Error from Parallels (Since: v0.10.0) */
VIR_FROM_DEVICE = 49, /* Error from Device (Since: v0.10.0) */
VIR_FROM_URI = 45, /* Error from URI handling (Since: 0.9.11) */
VIR_FROM_AUTH = 46, /* Error from auth handling (Since: 0.9.11) */
VIR_FROM_DBUS = 47, /* Error from DBus (Since: 0.9.12) */
VIR_FROM_PARALLELS = 48, /* Error from Parallels (Since: 0.10.0) */
VIR_FROM_DEVICE = 49, /* Error from Device (Since: 0.10.0) */
VIR_FROM_SSH = 50, /* Error from libssh2 connection transport (Since: v0.10.0) */
VIR_FROM_LOCKSPACE = 51, /* Error from lockspace (Since: v1.0.0) */
VIR_FROM_INITCTL = 52, /* Error from initctl device communication (Since: v1.0.1) */
VIR_FROM_IDENTITY = 53, /* Error from identity code (Since: v1.0.4) */
VIR_FROM_CGROUP = 54, /* Error from cgroups (Since: v1.0.5) */
VIR_FROM_SSH = 50, /* Error from libssh2 connection transport (Since: 0.10.0) */
VIR_FROM_LOCKSPACE = 51, /* Error from lockspace (Since: 1.0.0) */
VIR_FROM_INITCTL = 52, /* Error from initctl device communication (Since: 1.0.1) */
VIR_FROM_IDENTITY = 53, /* Error from identity code (Since: 1.0.4) */
VIR_FROM_CGROUP = 54, /* Error from cgroups (Since: 1.0.5) */
VIR_FROM_ACCESS = 55, /* Error from access control manager (Since: v1.1.0) */
VIR_FROM_SYSTEMD = 56, /* Error from systemd code (Since: v1.1.1) */
VIR_FROM_BHYVE = 57, /* Error from bhyve driver (Since: v1.2.2) */
VIR_FROM_CRYPTO = 58, /* Error from crypto code (Since: v1.2.3) */
VIR_FROM_FIREWALL = 59, /* Error from firewall (Since: v1.2.4) */
VIR_FROM_ACCESS = 55, /* Error from access control manager (Since: 1.1.0) */
VIR_FROM_SYSTEMD = 56, /* Error from systemd code (Since: 1.1.1) */
VIR_FROM_BHYVE = 57, /* Error from bhyve driver (Since: 1.2.2) */
VIR_FROM_CRYPTO = 58, /* Error from crypto code (Since: 1.2.3) */
VIR_FROM_FIREWALL = 59, /* Error from firewall (Since: 1.2.4) */
VIR_FROM_POLKIT = 60, /* Error from polkit code (Since: v1.2.9) */
VIR_FROM_THREAD = 61, /* Error from thread utils (Since: v1.2.14) */
VIR_FROM_ADMIN = 62, /* Error from admin backend (Since: v1.2.17) */
VIR_FROM_LOGGING = 63, /* Error from log manager (Since: v1.3.0) */
VIR_FROM_XENXL = 64, /* Error from Xen xl config code (Since: v1.3.2) */
VIR_FROM_POLKIT = 60, /* Error from polkit code (Since: 1.2.9) */
VIR_FROM_THREAD = 61, /* Error from thread utils (Since: 1.2.14) */
VIR_FROM_ADMIN = 62, /* Error from admin backend (Since: 1.2.17) */
VIR_FROM_LOGGING = 63, /* Error from log manager (Since: 1.3.0) */
VIR_FROM_XENXL = 64, /* Error from Xen xl config code (Since: 1.3.2) */
VIR_FROM_PERF = 65, /* Error from perf (Since: v1.3.3) */
VIR_FROM_LIBSSH = 66, /* Error from libssh connection transport (Since: v2.5.0) */
VIR_FROM_RESCTRL = 67, /* Error from resource control (Since: v3.7.0) */
VIR_FROM_FIREWALLD = 68, /* Error from firewalld (Since: v5.1.0) */
VIR_FROM_DOMAIN_CHECKPOINT = 69, /* Error from domain checkpoint (Since: v5.2.0) */
VIR_FROM_PERF = 65, /* Error from perf (Since: 1.3.3) */
VIR_FROM_LIBSSH = 66, /* Error from libssh connection transport (Since: 2.5.0) */
VIR_FROM_RESCTRL = 67, /* Error from resource control (Since: 3.7.0) */
VIR_FROM_FIREWALLD = 68, /* Error from firewalld (Since: 5.1.0) */
VIR_FROM_DOMAIN_CHECKPOINT = 69, /* Error from domain checkpoint (Since: 5.2.0) */
VIR_FROM_TPM = 70, /* Error from TPM (Since: v5.6.0) */
VIR_FROM_BPF = 71, /* Error from BPF code (Since: v5.10.0) */
VIR_FROM_CH = 72, /* Error from Cloud-Hypervisor driver (Since: v7.5.0) */
VIR_FROM_TPM = 70, /* Error from TPM (Since: 5.6.0) */
VIR_FROM_BPF = 71, /* Error from BPF code (Since: 5.10.0) */
VIR_FROM_CH = 72, /* Error from Cloud-Hypervisor driver (Since: 7.5.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_ERR_DOMAIN_LAST /* (Since: v0.9.13) */
VIR_ERR_DOMAIN_LAST /* (Since: 0.9.13) */
# endif
} virErrorDomain;
@ -157,14 +157,14 @@ typedef enum {
* Reference counts are not incremented so the underlying objects
* may be deleted without notice after the error has been delivered.
*
* Since: v0.1.0
* Since: 0.1.0
*/
typedef struct _virError virError;
/**
* virErrorPtr:
*
* Since: v0.1.0
* Since: 0.1.0
*/
typedef virError *virErrorPtr;
struct _virError {
@ -217,140 +217,140 @@ struct _virError {
* default:
* }
*
* Since: v0.1.0
* Since: 0.1.0
*/
typedef enum {
VIR_ERR_OK = 0, /* (Since: v0.1.0) */
VIR_ERR_INTERNAL_ERROR = 1, /* internal error (Since: v0.1.0) */
VIR_ERR_NO_MEMORY = 2, /* memory allocation failure (Since: v0.1.0) */
VIR_ERR_NO_SUPPORT = 3, /* no support for this function (Since: v0.1.0) */
VIR_ERR_UNKNOWN_HOST = 4, /* could not resolve hostname (Since: v0.1.0) */
VIR_ERR_NO_CONNECT = 5, /* can't connect to hypervisor (Since: v0.1.0) */
VIR_ERR_INVALID_CONN = 6, /* invalid connection object (Since: v0.1.0) */
VIR_ERR_INVALID_DOMAIN = 7, /* invalid domain object (Since: v0.1.0) */
VIR_ERR_INVALID_ARG = 8, /* invalid function argument (Since: v0.1.0) */
VIR_ERR_OPERATION_FAILED = 9, /* a command to hypervisor failed (Since: v0.1.0) */
VIR_ERR_GET_FAILED = 10, /* a HTTP GET command to failed (Since: v0.1.0) */
VIR_ERR_POST_FAILED = 11, /* a HTTP POST command to failed (Since: v0.1.0) */
VIR_ERR_HTTP_ERROR = 12, /* unexpected HTTP error code (Since: v0.1.0) */
VIR_ERR_SEXPR_SERIAL = 13, /* failure to serialize an S-Expr (Since: v0.1.0) */
VIR_ERR_OK = 0, /* (Since: 0.1.0) */
VIR_ERR_INTERNAL_ERROR = 1, /* internal error (Since: 0.1.0) */
VIR_ERR_NO_MEMORY = 2, /* memory allocation failure (Since: 0.1.0) */
VIR_ERR_NO_SUPPORT = 3, /* no support for this function (Since: 0.1.0) */
VIR_ERR_UNKNOWN_HOST = 4, /* could not resolve hostname (Since: 0.1.0) */
VIR_ERR_NO_CONNECT = 5, /* can't connect to hypervisor (Since: 0.1.0) */
VIR_ERR_INVALID_CONN = 6, /* invalid connection object (Since: 0.1.0) */
VIR_ERR_INVALID_DOMAIN = 7, /* invalid domain object (Since: 0.1.0) */
VIR_ERR_INVALID_ARG = 8, /* invalid function argument (Since: 0.1.0) */
VIR_ERR_OPERATION_FAILED = 9, /* a command to hypervisor failed (Since: 0.1.0) */
VIR_ERR_GET_FAILED = 10, /* a HTTP GET command to failed (Since: 0.1.0) */
VIR_ERR_POST_FAILED = 11, /* a HTTP POST command to failed (Since: 0.1.0) */
VIR_ERR_HTTP_ERROR = 12, /* unexpected HTTP error code (Since: 0.1.0) */
VIR_ERR_SEXPR_SERIAL = 13, /* failure to serialize an S-Expr (Since: 0.1.0) */
VIR_ERR_NO_XEN = 14, /* could not open Xen hypervisor
control (Since: v0.1.0) */
VIR_ERR_XEN_CALL = 15, /* failure doing an hypervisor call (Since: v0.1.0) */
VIR_ERR_OS_TYPE = 16, /* unknown OS type (Since: v0.1.0) */
VIR_ERR_NO_KERNEL = 17, /* missing kernel information (Since: v0.1.0) */
VIR_ERR_NO_ROOT = 18, /* missing root device information (Since: v0.1.0) */
VIR_ERR_NO_SOURCE = 19, /* missing source device information (Since: v0.1.0) */
VIR_ERR_NO_TARGET = 20, /* missing target device information (Since: v0.1.0) */
VIR_ERR_NO_NAME = 21, /* missing domain name information (Since: v0.1.0) */
VIR_ERR_NO_OS = 22, /* missing domain OS information (Since: v0.1.0) */
VIR_ERR_NO_DEVICE = 23, /* missing domain devices information (Since: v0.1.0) */
VIR_ERR_NO_XENSTORE = 24, /* could not open Xen Store control (Since: v0.1.0) */
VIR_ERR_DRIVER_FULL = 25, /* too many drivers registered (Since: v0.1.0) */
control (Since: 0.1.0) */
VIR_ERR_XEN_CALL = 15, /* failure doing an hypervisor call (Since: 0.1.0) */
VIR_ERR_OS_TYPE = 16, /* unknown OS type (Since: 0.1.0) */
VIR_ERR_NO_KERNEL = 17, /* missing kernel information (Since: 0.1.0) */
VIR_ERR_NO_ROOT = 18, /* missing root device information (Since: 0.1.0) */
VIR_ERR_NO_SOURCE = 19, /* missing source device information (Since: 0.1.0) */
VIR_ERR_NO_TARGET = 20, /* missing target device information (Since: 0.1.0) */
VIR_ERR_NO_NAME = 21, /* missing domain name information (Since: 0.1.0) */
VIR_ERR_NO_OS = 22, /* missing domain OS information (Since: 0.1.0) */
VIR_ERR_NO_DEVICE = 23, /* missing domain devices information (Since: 0.1.0) */
VIR_ERR_NO_XENSTORE = 24, /* could not open Xen Store control (Since: 0.1.0) */
VIR_ERR_DRIVER_FULL = 25, /* too many drivers registered (Since: 0.1.0) */
VIR_ERR_CALL_FAILED = 26, /* not supported by the drivers
(DEPRECATED) (Since: v0.1.0) */
(DEPRECATED) (Since: 0.1.0) */
VIR_ERR_XML_ERROR = 27, /* an XML description is not well
formed or broken (Since: v0.1.1) */
VIR_ERR_DOM_EXIST = 28, /* the domain already exist (Since: v0.1.1) */
formed or broken (Since: 0.1.1) */
VIR_ERR_DOM_EXIST = 28, /* the domain already exist (Since: 0.1.1) */
VIR_ERR_OPERATION_DENIED = 29, /* operation forbidden on read-only
connections (Since: v0.1.4) */
VIR_ERR_OPEN_FAILED = 30, /* failed to open a conf file (Since: v0.1.6) */
VIR_ERR_READ_FAILED = 31, /* failed to read a conf file (Since: v0.1.6) */
VIR_ERR_PARSE_FAILED = 32, /* failed to parse a conf file (Since: v0.1.6) */
connections (Since: 0.1.4) */
VIR_ERR_OPEN_FAILED = 30, /* failed to open a conf file (Since: 0.1.6) */
VIR_ERR_READ_FAILED = 31, /* failed to read a conf file (Since: 0.1.6) */
VIR_ERR_PARSE_FAILED = 32, /* failed to parse a conf file (Since: 0.1.6) */
VIR_ERR_CONF_SYNTAX = 33, /* failed to parse the syntax of a
conf file (Since: v0.1.6) */
VIR_ERR_WRITE_FAILED = 34, /* failed to write a conf file (Since: v0.1.6) */
VIR_ERR_XML_DETAIL = 35, /* detail of an XML error (Since: v0.1.9) */
VIR_ERR_INVALID_NETWORK = 36, /* invalid network object (Since: v0.2.0) */
VIR_ERR_NETWORK_EXIST = 37, /* the network already exist (Since: v0.2.0) */
VIR_ERR_SYSTEM_ERROR = 38, /* general system call failure (Since: v0.2.1) */
VIR_ERR_RPC = 39, /* some sort of RPC error (Since: v0.2.3) */
VIR_ERR_GNUTLS_ERROR = 40, /* error from a GNUTLS call (Since: v0.2.3) */
VIR_WAR_NO_NETWORK = 41, /* failed to start network (Since: v0.2.3) */
conf file (Since: 0.1.6) */
VIR_ERR_WRITE_FAILED = 34, /* failed to write a conf file (Since: 0.1.6) */
VIR_ERR_XML_DETAIL = 35, /* detail of an XML error (Since: 0.1.9) */
VIR_ERR_INVALID_NETWORK = 36, /* invalid network object (Since: 0.2.0) */
VIR_ERR_NETWORK_EXIST = 37, /* the network already exist (Since: 0.2.0) */
VIR_ERR_SYSTEM_ERROR = 38, /* general system call failure (Since: 0.2.1) */
VIR_ERR_RPC = 39, /* some sort of RPC error (Since: 0.2.3) */
VIR_ERR_GNUTLS_ERROR = 40, /* error from a GNUTLS call (Since: 0.2.3) */
VIR_WAR_NO_NETWORK = 41, /* failed to start network (Since: 0.2.3) */
VIR_ERR_NO_DOMAIN = 42, /* domain not found or unexpectedly
disappeared (Since: v0.3.0) */
VIR_ERR_NO_NETWORK = 43, /* network not found (Since: v0.3.0) */
VIR_ERR_INVALID_MAC = 44, /* invalid MAC address (Since: v0.3.1) */
VIR_ERR_AUTH_FAILED = 45, /* authentication failed (Since: v0.4.1) */
VIR_ERR_INVALID_STORAGE_POOL = 46, /* invalid storage pool object (Since: v0.4.1) */
VIR_ERR_INVALID_STORAGE_VOL = 47, /* invalid storage vol object (Since: v0.4.1) */
VIR_WAR_NO_STORAGE = 48, /* failed to start storage (Since: v0.4.1) */
VIR_ERR_NO_STORAGE_POOL = 49, /* storage pool not found (Since: v0.4.1) */
VIR_ERR_NO_STORAGE_VOL = 50, /* storage volume not found (Since: v0.4.1) */
VIR_WAR_NO_NODE = 51, /* failed to start node driver (Since: v0.5.0) */
VIR_ERR_INVALID_NODE_DEVICE = 52, /* invalid node device object (Since: v0.5.0) */
VIR_ERR_NO_NODE_DEVICE = 53, /* node device not found (Since: v0.5.0) */
VIR_ERR_NO_SECURITY_MODEL = 54, /* security model not found (Since: v0.6.1) */
disappeared (Since: 0.3.0) */
VIR_ERR_NO_NETWORK = 43, /* network not found (Since: 0.3.0) */
VIR_ERR_INVALID_MAC = 44, /* invalid MAC address (Since: 0.3.1) */
VIR_ERR_AUTH_FAILED = 45, /* authentication failed (Since: 0.4.1) */
VIR_ERR_INVALID_STORAGE_POOL = 46, /* invalid storage pool object (Since: 0.4.1) */
VIR_ERR_INVALID_STORAGE_VOL = 47, /* invalid storage vol object (Since: 0.4.1) */
VIR_WAR_NO_STORAGE = 48, /* failed to start storage (Since: 0.4.1) */
VIR_ERR_NO_STORAGE_POOL = 49, /* storage pool not found (Since: 0.4.1) */
VIR_ERR_NO_STORAGE_VOL = 50, /* storage volume not found (Since: 0.4.1) */
VIR_WAR_NO_NODE = 51, /* failed to start node driver (Since: 0.5.0) */
VIR_ERR_INVALID_NODE_DEVICE = 52, /* invalid node device object (Since: 0.5.0) */
VIR_ERR_NO_NODE_DEVICE = 53, /* node device not found (Since: 0.5.0) */
VIR_ERR_NO_SECURITY_MODEL = 54, /* security model not found (Since: 0.6.1) */
VIR_ERR_OPERATION_INVALID = 55, /* operation is not applicable at this
time (Since: v0.6.4) */
VIR_WAR_NO_INTERFACE = 56, /* failed to start interface driver (Since: v0.6.4) */
VIR_ERR_NO_INTERFACE = 57, /* interface driver not running (Since: v0.6.4) */
VIR_ERR_INVALID_INTERFACE = 58, /* invalid interface object (Since: v0.6.4) */
time (Since: 0.6.4) */
VIR_WAR_NO_INTERFACE = 56, /* failed to start interface driver (Since: 0.6.4) */
VIR_ERR_NO_INTERFACE = 57, /* interface driver not running (Since: 0.6.4) */
VIR_ERR_INVALID_INTERFACE = 58, /* invalid interface object (Since: 0.6.4) */
VIR_ERR_MULTIPLE_INTERFACES = 59, /* more than one matching interface
found (Since: v0.7.0) */
VIR_WAR_NO_NWFILTER = 60, /* failed to start nwfilter driver (Since: v0.8.0) */
VIR_ERR_INVALID_NWFILTER = 61, /* invalid nwfilter object (Since: v0.8.0) */
VIR_ERR_NO_NWFILTER = 62, /* nw filter pool not found (Since: v0.8.0) */
VIR_ERR_BUILD_FIREWALL = 63, /* nw filter pool not found (Since: v0.8.0) */
VIR_WAR_NO_SECRET = 64, /* failed to start secret storage (Since: v0.7.1) */
VIR_ERR_INVALID_SECRET = 65, /* invalid secret (Since: v0.7.1) */
VIR_ERR_NO_SECRET = 66, /* secret not found (Since: v0.7.1) */
found (Since: 0.7.0) */
VIR_WAR_NO_NWFILTER = 60, /* failed to start nwfilter driver (Since: 0.8.0) */
VIR_ERR_INVALID_NWFILTER = 61, /* invalid nwfilter object (Since: 0.8.0) */
VIR_ERR_NO_NWFILTER = 62, /* nw filter pool not found (Since: 0.8.0) */
VIR_ERR_BUILD_FIREWALL = 63, /* nw filter pool not found (Since: 0.8.0) */
VIR_WAR_NO_SECRET = 64, /* failed to start secret storage (Since: 0.7.1) */
VIR_ERR_INVALID_SECRET = 65, /* invalid secret (Since: 0.7.1) */
VIR_ERR_NO_SECRET = 66, /* secret not found (Since: 0.7.1) */
VIR_ERR_CONFIG_UNSUPPORTED = 67, /* unsupported configuration
construct (Since: v0.7.3) */
VIR_ERR_OPERATION_TIMEOUT = 68, /* timeout occurred during operation (Since: v0.7.3) */
construct (Since: 0.7.3) */
VIR_ERR_OPERATION_TIMEOUT = 68, /* timeout occurred during operation (Since: 0.7.3) */
VIR_ERR_MIGRATE_PERSIST_FAILED = 69,/* a migration worked, but making the
VM persist on the dest host failed (Since: v0.7.3) */
VIR_ERR_HOOK_SCRIPT_FAILED = 70, /* a synchronous hook script failed (Since: v0.8.0) */
VIR_ERR_INVALID_DOMAIN_SNAPSHOT = 71,/* invalid domain snapshot (Since: v0.8.0) */
VIR_ERR_NO_DOMAIN_SNAPSHOT = 72, /* domain snapshot not found (Since: v0.8.0) */
VIR_ERR_INVALID_STREAM = 73, /* stream pointer not valid (Since: v0.9.0) */
VM persist on the dest host failed (Since: 0.7.3) */
VIR_ERR_HOOK_SCRIPT_FAILED = 70, /* a synchronous hook script failed (Since: 0.8.0) */
VIR_ERR_INVALID_DOMAIN_SNAPSHOT = 71,/* invalid domain snapshot (Since: 0.8.0) */
VIR_ERR_NO_DOMAIN_SNAPSHOT = 72, /* domain snapshot not found (Since: 0.8.0) */
VIR_ERR_INVALID_STREAM = 73, /* stream pointer not valid (Since: 0.9.0) */
VIR_ERR_ARGUMENT_UNSUPPORTED = 74, /* valid API use but unsupported by
the given driver (Since: v0.9.4) */
VIR_ERR_STORAGE_PROBE_FAILED = 75, /* storage pool probe failed (Since: v0.9.5) */
VIR_ERR_STORAGE_POOL_BUILT = 76, /* storage pool already built (Since: v0.9.5) */
the given driver (Since: 0.9.4) */
VIR_ERR_STORAGE_PROBE_FAILED = 75, /* storage pool probe failed (Since: 0.9.5) */
VIR_ERR_STORAGE_POOL_BUILT = 76, /* storage pool already built (Since: 0.9.5) */
VIR_ERR_SNAPSHOT_REVERT_RISKY = 77, /* force was not requested for a
risky domain snapshot revert (Since: v0.9.7) */
risky domain snapshot revert (Since: 0.9.7) */
VIR_ERR_OPERATION_ABORTED = 78, /* operation on a domain was
canceled/aborted by user (Since: v0.9.9) */
VIR_ERR_AUTH_CANCELLED = 79, /* authentication cancelled (Since: v0.9.10) */
VIR_ERR_NO_DOMAIN_METADATA = 80, /* The metadata is not present (Since: v0.9.10) */
VIR_ERR_MIGRATE_UNSAFE = 81, /* Migration is not safe (Since: v0.9.11) */
VIR_ERR_OVERFLOW = 82, /* integer overflow (Since: v0.9.11) */
VIR_ERR_BLOCK_COPY_ACTIVE = 83, /* action prevented by block copy job (Since: v0.9.12) */
canceled/aborted by user (Since: 0.9.9) */
VIR_ERR_AUTH_CANCELLED = 79, /* authentication cancelled (Since: 0.9.10) */
VIR_ERR_NO_DOMAIN_METADATA = 80, /* The metadata is not present (Since: 0.9.10) */
VIR_ERR_MIGRATE_UNSAFE = 81, /* Migration is not safe (Since: 0.9.11) */
VIR_ERR_OVERFLOW = 82, /* integer overflow (Since: 0.9.11) */
VIR_ERR_BLOCK_COPY_ACTIVE = 83, /* action prevented by block copy job (Since: 0.9.12) */
VIR_ERR_OPERATION_UNSUPPORTED = 84, /* The requested operation is not
supported (Since: v0.10.0) */
VIR_ERR_SSH = 85, /* error in ssh transport driver (Since: v0.10.0) */
supported (Since: 0.10.0) */
VIR_ERR_SSH = 85, /* error in ssh transport driver (Since: 0.10.0) */
VIR_ERR_AGENT_UNRESPONSIVE = 86, /* guest agent is unresponsive,
not running or not usable (Since: v0.10.0) */
VIR_ERR_RESOURCE_BUSY = 87, /* resource is already in use (Since: v1.0.0) */
not running or not usable (Since: 0.10.0) */
VIR_ERR_RESOURCE_BUSY = 87, /* resource is already in use (Since: 1.0.0) */
VIR_ERR_ACCESS_DENIED = 88, /* operation on the object/resource
was denied (Since: v1.1.0) */
VIR_ERR_DBUS_SERVICE = 89, /* error from a dbus service (Since: v1.1.1) */
VIR_ERR_STORAGE_VOL_EXIST = 90, /* the storage vol already exists (Since: v1.1.4) */
VIR_ERR_CPU_INCOMPATIBLE = 91, /* given CPU is incompatible with host CPU (Since: v1.2.6) */
VIR_ERR_XML_INVALID_SCHEMA = 92, /* XML document doesn't validate against schema (Since: v1.2.12) */
VIR_ERR_MIGRATE_FINISH_OK = 93, /* Finish API succeeded but it is expected to return NULL (Since: v1.2.18) */
VIR_ERR_AUTH_UNAVAILABLE = 94, /* authentication unavailable (Since: v1.3.3) */
VIR_ERR_NO_SERVER = 95, /* Server was not found (Since: v1.3.3) */
VIR_ERR_NO_CLIENT = 96, /* Client was not found (Since: v1.3.5) */
was denied (Since: 1.1.0) */
VIR_ERR_DBUS_SERVICE = 89, /* error from a dbus service (Since: 1.1.1) */
VIR_ERR_STORAGE_VOL_EXIST = 90, /* the storage vol already exists (Since: 1.1.4) */
VIR_ERR_CPU_INCOMPATIBLE = 91, /* given CPU is incompatible with host CPU (Since: 1.2.6) */
VIR_ERR_XML_INVALID_SCHEMA = 92, /* XML document doesn't validate against schema (Since: 1.2.12) */
VIR_ERR_MIGRATE_FINISH_OK = 93, /* Finish API succeeded but it is expected to return NULL (Since: 1.2.18) */
VIR_ERR_AUTH_UNAVAILABLE = 94, /* authentication unavailable (Since: 1.3.3) */
VIR_ERR_NO_SERVER = 95, /* Server was not found (Since: 1.3.3) */
VIR_ERR_NO_CLIENT = 96, /* Client was not found (Since: 1.3.5) */
VIR_ERR_AGENT_UNSYNCED = 97, /* guest agent replies with wrong id
to guest-sync command (DEPRECATED) (Since: v2.3.0) */
VIR_ERR_LIBSSH = 98, /* error in libssh transport driver (Since: v2.5.0) */
VIR_ERR_DEVICE_MISSING = 99, /* fail to find the desired device (Since: v4.1.0) */
VIR_ERR_INVALID_NWFILTER_BINDING = 100, /* invalid nwfilter binding (Since: v4.5.0) */
VIR_ERR_NO_NWFILTER_BINDING = 101, /* no nwfilter binding (Since: v4.5.0) */
VIR_ERR_INVALID_DOMAIN_CHECKPOINT = 102, /* invalid domain checkpoint (Since: v5.2.0) */
VIR_ERR_NO_DOMAIN_CHECKPOINT = 103, /* domain checkpoint not found (Since: v5.2.0) */
VIR_ERR_NO_DOMAIN_BACKUP = 104, /* domain backup job id not found (Since: v5.2.0) */
VIR_ERR_INVALID_NETWORK_PORT = 105, /* invalid network port object (Since: v5.5.0) */
VIR_ERR_NETWORK_PORT_EXIST = 106, /* the network port already exist (Since: v5.5.0) */
VIR_ERR_NO_NETWORK_PORT = 107, /* network port not found (Since: v5.5.0) */
VIR_ERR_NO_HOSTNAME = 108, /* no domain's hostname found (Since: v6.1.0) */
VIR_ERR_CHECKPOINT_INCONSISTENT = 109, /* checkpoint can't be used (Since: v6.10.0) */
VIR_ERR_MULTIPLE_DOMAINS = 110, /* more than one matching domain found (Since: v7.1.0) */
to guest-sync command (DEPRECATED) (Since: 2.3.0) */
VIR_ERR_LIBSSH = 98, /* error in libssh transport driver (Since: 2.5.0) */
VIR_ERR_DEVICE_MISSING = 99, /* fail to find the desired device (Since: 4.1.0) */
VIR_ERR_INVALID_NWFILTER_BINDING = 100, /* invalid nwfilter binding (Since: 4.5.0) */
VIR_ERR_NO_NWFILTER_BINDING = 101, /* no nwfilter binding (Since: 4.5.0) */
VIR_ERR_INVALID_DOMAIN_CHECKPOINT = 102, /* invalid domain checkpoint (Since: 5.2.0) */
VIR_ERR_NO_DOMAIN_CHECKPOINT = 103, /* domain checkpoint not found (Since: 5.2.0) */
VIR_ERR_NO_DOMAIN_BACKUP = 104, /* domain backup job id not found (Since: 5.2.0) */
VIR_ERR_INVALID_NETWORK_PORT = 105, /* invalid network port object (Since: 5.5.0) */
VIR_ERR_NETWORK_PORT_EXIST = 106, /* the network port already exist (Since: 5.5.0) */
VIR_ERR_NO_NETWORK_PORT = 107, /* network port not found (Since: 5.5.0) */
VIR_ERR_NO_HOSTNAME = 108, /* no domain's hostname found (Since: 6.1.0) */
VIR_ERR_CHECKPOINT_INCONSISTENT = 109, /* checkpoint can't be used (Since: 6.10.0) */
VIR_ERR_MULTIPLE_DOMAINS = 110, /* more than one matching domain found (Since: 7.1.0) */
# ifdef VIR_ENUM_SENTINELS
VIR_ERR_NUMBER_LAST /* (Since: v5.0.0) */
VIR_ERR_NUMBER_LAST /* (Since: 5.0.0) */
# endif
} virErrorNumber;
@ -361,7 +361,7 @@ typedef enum {
*
* Signature of a function to use when there is an error raised by the library.
*
* Since: v0.1.0
* Since: 0.1.0
*/
typedef void (*virErrorFunc) (void *userData, virErrorPtr error);

62
src/admin/libvirt-admin.c
View File

@ -85,7 +85,7 @@ virAdmGlobalInit(void)
*
* Returns 0 in case of success, -1 in case of error
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmInitialize(void)
@ -203,7 +203,7 @@ virAdmGetDefaultURI(virConf *conf, char **uristr)
*
* Returns @virAdmConnectPtr object or NULL on error
*
* Since: v2.0.0
* Since: 2.0.0
*/
virAdmConnectPtr
virAdmConnectOpen(const char *name, unsigned int flags)
@ -289,7 +289,7 @@ virAdmConnectOpen(const char *name, unsigned int flags)
* application should not try to further use a connection after the
* virAdmConnectClose that matches the initial open.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmConnectClose(virAdmConnectPtr conn)
@ -326,7 +326,7 @@ virAdmConnectClose(virAdmConnectPtr conn)
*
* Returns 0 in case of success, -1 in case of failure
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmConnectRef(virAdmConnectPtr conn)
@ -355,7 +355,7 @@ virAdmConnectRef(virAdmConnectPtr conn)
*
* Returns 0 on success, -1 in case of an error.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmGetVersion(unsigned long long *libVer)
@ -388,7 +388,7 @@ virAdmGetVersion(unsigned long long *libVer)
* Returns 1, if the connection is alive, 0 if there isn't an existing
* connection at all or the channel has already been closed, or -1 on error.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmConnectIsAlive(virAdmConnectPtr conn)
@ -424,7 +424,7 @@ virAdmConnectIsAlive(virAdmConnectPtr conn)
* Returns an URI string related to the connection or NULL in case of an error.
* Caller is responsible for freeing the string.
*
* Since: v2.0.0
* Since: 2.0.0
*/
char *
virAdmConnectGetURI(virAdmConnectPtr conn)
@ -460,7 +460,7 @@ virAdmConnectGetURI(virAdmConnectPtr conn)
*
* Returns 0 on success, -1 on error
*
* Since: v2.0.0
* Since: 2.0.0
*/
int virAdmConnectRegisterCloseCallback(virAdmConnectPtr conn,
virAdmConnectCloseFunc cb,
@ -515,7 +515,7 @@ int virAdmConnectRegisterCloseCallback(virAdmConnectPtr conn,
*
* Returns 0 on success, -1 on error
*
* Since: v2.0.0
* Since: 2.0.0
*/
int virAdmConnectUnregisterCloseCallback(virAdmConnectPtr conn,
virAdmConnectCloseFunc cb)
@ -547,7 +547,7 @@ int virAdmConnectUnregisterCloseCallback(virAdmConnectPtr conn,
*
* Returns 0 on success, -1 on failure and @libVer follows this format:
*
* Since: v2.0.0
* Since: 2.0.0
*/
int virAdmConnectGetLibVersion(virAdmConnectPtr conn,
unsigned long long *libVer)
@ -577,7 +577,7 @@ int virAdmConnectGetLibVersion(virAdmConnectPtr conn,
* Returns a pointer to the name or NULL. The string doesn't need to be
* deallocated since its lifetime will be the same as the server object.
*
* Since: v2.0.0
* Since: 2.0.0
*/
const char *
virAdmServerGetName(virAdmServerPtr srv)
@ -599,7 +599,7 @@ virAdmServerGetName(virAdmServerPtr srv)
*
* Returns 0 on success, -1 on failure.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int virAdmServerFree(virAdmServerPtr srv)
{
@ -624,7 +624,7 @@ int virAdmServerFree(virAdmServerPtr srv)
*
* Returns numeric value used for client's ID or -1 in case of an error.
*
* Since: v2.0.0
* Since: 2.0.0
*/
unsigned long long
virAdmClientGetID(virAdmClientPtr client)
@ -649,7 +649,7 @@ virAdmClientGetID(virAdmClientPtr client)
* (epoch time) if libvirt doesn't have any information about client's
* connection time, or -1 in case of an error.
*
* Since: v2.0.0
* Since: 2.0.0
*/
long long
virAdmClientGetTimestamp(virAdmClientPtr client)
@ -676,7 +676,7 @@ virAdmClientGetTimestamp(virAdmClientPtr client)
* Returns integer representation of the connection transport used by @client
* (this will be one of virClientTransport) or -1 in case of an error.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmClientGetTransport(virAdmClientPtr client)
@ -697,7 +697,7 @@ virAdmClientGetTransport(virAdmClientPtr client)
*
* Returns 0 in success, -1 on failure.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int virAdmClientFree(virAdmClientPtr client)
{
@ -730,7 +730,7 @@ int virAdmClientFree(virAdmClientPtr client)
* Caller is responsible to call virAdmServerFree() on each list element,
* followed by freeing @servers.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmConnectListServers(virAdmConnectPtr conn,
@ -770,7 +770,7 @@ virAdmConnectListServers(virAdmConnectPtr conn,
* Returns the requested server or NULL in case of failure. If the
* server cannot be found, then VIR_ERR_NO_SERVER error is raised.
*
* Since: v2.0.0
* Since: 2.0.0
*/
virAdmServerPtr
virAdmConnectLookupServer(virAdmConnectPtr conn,
@ -813,7 +813,7 @@ virAdmConnectLookupServer(virAdmConnectPtr conn,
*
* Returns 0 on success, -1 in case of an error.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmServerGetThreadPoolParameters(virAdmServerPtr srv,
@ -854,7 +854,7 @@ virAdmServerGetThreadPoolParameters(virAdmServerPtr srv,
*
* Returns 0 on success, -1 in case of an error.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmServerSetThreadPoolParameters(virAdmServerPtr srv,
@ -897,7 +897,7 @@ virAdmServerSetThreadPoolParameters(virAdmServerPtr srv,
* Caller is responsible to call virAdmClientFree() on each list element,
* followed by freeing @clients.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmServerListClients(virAdmServerPtr srv,
@ -937,7 +937,7 @@ virAdmServerListClients(virAdmServerPtr srv,
* Returns the requested client or NULL in case of failure. If the
* client could not be found, then VIR_ERR_NO_CLIENT error is raised.
*
* Since: v2.0.0
* Since: 2.0.0
*/
virAdmClientPtr
virAdmServerLookupClient(virAdmServerPtr srv,
@ -985,7 +985,7 @@ virAdmServerLookupClient(virAdmServerPtr srv,
* Returns 0 if the information has been successfully retrieved or -1 in case
* of an error.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmClientGetInfo(virAdmClientPtr client,
@ -1021,7 +1021,7 @@ virAdmClientGetInfo(virAdmClientPtr client,
* Returns 0 if the daemon's connection with @client was closed successfully
* or -1 in case of an error.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int virAdmClientClose(virAdmClientPtr client,
unsigned int flags)
@ -1060,7 +1060,7 @@ int virAdmClientClose(virAdmClientPtr client,
* Returns 0 on success, allocating @params to size returned in @nparams, or
* -1 in case of an error. Caller is responsible for deallocating @params.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmServerGetClientLimits(virAdmServerPtr srv,
@ -1102,7 +1102,7 @@ virAdmServerGetClientLimits(virAdmServerPtr srv,
* Returns 0 if the limits have been changed successfully or -1 in case of an
* error.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virAdmServerSetClientLimits(virAdmServerPtr srv,
@ -1142,7 +1142,7 @@ virAdmServerSetClientLimits(virAdmServerPtr srv,
* Returns 0 if the TLS files have been updated successfully or -1 in case of an
* error.
*
* Since: v6.2.0
* Since: 6.2.0
*/
int
virAdmServerUpdateTlsFiles(virAdmServerPtr srv,
@ -1182,7 +1182,7 @@ virAdmServerUpdateTlsFiles(virAdmServerPtr srv,
*
* Returns the count of outputs in @outputs, or -1 in case of an error.
*
* Since: v3.0.0
* Since: 3.0.0
*/
int
virAdmConnectGetLoggingOutputs(virAdmConnectPtr conn,
@ -1225,7 +1225,7 @@ virAdmConnectGetLoggingOutputs(virAdmConnectPtr conn,
* Returns the number of filters returned in @filters, or -1 in case of
* an error.
*
* Since: v3.0.0
* Since: 3.0.0
*/
int
virAdmConnectGetLoggingFilters(virAdmConnectPtr conn,
@ -1267,7 +1267,7 @@ virAdmConnectGetLoggingFilters(virAdmConnectPtr conn,
* Returns 0 if the new output or the set of outputs has been defined
* successfully, or -1 in case of an error.
*
* Since: v3.0.0
* Since: 3.0.0
*/
int
virAdmConnectSetLoggingOutputs(virAdmConnectPtr conn,
@ -1307,7 +1307,7 @@ virAdmConnectSetLoggingOutputs(virAdmConnectPtr conn,
* Returns 0 if the new filter or the set of filters has been defined
* successfully, or -1 in case of an error.
*
* Since: v3.0.0
* Since: 3.0.0
*/
int
virAdmConnectSetLoggingFilters(virAdmConnectPtr conn,

24
src/libvirt-domain-checkpoint.c
View File

@ -36,7 +36,7 @@ VIR_LOG_INIT("libvirt.domain-checkpoint");
* Returns a pointer to the name or NULL, the string need not be deallocated
* as its lifetime will be the same as the checkpoint object.
*
* Since: v5.6.0
* Since: 5.6.0
*/
const char *
virDomainCheckpointGetName(virDomainCheckpointPtr checkpoint)
@ -61,7 +61,7 @@ virDomainCheckpointGetName(virDomainCheckpointPtr checkpoint)
*
* Returns the domain or NULL.
*
* Since: v5.6.0
* Since: 5.6.0
*/
virDomainPtr
virDomainCheckpointGetDomain(virDomainCheckpointPtr checkpoint)
@ -86,7 +86,7 @@ virDomainCheckpointGetDomain(virDomainCheckpointPtr checkpoint)
*
* Returns the connection or NULL.
*
* Since: v5.6.0
* Since: 5.6.0
*/
virConnectPtr
virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpoint)
@ -145,7 +145,7 @@ virDomainCheckpointGetConnect(virDomainCheckpointPtr checkpoint)
* Returns an (opaque) new virDomainCheckpointPtr on success or NULL
* on failure.
*
* Since: v5.6.0
* Since: 5.6.0
*/
virDomainCheckpointPtr
virDomainCheckpointCreateXML(virDomainPtr domain,
@ -216,7 +216,7 @@ virDomainCheckpointCreateXML(virDomainPtr domain,
* Returns a 0 terminated UTF-8 encoded XML instance or NULL in case
* of error. The caller must free() the returned value.
*
* Since: v5.6.0
* Since: 5.6.0
*/
char *
virDomainCheckpointGetXMLDesc(virDomainCheckpointPtr checkpoint,
@ -292,7 +292,7 @@ virDomainCheckpointGetXMLDesc(virDomainCheckpointPtr checkpoint,
* responsible for calling virDomainCheckpointFree() on each array element,
* then calling free() on @checkpoints.
*
* Since: v5.6.0
* Since: 5.6.0
*/
int
virDomainListAllCheckpoints(virDomainPtr domain,
@ -361,7 +361,7 @@ virDomainListAllCheckpoints(virDomainPtr domain,
* for calling virDomainCheckpointFree() on each array element, then calling
* free() on @children.
*
* Since: v5.6.0
* Since: 5.6.0
*/
int
virDomainCheckpointListAllChildren(virDomainCheckpointPtr checkpoint,
@ -409,7 +409,7 @@ virDomainCheckpointListAllChildren(virDomainCheckpointPtr checkpoint,
* domain checkpoint cannot be found, then the VIR_ERR_NO_DOMAIN_CHECKPOINT
* error is raised.
*
* Since: v5.6.0
* Since: 5.6.0
*/
virDomainCheckpointPtr
virDomainCheckpointLookupByName(virDomainPtr domain,
@ -457,7 +457,7 @@ virDomainCheckpointLookupByName(virDomainPtr domain,
* given checkpoint is a root (no parent), then the VIR_ERR_NO_DOMAIN_CHECKPOINT
* error is raised.
*
* Since: v5.6.0
* Since: 5.6.0
*/
virDomainCheckpointPtr
virDomainCheckpointGetParent(virDomainCheckpointPtr checkpoint,
@ -512,7 +512,7 @@ virDomainCheckpointGetParent(virDomainCheckpointPtr checkpoint,
*
* Returns 0 on success, -1 on error.
*
* Since: v5.6.0
* Since: 5.6.0
*/
int
virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint,
@ -564,7 +564,7 @@ virDomainCheckpointDelete(virDomainCheckpointPtr checkpoint,
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v5.6.0
* Since: 5.6.0
*/
int
virDomainCheckpointRef(virDomainCheckpointPtr checkpoint)
@ -589,7 +589,7 @@ virDomainCheckpointRef(virDomainCheckpointPtr checkpoint)
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v5.6.0
* Since: 5.6.0
*/
int
virDomainCheckpointFree(virDomainCheckpointPtr checkpoint)

42
src/libvirt-domain-snapshot.c
View File

@ -36,7 +36,7 @@ VIR_LOG_INIT("libvirt.domain-snapshot");
* Returns a pointer to the name or NULL, the string need not be deallocated
* as its lifetime will be the same as the snapshot object.
*
* Since: v0.9.5
* Since: 0.9.5
*/
const char *
virDomainSnapshotGetName(virDomainSnapshotPtr snapshot)
@ -61,7 +61,7 @@ virDomainSnapshotGetName(virDomainSnapshotPtr snapshot)
*
* Returns the domain or NULL.
*
* Since: v0.9.5
* Since: 0.9.5
*/
virDomainPtr
virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot)
@ -86,7 +86,7 @@ virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot)
*
* Returns the connection or NULL.
*
* Since: v0.9.5
* Since: 0.9.5
*/
virConnectPtr
virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot)
@ -220,7 +220,7 @@ virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot)
* Returns an (opaque) new virDomainSnapshotPtr on success or NULL on
* failure.
*
* Since: v0.8.0
* Since: 0.8.0
*/
virDomainSnapshotPtr
virDomainSnapshotCreateXML(virDomainPtr domain,
@ -280,7 +280,7 @@ virDomainSnapshotCreateXML(virDomainPtr domain,
* Returns a 0 terminated UTF-8 encoded XML instance or NULL in case
* of error. The caller must free() the returned value.
*
* Since: v0.8.0
* Since: 0.8.0
*/
char *
virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot,
@ -335,7 +335,7 @@ virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot,
*
* Returns the number of domain snapshots found or -1 in case of error.
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virDomainSnapshotNum(virDomainPtr domain, unsigned int flags)
@ -401,7 +401,7 @@ virDomainSnapshotNum(virDomainPtr domain, unsigned int flags)
* Returns the number of domain snapshots found or -1 in case of error.
* The caller is responsible to call free() for each member of the array.
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virDomainSnapshotListNames(virDomainPtr domain, char **names, int nameslen,
@ -491,7 +491,7 @@ virDomainSnapshotListNames(virDomainPtr domain, char **names, int nameslen,
* for calling virDomainSnapshotFree() on each array element, then calling
* free() on @snaps.
*
* Since: v0.9.13
* Since: 0.9.13
*/
int
virDomainListAllSnapshots(virDomainPtr domain, virDomainSnapshotPtr **snaps,
@ -542,7 +542,7 @@ virDomainListAllSnapshots(virDomainPtr domain, virDomainSnapshotPtr **snaps,
*
* Returns the number of domain snapshots found or -1 in case of error.
*
* Since: v0.9.7
* Since: 0.9.7
*/
int
virDomainSnapshotNumChildren(virDomainSnapshotPtr snapshot, unsigned int flags)
@ -610,7 +610,7 @@ virDomainSnapshotNumChildren(virDomainSnapshotPtr snapshot, unsigned int flags)
* Returns the number of domain snapshots found or -1 in case of error.
* The caller is responsible to call free() for each member of the array.
*
* Since: v0.9.7
* Since: 0.9.7
*/
int
virDomainSnapshotListChildrenNames(virDomainSnapshotPtr snapshot,
@ -683,7 +683,7 @@ virDomainSnapshotListChildrenNames(virDomainSnapshotPtr snapshot,
* for calling virDomainSnapshotFree() on each array element, then calling
* free() on @snaps.
*
* Since: v0.9.13
* Since: 0.9.13
*/
int
virDomainSnapshotListAllChildren(virDomainSnapshotPtr snapshot,
@ -729,7 +729,7 @@ virDomainSnapshotListAllChildren(virDomainSnapshotPtr snapshot,
* domain snapshot cannot be found, then the VIR_ERR_NO_DOMAIN_SNAPSHOT
* error is raised.
*
* Since: v0.8.0
* Since: 0.8.0
*/
virDomainSnapshotPtr
virDomainSnapshotLookupByName(virDomainPtr domain,
@ -771,7 +771,7 @@ virDomainSnapshotLookupByName(virDomainPtr domain,
*
* Returns 1 if such snapshot exists, 0 if it doesn't, -1 on error.
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virDomainHasCurrentSnapshot(virDomainPtr domain, unsigned int flags)
@ -813,7 +813,7 @@ virDomainHasCurrentSnapshot(virDomainPtr domain, unsigned int flags)
* current domain snapshot cannot be found, then the VIR_ERR_NO_DOMAIN_SNAPSHOT
* error is raised.
*
* Since: v0.8.0
* Since: 0.8.0
*/
virDomainSnapshotPtr
virDomainSnapshotCurrent(virDomainPtr domain,
@ -857,7 +857,7 @@ virDomainSnapshotCurrent(virDomainPtr domain,
* given snapshot is a root (no parent), then the VIR_ERR_NO_DOMAIN_SNAPSHOT
* error is raised.
*
* Since: v0.9.7
* Since: 0.9.7
*/
virDomainSnapshotPtr
virDomainSnapshotGetParent(virDomainSnapshotPtr snapshot,
@ -897,7 +897,7 @@ virDomainSnapshotGetParent(virDomainSnapshotPtr snapshot,
*
* Returns 1 if current, 0 if not current, or -1 on error.
*
* Since: v0.9.13
* Since: 0.9.13
*/
int
virDomainSnapshotIsCurrent(virDomainSnapshotPtr snapshot,
@ -938,7 +938,7 @@ virDomainSnapshotIsCurrent(virDomainSnapshotPtr snapshot,
* Returns 1 if the snapshot has metadata, 0 if the snapshot exists without
* help from libvirt, or -1 on error.
*
* Since: v0.9.13
* Since: 0.9.13
*/
int
virDomainSnapshotHasMetadata(virDomainSnapshotPtr snapshot,
@ -1019,7 +1019,7 @@ virDomainSnapshotHasMetadata(virDomainSnapshotPtr snapshot,
*
* Returns 0 if the creation is successful, -1 on error.
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
@ -1078,7 +1078,7 @@ virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
* Returns 0 if the selected snapshot(s) were successfully deleted,
* -1 on error.
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virDomainSnapshotDelete(virDomainSnapshotPtr snapshot,
@ -1130,7 +1130,7 @@ virDomainSnapshotDelete(virDomainSnapshotPtr snapshot,
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.9.13
* Since: 0.9.13
*/
int
virDomainSnapshotRef(virDomainSnapshotPtr snapshot)
@ -1155,7 +1155,7 @@ virDomainSnapshotRef(virDomainSnapshotPtr snapshot)
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virDomainSnapshotFree(virDomainSnapshotPtr snapshot)

370
src/libvirt-domain.c
View File

File diff suppressed because it is too large Load Diff

68
src/libvirt-host.c
View File

@ -48,7 +48,7 @@ VIR_LOG_INIT("libvirt.host");
*
* Returns 0 in case of success, -1 in case of failure
*
* Since: v0.6.0
* Since: 0.6.0
*/
int
virConnectRef(virConnectPtr conn)
@ -88,7 +88,7 @@ virConnectRef(virConnectPtr conn)
*
* Returns: 0 if the identity change was accepted, -1 on error
*
* Since: v5.8.0
* Since: 5.8.0
*/
int
virConnectSetIdentity(virConnectPtr conn,
@ -154,7 +154,7 @@ virConnectSupportsFeature(virConnectPtr conn, int feature)
*
* Returns NULL in case of error, a static zero terminated string otherwise.
*
* Since: v0.0.3
* Since: 0.0.3
*/
const char *
virConnectGetType(virConnectPtr conn)
@ -187,7 +187,7 @@ virConnectGetType(virConnectPtr conn)
* extracted by lack of capacities returns 0 and @hvVer is 0, otherwise
* @hvVer value is major * 1,000,000 + minor * 1,000 + release
*
* Since: v0.0.3
* Since: 0.0.3
*/
int
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
@ -225,7 +225,7 @@ virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
* Returns -1 in case of failure, 0 otherwise, and values for @libVer have
* the format major * 1,000,000 + minor * 1,000 + release.
*
* Since: v0.7.3
* Since: 0.7.3
*/
int
virConnectGetLibVersion(virConnectPtr conn, unsigned long *libVer)
@ -267,7 +267,7 @@ virConnectGetLibVersion(virConnectPtr conn, unsigned long *libVer)
* Returns the hostname which must be freed by the caller, or
* NULL if there was an error.
*
* Since: v0.3.0
* Since: 0.3.0
*/
char *
virConnectGetHostname(virConnectPtr conn)
@ -308,7 +308,7 @@ virConnectGetHostname(virConnectPtr conn)
* Returns the URI string which must be freed by the caller, or
* NULL if there was an error.
*
* Since: v0.3.0
* Since: 0.3.0
*/
char *
virConnectGetURI(virConnectPtr conn)
@ -344,7 +344,7 @@ virConnectGetURI(virConnectPtr conn)
* Returns the XML string which must be freed by the caller, or
* NULL if there was an error.
*
* Since: v0.8.8
* Since: 0.8.8
*/
char *
virConnectGetSysinfo(virConnectPtr conn, unsigned int flags)
@ -384,7 +384,7 @@ virConnectGetSysinfo(virConnectPtr conn, unsigned int flags)
*
* Returns the maximum of virtual CPU or -1 in case of error.
*
* Since: v0.2.1
* Since: 0.2.1
*/
int
virConnectGetMaxVcpus(virConnectPtr conn,
@ -435,7 +435,7 @@ virConnectGetMaxVcpus(virConnectPtr conn,
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.1.0
* Since: 0.1.0
*/
int
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
@ -473,7 +473,7 @@ virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
* defining the capabilities.
* The client must free the returned string after use.
*
* Since: v0.2.1
* Since: 0.2.1
*/
char *
virConnectGetCapabilities(virConnectPtr conn)
@ -555,7 +555,7 @@ virConnectGetCapabilities(virConnectPtr conn)
*
* Returns -1 in case of error, 0 in case of success.
*
* Since: v0.9.3
* Since: 0.9.3
*/
int
virNodeGetCPUStats(virConnectPtr conn,
@ -644,7 +644,7 @@ virNodeGetCPUStats(virConnectPtr conn,
*
* Returns -1 in case of error, 0 in case of success.
*
* Since: v0.9.3
* Since: 0.9.3
*/
int
virNodeGetMemoryStats(virConnectPtr conn,
@ -693,7 +693,7 @@ virNodeGetMemoryStats(virConnectPtr conn,
*
* Returns the available free memory in bytes or 0 in case of error
*
* Since: v0.3.3
* Since: 0.3.3
*/
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
@ -741,7 +741,7 @@ virNodeGetFreeMemory(virConnectPtr conn)
* delay), -1 on failure (the operation is not supported, or an attempted
* suspend is already underway).
*
* Since: v0.9.8
* Since: 0.9.8
*/
int
virNodeSuspendForDuration(virConnectPtr conn,
@ -796,7 +796,7 @@ virNodeSuspendForDuration(virConnectPtr conn,
*
* Returns 0 in case of success, and -1 in case of failure.
*
* Since: v0.10.2
* Since: 0.10.2
*/
int
virNodeGetMemoryParameters(virConnectPtr conn,
@ -862,7 +862,7 @@ virNodeGetMemoryParameters(virConnectPtr conn,
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v0.10.2
* Since: 0.10.2
*/
int
virNodeSetMemoryParameters(virConnectPtr conn,
@ -912,7 +912,7 @@ virNodeSetMemoryParameters(virConnectPtr conn,
*
* Returns 0 in case of success, -1 in case of failure
*
* Since: v0.6.1
* Since: 0.6.1
*/
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
@ -957,7 +957,7 @@ virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
*
* Returns the number of entries filled in freeMems, or -1 in case of error.
*
* Since: v0.3.3
* Since: 0.3.3
*/
int
virNodeGetCellsFreeMemory(virConnectPtr conn, unsigned long long *freeMems,
@ -997,7 +997,7 @@ virNodeGetCellsFreeMemory(virConnectPtr conn, unsigned long long *freeMems,
*
* Returns 1 if encrypted, 0 if not encrypted, -1 on error
*
* Since: v0.7.3
* Since: 0.7.3
*/
int
virConnectIsEncrypted(virConnectPtr conn)
@ -1034,7 +1034,7 @@ virConnectIsEncrypted(virConnectPtr conn)
*
* Returns 1 if secure, 0 if not secure, -1 on error
*
* Since: v0.7.3
* Since: 0.7.3
*/
int
virConnectIsSecure(virConnectPtr conn)
@ -1078,7 +1078,7 @@ virConnectIsSecure(virConnectPtr conn)
* VIR_ERR_CPU_INCOMPATIBLE code with a message providing more details about
* the incompatibility.
*
* Since: v0.7.5
* Since: 0.7.5
*/
int
virConnectCompareCPU(virConnectPtr conn,
@ -1136,7 +1136,7 @@ virConnectCompareCPU(virConnectPtr conn,
* VIR_ERR_CPU_INCOMPATIBLE code with a message providing more details about
* the incompatibility.
*
* Since: v4.4.0
* Since: 4.4.0
*/
int
virConnectCompareHypervisorCPU(virConnectPtr conn,
@ -1200,7 +1200,7 @@ virConnectCompareHypervisorCPU(virConnectPtr conn,
* Returns -1 on error, number of elements in @models on success (0 means
* libvirt accepts any CPU model).
*
* Since: v1.1.3
* Since: 1.1.3
*/
int
virConnectGetCPUModelNames(virConnectPtr conn, const char *arch, char ***models,
@ -1258,7 +1258,7 @@ virConnectGetCPUModelNames(virConnectPtr conn, const char *arch, char ***models,
*
* Returns XML description of the computed CPU (caller frees) or NULL on error.
*
* Since: v0.7.7
* Since: 0.7.7
*/
char *
virConnectBaselineCPU(virConnectPtr conn,
@ -1329,7 +1329,7 @@ virConnectBaselineCPU(virConnectPtr conn,
*
* Returns XML description of the computed CPU (caller frees) or NULL on error.
*
* Since: v4.4.0
* Since: 4.4.0
*/
char *
virConnectBaselineHypervisorCPU(virConnectPtr conn,
@ -1404,7 +1404,7 @@ virConnectBaselineHypervisorCPU(virConnectPtr conn,
* Returns -1 on error, 0 on success, 1 when remote party doesn't support
* keepalive messages.
*
* Since: v0.9.8
* Since: 0.9.8
*/
int
virConnectSetKeepAlive(virConnectPtr conn,
@ -1443,7 +1443,7 @@ virConnectSetKeepAlive(virConnectPtr conn,
*
* Returns 1 if alive, 0 if dead, -1 on error
*
* Since: v0.9.8
* Since: 0.9.8
*/
int
virConnectIsAlive(virConnectPtr conn)
@ -1491,7 +1491,7 @@ virConnectIsAlive(virConnectPtr conn)
*
* Returns 0 on success, -1 on error
*
* Since: v0.10.0
* Since: 0.10.0
*/
int
virConnectRegisterCloseCallback(virConnectPtr conn,
@ -1530,7 +1530,7 @@ virConnectRegisterCloseCallback(virConnectPtr conn,
*
* Returns 0 on success, -1 on error
*
* Since: v0.10.0
* Since: 0.10.0
*/
int
virConnectUnregisterCloseCallback(virConnectPtr conn,
@ -1574,7 +1574,7 @@ virConnectUnregisterCloseCallback(virConnectPtr conn,
* Returns number of CPUs present on the host node,
* or -1 if there was an error.
*
* Since: v1.0.0
* Since: 1.0.0
*/
int
virNodeGetCPUMap(virConnectPtr conn,
@ -1662,7 +1662,7 @@ virNodeGetCPUMap(virConnectPtr conn,
*
* Returns: the number of entries filled in @counts or -1 in case of error.
*
* Since: v1.2.6
* Since: 1.2.6
*/
int
virNodeGetFreePages(virConnectPtr conn,
@ -1734,7 +1734,7 @@ virNodeGetFreePages(virConnectPtr conn,
* Returns: the number of nodes successfully adjusted or -1 in
* case of an error.
*
* Since: v1.2.9
* Since: 1.2.9
*/
int
virNodeAllocPages(virConnectPtr conn,
@ -1789,7 +1789,7 @@ virNodeAllocPages(virConnectPtr conn,
*
* Returns 0 in case of success, and -1 in case of failure.
*
* Since: v4.5.0
* Since: 4.5.0
*/
int
virNodeGetSEVInfo(virConnectPtr conn,

42
src/libvirt-interface.c
View File

@ -37,7 +37,7 @@ VIR_LOG_INIT("libvirt.interface");
*
* Returns the virConnectPtr or NULL in case of failure.
*
* Since: v0.6.4
* Since: 0.6.4
*/
virConnectPtr
virInterfaceGetConnect(virInterfacePtr iface)
@ -79,7 +79,7 @@ virInterfaceGetConnect(virInterfacePtr iface)
* to make iteration easier. The caller is responsible for calling
* virStorageInterfaceFree() on each array element, then calling free() on @ifaces.
*
* Since: v0.10.2
* Since: 0.10.2
*/
int
virConnectListAllInterfaces(virConnectPtr conn,
@ -120,7 +120,7 @@ virConnectListAllInterfaces(virConnectPtr conn,
*
* Returns the number of active interfaces found or -1 in case of error
*
* Since: v0.6.4
* Since: 0.6.4
*/
int
virConnectNumOfInterfaces(virConnectPtr conn)
@ -165,7 +165,7 @@ virConnectNumOfInterfaces(virConnectPtr conn)
* all currently active interfaces were listed if the return is less than
* @maxnames. The client must call free() on each returned name.
*
* Since: v0.6.4
* Since: 0.6.4
*/
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
@ -202,7 +202,7 @@ virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
*
* Returns the number of defined interface found or -1 in case of error
*
* Since: v0.7.0
* Since: 0.7.0
*/
int
virConnectNumOfDefinedInterfaces(virConnectPtr conn)
@ -247,7 +247,7 @@ virConnectNumOfDefinedInterfaces(virConnectPtr conn)
* guaranteed that all currently defined interfaces were listed if the return
* is less than @maxnames. The client must call free() on each returned name.
*
* Since: v0.7.0
* Since: 0.7.0
*/
int
virConnectListDefinedInterfaces(virConnectPtr conn,
@ -291,7 +291,7 @@ virConnectListDefinedInterfaces(virConnectPtr conn,
* Returns a new interface object or NULL in case of failure. If the
* interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.
*
* Since: v0.6.4
* Since: 0.6.4
*/
virInterfacePtr
virInterfaceLookupByName(virConnectPtr conn, const char *name)
@ -332,7 +332,7 @@ virInterfaceLookupByName(virConnectPtr conn, const char *name)
* Returns a new interface object or NULL in case of failure. If the
* interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.
*
* Since: v0.6.4
* Since: 0.6.4
*/
virInterfacePtr
virInterfaceLookupByMACString(virConnectPtr conn, const char *macstr)
@ -369,7 +369,7 @@ virInterfaceLookupByMACString(virConnectPtr conn, const char *macstr)
* Returns a pointer to the name or NULL, the string need not be deallocated
* its lifetime will be the same as the interface object.
*
* Since: v0.6.4
* Since: 0.6.4
*/
const char *
virInterfaceGetName(virInterfacePtr iface)
@ -395,7 +395,7 @@ virInterfaceGetName(virInterfacePtr iface)
* format) or NULL, the string need not be deallocated its lifetime
* will be the same as the interface object.
*
* Since: v0.6.4
* Since: 0.6.4
*/
const char *
virInterfaceGetMACString(virInterfacePtr iface)
@ -428,7 +428,7 @@ virInterfaceGetMACString(virInterfacePtr iface)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*
* Since: v0.6.4
* Since: 0.6.4
*/
char *
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
@ -481,7 +481,7 @@ virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
*
* Returns NULL in case of error, a pointer to the interface otherwise
*
* Since: v0.6.4
* Since: 0.6.4
*/
virInterfacePtr
virInterfaceDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
@ -529,7 +529,7 @@ virInterfaceDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of error
*
* Since: v0.6.4
* Since: 0.6.4
*/
int
virInterfaceUndefine(virInterfacePtr iface)
@ -574,7 +574,7 @@ virInterfaceUndefine(virInterfacePtr iface)
*
* Returns 0 in case of success, -1 in case of error
*
* Since: v0.6.4
* Since: 0.6.4
*/
int
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
@ -623,7 +623,7 @@ virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.6.4
* Since: 0.6.4
*/
int
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
@ -671,7 +671,7 @@ virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v0.6.4
* Since: 0.6.4
*/
int
virInterfaceRef(virInterfacePtr iface)
@ -696,7 +696,7 @@ virInterfaceRef(virInterfacePtr iface)
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.6.4
* Since: 0.6.4
*/
int
virInterfaceFree(virInterfacePtr iface)
@ -729,7 +729,7 @@ virInterfaceFree(virInterfacePtr iface)
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.9.2
* Since: 0.9.2
*/
int
virInterfaceChangeBegin(virConnectPtr conn, unsigned int flags)
@ -771,7 +771,7 @@ virInterfaceChangeBegin(virConnectPtr conn, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.9.2
* Since: 0.9.2
*/
int
virInterfaceChangeCommit(virConnectPtr conn, unsigned int flags)
@ -813,7 +813,7 @@ virInterfaceChangeCommit(virConnectPtr conn, unsigned int flags)
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.9.2
* Since: 0.9.2
*/
int
virInterfaceChangeRollback(virConnectPtr conn, unsigned int flags)
@ -850,7 +850,7 @@ virInterfaceChangeRollback(virConnectPtr conn, unsigned int flags)
*
* Returns 1 if running, 0 if inactive, -1 on error
*
* Since: v0.7.3
* Since: 0.7.3
*/
int
virInterfaceIsActive(virInterfacePtr iface)

8
src/libvirt-lxc.c
View File

@ -60,7 +60,7 @@ VIR_LOG_INIT("libvirt-lxc");
*
* Returns the number of opened file descriptors, or -1 on error
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virDomainLxcOpenNamespace(virDomainPtr domain,
@ -118,7 +118,7 @@ virDomainLxcOpenNamespace(virDomainPtr domain,
*
* Returns 0 on success, -1 on error
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virDomainLxcEnterNamespace(virDomainPtr domain,
@ -187,7 +187,7 @@ virDomainLxcEnterNamespace(virDomainPtr domain,
*
* Returns 0 on success, -1 on error
*
* Since: v1.0.4
* Since: 1.0.4
*/
int
virDomainLxcEnterSecurityLabel(virSecurityModelPtr model,
@ -290,7 +290,7 @@ virDomainLxcEnterSecurityLabel(virSecurityModelPtr model,
*
* Returns 0 on success, -1 on error
*
* Since: v2.0.0
* Since: 2.0.0
*/
int virDomainLxcEnterCGroup(virDomainPtr domain,
unsigned int flags)

90
src/libvirt-network.c
View File

@ -39,7 +39,7 @@ VIR_LOG_INIT("libvirt.network");
*
* Returns the virConnectPtr or NULL in case of failure.
*
* Since: v0.3.0
* Since: 0.3.0
*/
virConnectPtr
virNetworkGetConnect(virNetworkPtr net)
@ -89,7 +89,7 @@ virNetworkGetConnect(virNetworkPtr net)
* to make iteration easier. The caller is responsible for calling
* virNetworkFree() on each array element, then calling free() on @nets.
*
* Since: v0.10.2
* Since: 0.10.2
*/
int
virConnectListAllNetworks(virConnectPtr conn,
@ -130,7 +130,7 @@ virConnectListAllNetworks(virConnectPtr conn,
*
* Returns the number of network found or -1 in case of error
*
* Since: v0.2.0
* Since: 0.2.0
*/
int
virConnectNumOfNetworks(virConnectPtr conn)
@ -174,7 +174,7 @@ virConnectNumOfNetworks(virConnectPtr conn)
* all currently active networks were listed if the return is less than
* @maxnames. The client must call free() on each returned name.
*
* Since: v0.2.0
* Since: 0.2.0
*/
int
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
@ -211,7 +211,7 @@ virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
*
* Returns the number of networks found or -1 in case of error
*
* Since: v0.2.0
* Since: 0.2.0
*/
int
virConnectNumOfDefinedNetworks(virConnectPtr conn)
@ -255,7 +255,7 @@ virConnectNumOfDefinedNetworks(virConnectPtr conn)
* guaranteed that all currently defined networks were listed if the return
* is less than @maxnames. The client must call free() on each returned name.
*
* Since: v0.2.0
* Since: 0.2.0
*/
int
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
@ -298,7 +298,7 @@ virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
* Returns a new network object or NULL in case of failure. If the
* network cannot be found, then VIR_ERR_NO_NETWORK error is raised.
*
* Since: v0.2.0
* Since: 0.2.0
*/
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
@ -339,7 +339,7 @@ virNetworkLookupByName(virConnectPtr conn, const char *name)
* Returns a new network object or NULL in case of failure. If the
* network cannot be found, then VIR_ERR_NO_NETWORK error is raised.
*
* Since: v0.2.0
* Since: 0.2.0
*/
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
@ -377,7 +377,7 @@ virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
* Returns a new network object or NULL in case of failure. If the
* network cannot be found, then VIR_ERR_NO_NETWORK error is raised.
*
* Since: v0.2.0
* Since: 0.2.0
*/
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
@ -418,7 +418,7 @@ virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
*
* Returns a new network object or NULL in case of failure
*
* Since: v0.2.0
* Since: 0.2.0
*/
virNetworkPtr
virNetworkCreateXML(virConnectPtr conn, const char *xmlDesc)
@ -461,7 +461,7 @@ virNetworkCreateXML(virConnectPtr conn, const char *xmlDesc)
*
* Returns a new network object or NULL in case of failure
*
* Since: v7.8.0
* Since: 7.8.0
*/
virNetworkPtr
virNetworkCreateXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int flags)
@ -503,7 +503,7 @@ virNetworkCreateXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int f
*
* Returns NULL in case of error, a pointer to the network otherwise
*
* Since: v0.2.0
* Since: 0.2.0
*/
virNetworkPtr
virNetworkDefineXML(virConnectPtr conn, const char *xml)
@ -546,7 +546,7 @@ virNetworkDefineXML(virConnectPtr conn, const char *xml)
*
* Returns NULL in case of error, a pointer to the network otherwise
*
* Since: v7.7.0
* Since: 7.7.0
*/
virNetworkPtr
virNetworkDefineXMLFlags(virConnectPtr conn, const char *xml, unsigned int flags)
@ -583,7 +583,7 @@ virNetworkDefineXMLFlags(virConnectPtr conn, const char *xml, unsigned int flags
*
* Returns 0 in case of success, -1 in case of error
*
* Since: v0.2.0
* Since: 0.2.0
*/
int
virNetworkUndefine(virNetworkPtr network)
@ -633,7 +633,7 @@ virNetworkUndefine(virNetworkPtr network)
*
* Returns 0 in case of success, -1 in case of error
*
* Since: v0.10.2
* Since: 0.10.2
*/
int
virNetworkUpdate(virNetworkPtr network,
@ -701,7 +701,7 @@ virNetworkUpdate(virNetworkPtr network,
*
* Returns 0 in case of success, -1 in case of error
*
* Since: v0.2.0
* Since: 0.2.0
*/
int
virNetworkCreate(virNetworkPtr network)
@ -743,7 +743,7 @@ virNetworkCreate(virNetworkPtr network)
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.2.0
* Since: 0.2.0
*/
int
virNetworkDestroy(virNetworkPtr network)
@ -783,7 +783,7 @@ virNetworkDestroy(virNetworkPtr network)
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.2.0
* Since: 0.2.0
*/
int
virNetworkFree(virNetworkPtr network)
@ -816,7 +816,7 @@ virNetworkFree(virNetworkPtr network)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v0.6.0
* Since: 0.6.0
*/
int
virNetworkRef(virNetworkPtr network)
@ -841,7 +841,7 @@ virNetworkRef(virNetworkPtr network)
* Returns a pointer to the name or NULL, the string need not be deallocated
* its lifetime will be the same as the network object.
*
* Since: v0.2.0
* Since: 0.2.0
*/
const char *
virNetworkGetName(virNetworkPtr network)
@ -865,7 +865,7 @@ virNetworkGetName(virNetworkPtr network)
*
* Returns -1 in case of error, 0 in case of success
*
* Since: v0.2.0
* Since: 0.2.0
*/
int
virNetworkGetUUID(virNetworkPtr network, unsigned char *uuid)
@ -897,7 +897,7 @@ virNetworkGetUUID(virNetworkPtr network, unsigned char *uuid)
*
* Returns -1 in case of error, 0 in case of success
*
* Since: v0.2.0
* Since: 0.2.0
*/
int
virNetworkGetUUIDString(virNetworkPtr network, char *buf)
@ -934,7 +934,7 @@ virNetworkGetUUIDString(virNetworkPtr network, char *buf)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*
* Since: v0.2.0
* Since: 0.2.0
*/
char *
virNetworkGetXMLDesc(virNetworkPtr network, unsigned int flags)
@ -973,7 +973,7 @@ virNetworkGetXMLDesc(virNetworkPtr network, unsigned int flags)
* Returns a 0 terminated interface name, or NULL in case of
* error. The caller must free() the returned value.
*
* Since: v0.2.0
* Since: 0.2.0
*/
char *
virNetworkGetBridgeName(virNetworkPtr network)
@ -1013,7 +1013,7 @@ virNetworkGetBridgeName(virNetworkPtr network)
*
* Returns -1 in case of error, 0 in case of success
*
* Since: v0.2.1
* Since: 0.2.1
*/
int
virNetworkGetAutostart(virNetworkPtr network,
@ -1055,7 +1055,7 @@ virNetworkGetAutostart(virNetworkPtr network,
*
* Returns -1 in case of error, 0 in case of success
*
* Since: v0.2.1
* Since: 0.2.1
*/
int
virNetworkSetAutostart(virNetworkPtr network,
@ -1095,7 +1095,7 @@ virNetworkSetAutostart(virNetworkPtr network,
*
* Returns 1 if running, 0 if inactive, -1 on error
*
* Since: v0.7.3
* Since: 0.7.3
*/
int
virNetworkIsActive(virNetworkPtr net)
@ -1130,7 +1130,7 @@ virNetworkIsActive(virNetworkPtr net)
*
* Returns 1 if persistent, 0 if transient, -1 on error
*
* Since: v0.7.3
* Since: 0.7.3
*/
int
virNetworkIsPersistent(virNetworkPtr net)
@ -1191,7 +1191,7 @@ virNetworkIsPersistent(virNetworkPtr net)
*
* Returns a callback identifier on success, -1 on failure.
*
* Since: v1.2.1
* Since: 1.2.1
*/
int
virConnectNetworkEventRegisterAny(virConnectPtr conn,
@ -1254,7 +1254,7 @@ virConnectNetworkEventRegisterAny(virConnectPtr conn,
*
* Returns 0 on success, -1 on failure
*
* Since: v1.2.1
* Since: 1.2.1
*/
int
virConnectNetworkEventDeregisterAny(virConnectPtr conn,
@ -1357,7 +1357,7 @@ virConnectNetworkEventDeregisterAny(virConnectPtr conn,
* Returns the number of leases found or -1 and sets @leases to NULL in
* case of error.
*
* Since: v1.2.6
* Since: 1.2.6
*/
int
virNetworkGetDHCPLeases(virNetworkPtr network,
@ -1400,7 +1400,7 @@ virNetworkGetDHCPLeases(virNetworkPtr network,
*
* Frees all the memory occupied by @lease.
*
* Since: v1.2.6
* Since: 1.2.6
*/
void
virNetworkDHCPLeaseFree(virNetworkDHCPLeasePtr lease)
@ -1430,7 +1430,7 @@ virNetworkDHCPLeaseFree(virNetworkDHCPLeasePtr lease)
* Returns a new network port object or NULL in case of failure. If the
* network port cannot be found, then VIR_ERR_NO_NETWORK_PORT error is raised.
*
* Since: v5.5.0
* Since: 5.5.0
*/
virNetworkPortPtr
virNetworkPortLookupByUUID(virNetworkPtr net,
@ -1469,7 +1469,7 @@ virNetworkPortLookupByUUID(virNetworkPtr net,
* Returns a new network port object or NULL in case of failure. If the
* network port cannot be found, then VIR_ERR_NO_NETWORK_PORT error is raised.
*
* Since: v5.5.0
* Since: 5.5.0
*/
virNetworkPortPtr
virNetworkPortLookupByUUIDString(virNetworkPtr net,
@ -1511,7 +1511,7 @@ virNetworkPortLookupByUUIDString(virNetworkPtr net,
*
* Returns -1 in case of error, 0 in case of success.
*
* Since: v5.5.0
* Since: 5.5.0
*/
int
virNetworkPortSetParameters(virNetworkPortPtr port,
@ -1561,7 +1561,7 @@ virNetworkPortSetParameters(virNetworkPortPtr port,
*
* Returns -1 in case of error, 0 in case of success.
*
* Since: v5.5.0
* Since: 5.5.0
*/
int
virNetworkPortGetParameters(virNetworkPortPtr port,
@ -1607,7 +1607,7 @@ virNetworkPortGetParameters(virNetworkPortPtr port,
*
* Returns a new network port object or NULL in case of failure
*
* Since: v5.5.0
* Since: 5.5.0
*/
virNetworkPortPtr
virNetworkPortCreateXML(virNetworkPtr net,
@ -1647,7 +1647,7 @@ virNetworkPortCreateXML(virNetworkPtr net,
*
* Returns the virNetworkPtr or NULL in case of failure.
*
* Since: v5.5.0
* Since: 5.5.0
*/
virNetworkPtr
virNetworkPortGetNetwork(virNetworkPortPtr port)
@ -1673,7 +1673,7 @@ virNetworkPortGetNetwork(virNetworkPortPtr port)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
* the caller must free() the returned value.
*
* Since: v5.5.0
* Since: 5.5.0
*/
char *
virNetworkPortGetXMLDesc(virNetworkPortPtr port,
@ -1712,7 +1712,7 @@ virNetworkPortGetXMLDesc(virNetworkPortPtr port,
*
* Returns -1 in case of error, 0 in case of success
*
* Since: v5.5.0
* Since: 5.5.0
*/
int
virNetworkPortGetUUID(virNetworkPortPtr port,
@ -1745,7 +1745,7 @@ virNetworkPortGetUUID(virNetworkPortPtr port,
*
* Returns -1 in case of error, 0 in case of success
*
* Since: v5.5.0
* Since: 5.5.0
*/
int
virNetworkPortGetUUIDString(virNetworkPortPtr port,
@ -1779,7 +1779,7 @@ virNetworkPortGetUUIDString(virNetworkPortPtr port,
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v5.5.0
* Since: 5.5.0
*/
int
virNetworkPortDelete(virNetworkPortPtr port,
@ -1829,7 +1829,7 @@ virNetworkPortDelete(virNetworkPortPtr port,
* for calling virNetworkPortFree() on each array element, then calling
* free() on @ports.
*
* Since: v5.5.0
* Since: 5.5.0
*/
int
virNetworkListAllPorts(virNetworkPtr network,
@ -1868,7 +1868,7 @@ virNetworkListAllPorts(virNetworkPtr network,
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v5.5.0
* Since: 5.5.0
*/
int
virNetworkPortFree(virNetworkPortPtr port)
@ -1901,7 +1901,7 @@ virNetworkPortFree(virNetworkPortPtr port)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v5.5.0
* Since: 5.5.0
*/
int
virNetworkPortRef(virNetworkPortPtr port)

54
src/libvirt-nodedev.c
View File

@ -41,7 +41,7 @@ VIR_LOG_INIT("libvirt.nodedev");
*
* Returns the number of node devices or -1 in case of error
*
* Since: v0.5.0
* Since: 0.5.0
*/
int
virNodeNumOfDevices(virConnectPtr conn, const char *cap, unsigned int flags)
@ -89,7 +89,7 @@ virNodeNumOfDevices(virConnectPtr conn, const char *cap, unsigned int flags)
* virNodeDeviceFree() on each array element, then calling free() on
* @devices.
*
* Since: v0.10.2
* Since: 0.10.2
*/
int
virConnectListAllNodeDevices(virConnectPtr conn,
@ -140,7 +140,7 @@ virConnectListAllNodeDevices(virConnectPtr conn,
*
* Returns the number of node devices found or -1 in case of error
*
* Since: v0.5.0
* Since: 0.5.0
*/
int
virNodeListDevices(virConnectPtr conn,
@ -185,7 +185,7 @@ virNodeListDevices(virConnectPtr conn,
*
* Returns a virNodeDevicePtr if found, NULL otherwise.
*
* Since: v0.5.0
* Since: 0.5.0
*/
virNodeDevicePtr
virNodeDeviceLookupByName(virConnectPtr conn, const char *name)
@ -227,7 +227,7 @@ virNodeDeviceLookupByName(virConnectPtr conn, const char *name)
*
* Returns a virNodeDevicePtr if found, NULL otherwise.
*
* Since: v1.0.3
* Since: 1.0.3
*/
virNodeDevicePtr
virNodeDeviceLookupSCSIHostByWWN(virConnectPtr conn,
@ -271,7 +271,7 @@ virNodeDeviceLookupSCSIHostByWWN(virConnectPtr conn,
*
* Returns the XML document, or NULL on error
*
* Since: v0.5.0
* Since: 0.5.0
*/
char *
virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
@ -306,7 +306,7 @@ virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
*
* Returns the device name or NULL in case of error
*
* Since: v0.5.0
* Since: 0.5.0
*/
const char *
virNodeDeviceGetName(virNodeDevicePtr dev)
@ -330,7 +330,7 @@ virNodeDeviceGetName(virNodeDevicePtr dev)
* Returns the name of the device's parent, or NULL if an
* error occurred or when the device has no parent.
*
* Since: v0.5.0
* Since: 0.5.0
*/
const char *
virNodeDeviceGetParent(virNodeDevicePtr dev)
@ -363,7 +363,7 @@ virNodeDeviceGetParent(virNodeDevicePtr dev)
* Returns the number of capabilities supported by the device or -1
* in case of error.
*
* Since: v0.5.0
* Since: 0.5.0
*/
int
virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
@ -401,7 +401,7 @@ virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
* Returns the number of capability names listed in @names or -1
* in case of error.
*
* Since: v0.5.0
* Since: 0.5.0
*/
int
virNodeDeviceListCaps(virNodeDevicePtr dev,
@ -442,7 +442,7 @@ virNodeDeviceListCaps(virNodeDevicePtr dev,
*
* Returns the 0 for success, -1 for error.
*
* Since: v0.5.0
* Since: 0.5.0
*/
int
virNodeDeviceFree(virNodeDevicePtr dev)
@ -475,7 +475,7 @@ virNodeDeviceFree(virNodeDevicePtr dev)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v0.6.0
* Since: 0.6.0
*/
int
virNodeDeviceRef(virNodeDevicePtr dev)
@ -515,7 +515,7 @@ virNodeDeviceRef(virNodeDevicePtr dev)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v0.6.1
* Since: 0.6.1
*/
int
virNodeDeviceDettach(virNodeDevicePtr dev)
@ -570,7 +570,7 @@ virNodeDeviceDettach(virNodeDevicePtr dev)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v1.0.5
* Since: 1.0.5
*/
int
virNodeDeviceDetachFlags(virNodeDevicePtr dev,
@ -617,7 +617,7 @@ virNodeDeviceDetachFlags(virNodeDevicePtr dev,
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v0.6.1
* Since: 0.6.1
*/
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
@ -662,7 +662,7 @@ virNodeDeviceReAttach(virNodeDevicePtr dev)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v0.6.1
* Since: 0.6.1
*/
int
virNodeDeviceReset(virNodeDevicePtr dev)
@ -704,7 +704,7 @@ virNodeDeviceReset(virNodeDevicePtr dev)
*
* Returns a node device object if successful, NULL in case of failure
*
* Since: v0.6.3
* Since: 0.6.3
*/
virNodeDevicePtr
virNodeDeviceCreateXML(virConnectPtr conn,
@ -745,7 +745,7 @@ virNodeDeviceCreateXML(virConnectPtr conn,
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.6.3
* Since: 0.6.3
*/
int
virNodeDeviceDestroy(virNodeDevicePtr dev)
@ -787,7 +787,7 @@ virNodeDeviceDestroy(virNodeDevicePtr dev)
*
* Returns a node device object if successful, NULL in case of failure
*
* Since: v7.3.0
* Since: 7.3.0
*/
virNodeDevicePtr
virNodeDeviceDefineXML(virConnectPtr conn,
@ -828,7 +828,7 @@ virNodeDeviceDefineXML(virConnectPtr conn,
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v7.3.0
* Since: 7.3.0
*/
int
virNodeDeviceUndefine(virNodeDevicePtr dev,
@ -867,7 +867,7 @@ virNodeDeviceUndefine(virNodeDevicePtr dev,
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v7.3.0
* Since: 7.3.0
*/
int
virNodeDeviceCreate(virNodeDevicePtr dev,
@ -932,7 +932,7 @@ virNodeDeviceCreate(virNodeDevicePtr dev,
*
* Returns a callback identifier on success, -1 on failure.
*
* Since: v2.2.0
* Since: 2.2.0
*/
int
virConnectNodeDeviceEventRegisterAny(virConnectPtr conn,
@ -998,7 +998,7 @@ virConnectNodeDeviceEventRegisterAny(virConnectPtr conn,
*
* Returns 0 on success, -1 on failure.
*
* Since: v2.2.0
* Since: 2.2.0
*/
int
virConnectNodeDeviceEventDeregisterAny(virConnectPtr conn,
@ -1037,7 +1037,7 @@ virConnectNodeDeviceEventDeregisterAny(virConnectPtr conn,
*
* Returns -1 in case of error, 0 in case of success
*
* Since: v7.8.0
* Since: 7.8.0
*/
int
virNodeDeviceSetAutostart(virNodeDevicePtr dev,
@ -1078,7 +1078,7 @@ virNodeDeviceSetAutostart(virNodeDevicePtr dev,
*
* Returns -1 in case of error, 0 in case of success
*
* Since: v7.8.0
* Since: 7.8.0
*/
int
virNodeDeviceGetAutostart(virNodeDevicePtr dev,
@ -1116,7 +1116,7 @@ virNodeDeviceGetAutostart(virNodeDevicePtr dev,
*
* Returns 1 if persistent, 0 if transient, -1 on error
*
* Since: v7.8.0
* Since: 7.8.0
*/
int
virNodeDeviceIsPersistent(virNodeDevicePtr dev)
@ -1151,7 +1151,7 @@ virNodeDeviceIsPersistent(virNodeDevicePtr dev)
*
* Returns 1 if active, 0 if inactive, -1 on error
*
* Since: v7.8.0
* Since: 7.8.0
*/
int virNodeDeviceIsActive(virNodeDevicePtr dev)
{

48
src/libvirt-nwfilter.c
View File

@ -36,7 +36,7 @@ VIR_LOG_INIT("libvirt.nwfilter");
*
* Returns the number of nwfilters found or -1 in case of error
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virConnectNumOfNWFilters(virConnectPtr conn)
@ -80,7 +80,7 @@ virConnectNumOfNWFilters(virConnectPtr conn)
* to make iteration easier. The caller is responsible for calling
* virNWFilterFree() on each array element, then calling free() on @filters.
*
* Since: v0.10.2
* Since: 0.10.2
*/
int
virConnectListAllNWFilters(virConnectPtr conn,
@ -126,7 +126,7 @@ virConnectListAllNWFilters(virConnectPtr conn,
*
* Returns the number of network filters found or -1 in case of error
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virConnectListNWFilters(virConnectPtr conn, char **const names, int maxnames)
@ -168,7 +168,7 @@ virConnectListNWFilters(virConnectPtr conn, char **const names, int maxnames)
* Returns a new nwfilter object or NULL in case of failure. If the
* network filter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
*
* Since: v0.8.0
* Since: 0.8.0
*/
virNWFilterPtr
virNWFilterLookupByName(virConnectPtr conn, const char *name)
@ -209,7 +209,7 @@ virNWFilterLookupByName(virConnectPtr conn, const char *name)
* Returns a new nwfilter object or NULL in case of failure. If the
* nwfdilter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
*
* Since: v0.8.0
* Since: 0.8.0
*/
virNWFilterPtr
virNWFilterLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
@ -250,7 +250,7 @@ virNWFilterLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
* Returns a new nwfilter object or NULL in case of failure. If the
* nwfilter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
*
* Since: v0.8.0
* Since: 0.8.0
*/
virNWFilterPtr
virNWFilterLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
@ -287,7 +287,7 @@ virNWFilterLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virNWFilterFree(virNWFilterPtr nwfilter)
@ -312,7 +312,7 @@ virNWFilterFree(virNWFilterPtr nwfilter)
* Returns a pointer to the name or NULL, the string need not be deallocated
* its lifetime will be the same as the nwfilter object.
*
* Since: v0.8.0
* Since: 0.8.0
*/
const char *
virNWFilterGetName(virNWFilterPtr nwfilter)
@ -336,7 +336,7 @@ virNWFilterGetName(virNWFilterPtr nwfilter)
*
* Returns -1 in case of error, 0 in case of success
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virNWFilterGetUUID(virNWFilterPtr nwfilter, unsigned char *uuid)
@ -368,7 +368,7 @@ virNWFilterGetUUID(virNWFilterPtr nwfilter, unsigned char *uuid)
*
* Returns -1 in case of error, 0 in case of success
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virNWFilterGetUUIDString(virNWFilterPtr nwfilter, char *buf)
@ -402,7 +402,7 @@ virNWFilterGetUUIDString(virNWFilterPtr nwfilter, char *buf)
*
* Returns a new nwfilter object or NULL in case of failure
*
* Since: v0.8.0
* Since: 0.8.0
*/
virNWFilterPtr
virNWFilterDefineXML(virConnectPtr conn, const char *xmlDesc)
@ -445,7 +445,7 @@ virNWFilterDefineXML(virConnectPtr conn, const char *xmlDesc)
*
* Returns a new nwfilter object or NULL in case of failure
*
* Since: v7.7.0
* Since: 7.7.0
*/
virNWFilterPtr
virNWFilterDefineXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int flags)
@ -484,7 +484,7 @@ virNWFilterDefineXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virNWFilterUndefine(virNWFilterPtr nwfilter)
@ -526,7 +526,7 @@ virNWFilterUndefine(virNWFilterPtr nwfilter)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*
* Since: v0.8.0
* Since: 0.8.0
*/
char *
virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, unsigned int flags)
@ -572,7 +572,7 @@ virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virNWFilterRef(virNWFilterPtr nwfilter)
@ -605,7 +605,7 @@ virNWFilterRef(virNWFilterPtr nwfilter)
* to make iteration easier. The caller is responsible for calling
* virNWFilterFree() on each array element, then calling free() on @filters.
*
* Since: v4.5.0
* Since: 4.5.0
*/
int
virConnectListAllNWFilterBindings(virConnectPtr conn,
@ -653,7 +653,7 @@ virConnectListAllNWFilterBindings(virConnectPtr conn,
* network filter cannot be found, then VIR_ERR_NO_NWFILTER_BINDING
* error is raised.
*
* Since: v4.5.0
* Since: 4.5.0
*/
virNWFilterBindingPtr
virNWFilterBindingLookupByPortDev(virConnectPtr conn, const char *portdev)
@ -690,7 +690,7 @@ virNWFilterBindingLookupByPortDev(virConnectPtr conn, const char *portdev)
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v4.5.0
* Since: 4.5.0
*/
int
virNWFilterBindingFree(virNWFilterBindingPtr binding)
@ -715,7 +715,7 @@ virNWFilterBindingFree(virNWFilterBindingPtr binding)
* Returns a pointer to the name or NULL, the string need not be deallocated
* its lifetime will be the same as the binding object.
*
* Since: v4.5.0
* Since: 4.5.0
*/
const char *
virNWFilterBindingGetPortDev(virNWFilterBindingPtr binding)
@ -739,7 +739,7 @@ virNWFilterBindingGetPortDev(virNWFilterBindingPtr binding)
* Returns a pointer to the name or NULL, the string need not be deallocated
* its lifetime will be the same as the binding object.
*
* Since: v4.5.0
* Since: 4.5.0
*/
const char *
virNWFilterBindingGetFilterName(virNWFilterBindingPtr binding)
@ -775,7 +775,7 @@ virNWFilterBindingGetFilterName(virNWFilterBindingPtr binding)
*
* Returns a new binding object or NULL in case of failure
*
* Since: v4.5.0
* Since: 4.5.0
*/
virNWFilterBindingPtr
virNWFilterBindingCreateXML(virConnectPtr conn, const char *xml, unsigned int flags)
@ -818,7 +818,7 @@ virNWFilterBindingCreateXML(virConnectPtr conn, const char *xml, unsigned int fl
*
* Returns 0 in case of success and -1 in case of failure.
*
* Since: v4.5.0
* Since: 4.5.0
*/
int
virNWFilterBindingDelete(virNWFilterBindingPtr binding)
@ -860,7 +860,7 @@ virNWFilterBindingDelete(virNWFilterBindingPtr binding)
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*
* Since: v4.5.0
* Since: 4.5.0
*/
char *
virNWFilterBindingGetXMLDesc(virNWFilterBindingPtr binding, unsigned int flags)
@ -906,7 +906,7 @@ virNWFilterBindingGetXMLDesc(virNWFilterBindingPtr binding, unsigned int flags)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v4.5.0
* Since: 4.5.0
*/
int
virNWFilterBindingRef(virNWFilterBindingPtr binding)

12
src/libvirt-qemu.c
View File

@ -61,7 +61,7 @@ VIR_LOG_INIT("libvirt-qemu");
*
* Returns 0 in case of success, -1 in case of failure
*
* Since: v0.8.3
* Since: 0.8.3
*/
int
virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd,
@ -133,7 +133,7 @@ virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd,
*
* Returns 0 in case of success, -1 in case of failure
*
* Since: v8.2.0
* Since: 8.2.0
*/
int
virDomainQemuMonitorCommandWithFiles(virDomainPtr domain,
@ -220,7 +220,7 @@ virDomainQemuMonitorCommandWithFiles(virDomainPtr domain,
*
* Returns a new domain object on success, NULL otherwise
*
* Since: v0.9.4
* Since: 0.9.4
*/
virDomainPtr
virDomainQemuAttach(virConnectPtr conn,
@ -278,7 +278,7 @@ virDomainQemuAttach(virConnectPtr conn,
*
* Returns strings if success, NULL in failure.
*
* Since: v0.10.0
* Since: 0.10.0
*/
char *
virDomainQemuAgentCommand(virDomainPtr domain,
@ -358,7 +358,7 @@ virDomainQemuAgentCommand(virDomainPtr domain,
*
* Returns a callback identifier on success, -1 on failure
*
* Since: v1.2.3
* Since: 1.2.3
*/
int
virConnectDomainQemuMonitorEventRegister(virConnectPtr conn,
@ -414,7 +414,7 @@ virConnectDomainQemuMonitorEventRegister(virConnectPtr conn,
*
* Returns 0 on success, -1 on failure
*
* Since: v1.2.3
* Since: 1.2.3
*/
int
virConnectDomainQemuMonitorEventDeregister(virConnectPtr conn,

40
src/libvirt-secret.c
View File

@ -36,7 +36,7 @@ VIR_LOG_INIT("libvirt.secret");
*
* Returns the virConnectPtr or NULL in case of failure.
*
* Since: v0.7.1
* Since: 0.7.1
*/
virConnectPtr
virSecretGetConnect(virSecretPtr secret)
@ -59,7 +59,7 @@ virSecretGetConnect(virSecretPtr secret)
*
* Returns the number currently defined secrets.
*
* Since: v0.7.1
* Since: 0.7.1
*/
int
virConnectNumOfSecrets(virConnectPtr conn)
@ -121,7 +121,7 @@ virConnectNumOfSecrets(virConnectPtr conn)
* to make iteration easier. The caller is responsible for calling
* virSecretFree() on each array element, then calling free() on @secrets.
*
* Since: v0.10.2
* Since: 0.10.2
*/
int
virConnectListAllSecrets(virConnectPtr conn,
@ -167,7 +167,7 @@ virConnectListAllSecrets(virConnectPtr conn,
*
* Returns the number of UUIDs provided in the array, or -1 on failure.
*
* Since: v0.7.1
* Since: 0.7.1
*/
int
virConnectListSecrets(virConnectPtr conn, char **uuids, int maxuuids)
@ -211,7 +211,7 @@ virConnectListSecrets(virConnectPtr conn, char **uuids, int maxuuids)
* Returns a new secret object or NULL in case of failure. If the
* secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
*
* Since: v0.7.1
* Since: 0.7.1
*/
virSecretPtr
virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
@ -254,7 +254,7 @@ virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
* Returns a new secret object or NULL in case of failure. If the
* secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
*
* Since: v0.7.1
* Since: 0.7.1
*/
virSecretPtr
virSecretLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
@ -298,7 +298,7 @@ virSecretLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
* Returns a new secret object or NULL in case of failure. If the
* secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
*
* Since: v0.7.1
* Since: 0.7.1
*/
virSecretPtr
virSecretLookupByUsage(virConnectPtr conn,
@ -347,7 +347,7 @@ virSecretLookupByUsage(virConnectPtr conn,
*
* Returns a secret on success, NULL on failure.
*
* Since: v0.7.1
* Since: 0.7.1
*/
virSecretPtr
virSecretDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
@ -387,7 +387,7 @@ virSecretDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
* Returns 0 on success with the uuid buffer being filled, or
* -1 upon failure.
*
* Since: v0.7.1
* Since: 0.7.1
*/
int
virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
@ -419,7 +419,7 @@ virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
*
* Returns -1 in case of error, 0 in case of success
*
* Since: v0.7.1
* Since: 0.7.1
*/
int
virSecretGetUUIDString(virSecretPtr secret, char *buf)
@ -453,7 +453,7 @@ virSecretGetUUIDString(virSecretPtr secret, char *buf)
* Returns a positive integer identifying the type of object,
* or -1 upon error.
*
* Since: v0.7.1
* Since: 0.7.1
*/
int
virSecretGetUsageType(virSecretPtr secret)
@ -484,7 +484,7 @@ virSecretGetUsageType(virSecretPtr secret)
* Returns a string identifying the object using the secret,
* or NULL upon error
*
* Since: v0.7.1
* Since: 0.7.1
*/
const char *
virSecretGetUsageID(virSecretPtr secret)
@ -509,7 +509,7 @@ virSecretGetUsageID(virSecretPtr secret)
* Returns the XML document on success, NULL on failure. The caller must
* free() the XML.
*
* Since: v0.7.1
* Since: 0.7.1
*/
char *
virSecretGetXMLDesc(virSecretPtr secret, unsigned int flags)
@ -551,7 +551,7 @@ virSecretGetXMLDesc(virSecretPtr secret, unsigned int flags)
*
* Returns 0 on success, -1 on failure.
*
* Since: v0.7.1
* Since: 0.7.1
*/
int
virSecretSetValue(virSecretPtr secret, const unsigned char *value,
@ -598,7 +598,7 @@ virSecretSetValue(virSecretPtr secret, const unsigned char *value,
* Returns the secret value on success, NULL on failure. The caller must
* free() the secret value.
*
* Since: v0.7.1
* Since: 0.7.1
*/
unsigned char *
virSecretGetValue(virSecretPtr secret, size_t *value_size, unsigned int flags)
@ -641,7 +641,7 @@ virSecretGetValue(virSecretPtr secret, size_t *value_size, unsigned int flags)
*
* Returns 0 on success, -1 on failure.
*
* Since: v0.7.1
* Since: 0.7.1
*/
int
virSecretUndefine(virSecretPtr secret)
@ -690,7 +690,7 @@ virSecretUndefine(virSecretPtr secret)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v0.7.1
* Since: 0.7.1
*/
int
virSecretRef(virSecretPtr secret)
@ -714,7 +714,7 @@ virSecretRef(virSecretPtr secret)
*
* Returns 0 on success, or -1 on error
*
* Since: v0.7.1
* Since: 0.7.1
*/
int
virSecretFree(virSecretPtr secret)
@ -765,7 +765,7 @@ virSecretFree(virSecretPtr secret)
*
* Returns a callback identifier on success, -1 on failure.
*
* Since: v3.0.0
* Since: 3.0.0
*/
int
virConnectSecretEventRegisterAny(virConnectPtr conn,
@ -833,7 +833,7 @@ virConnectSecretEventRegisterAny(virConnectPtr conn,
*
* Returns 0 on success, -1 on failure.
*
* Since: v3.0.0
* Since: 3.0.0
*/
int
virConnectSecretEventDeregisterAny(virConnectPtr conn,

114
src/libvirt-storage.c
View File

@ -38,7 +38,7 @@ VIR_LOG_INIT("libvirt.storage");
*
* Returns the virConnectPtr or NULL in case of failure.
*
* Since: v0.4.1
* Since: 0.4.1
*/
virConnectPtr
virStoragePoolGetConnect(virStoragePoolPtr pool)
@ -107,7 +107,7 @@ virStoragePoolGetConnect(virStoragePoolPtr pool)
* for calling virStoragePoolFree() on each array element, then calling
* free() on @pools.
*
* Since: v0.10.2
* Since: 0.10.2
*/
int
virConnectListAllStoragePools(virConnectPtr conn,
@ -148,7 +148,7 @@ virConnectListAllStoragePools(virConnectPtr conn,
*
* Returns the number of pools found, or -1 on error
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virConnectNumOfStoragePools(virConnectPtr conn)
@ -194,7 +194,7 @@ virConnectNumOfStoragePools(virConnectPtr conn)
* that all currently active pools were listed if the return is less than
* @maxnames. The client must call free() on each returned name.
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virConnectListStoragePools(virConnectPtr conn,
@ -233,7 +233,7 @@ virConnectListStoragePools(virConnectPtr conn,
*
* Returns the number of pools found, or -1 on error
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virConnectNumOfDefinedStoragePools(virConnectPtr conn)
@ -279,7 +279,7 @@ virConnectNumOfDefinedStoragePools(virConnectPtr conn)
* guaranteed that all currently defined pools were listed if the return
* is less than @maxnames. The client must call free() on each returned name.
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virConnectListDefinedStoragePools(virConnectPtr conn,
@ -331,7 +331,7 @@ virConnectListDefinedStoragePools(virConnectPtr conn,
* containing a source document appropriate to the given pool
* type for each discovered source.
*
* Since: v0.4.5
* Since: 0.4.5
*/
char *
virConnectFindStoragePoolSources(virConnectPtr conn,
@ -376,7 +376,7 @@ virConnectFindStoragePoolSources(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if no matching pool is found
*
* Since: v0.4.1
* Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolLookupByName(virConnectPtr conn,
@ -417,7 +417,7 @@ virStoragePoolLookupByName(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if no matching pool is found
*
* Since: v0.4.1
* Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolLookupByUUID(virConnectPtr conn,
@ -458,7 +458,7 @@ virStoragePoolLookupByUUID(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if no matching pool is found
*
* Since: v0.4.1
* Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolLookupByUUIDString(virConnectPtr conn,
@ -498,7 +498,7 @@ virStoragePoolLookupByUUIDString(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if no matching pool is found
*
* Since: v0.4.1
* Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolLookupByVolume(virStorageVolPtr vol)
@ -539,7 +539,7 @@ virStoragePoolLookupByVolume(virStorageVolPtr vol)
*
* Returns a virStoragePoolPtr object, or NULL if no matching pool is found
*
* Since: v4.1.0
* Since: 4.1.0
*/
virStoragePoolPtr
virStoragePoolLookupByTargetPath(virConnectPtr conn,
@ -582,7 +582,7 @@ virStoragePoolLookupByTargetPath(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if creation failed
*
* Since: v0.4.1
* Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolCreateXML(virConnectPtr conn,
@ -627,7 +627,7 @@ virStoragePoolCreateXML(virConnectPtr conn,
*
* Returns a virStoragePoolPtr object, or NULL if creation failed
*
* Since: v0.4.1
* Since: 0.4.1
*/
virStoragePoolPtr
virStoragePoolDefineXML(virConnectPtr conn,
@ -670,7 +670,7 @@ virStoragePoolDefineXML(virConnectPtr conn,
*
* Returns 0 on success, or -1 upon failure
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolBuild(virStoragePoolPtr pool,
@ -710,7 +710,7 @@ virStoragePoolBuild(virStoragePoolPtr pool,
*
* Returns 0 on success, -1 on failure
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolUndefine(virStoragePoolPtr pool)
@ -750,7 +750,7 @@ virStoragePoolUndefine(virStoragePoolPtr pool)
*
* Returns 0 on success, or -1 if it could not be started
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolCreate(virStoragePoolPtr pool,
@ -794,7 +794,7 @@ virStoragePoolCreate(virStoragePoolPtr pool,
*
* Returns 0 on success, or -1 if it could not be destroyed
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolDestroy(virStoragePoolPtr pool)
@ -836,7 +836,7 @@ virStoragePoolDestroy(virStoragePoolPtr pool)
*
* Returns 0 on success, or -1 if it could not be obliterate
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolDelete(virStoragePoolPtr pool,
@ -877,7 +877,7 @@ virStoragePoolDelete(virStoragePoolPtr pool,
*
* Returns 0 on success, or -1 if it could not be free'd.
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolFree(virStoragePoolPtr pool)
@ -911,7 +911,7 @@ virStoragePoolFree(virStoragePoolPtr pool)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v0.6.0
* Since: 0.6.0
*/
int
virStoragePoolRef(virStoragePoolPtr pool)
@ -938,7 +938,7 @@ virStoragePoolRef(virStoragePoolPtr pool)
*
* Returns 0 if the volume list was refreshed, -1 on failure
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolRefresh(virStoragePoolPtr pool,
@ -978,7 +978,7 @@ virStoragePoolRefresh(virStoragePoolPtr pool,
*
* Returns the name of the pool, or NULL on error
*
* Since: v0.4.1
* Since: 0.4.1
*/
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
@ -1002,7 +1002,7 @@ virStoragePoolGetName(virStoragePoolPtr pool)
*
* Returns 0 on success, or -1 on error;
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
@ -1034,7 +1034,7 @@ virStoragePoolGetUUID(virStoragePoolPtr pool,
*
* Returns 0 on success, or -1 on error;
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
@ -1066,7 +1066,7 @@ virStoragePoolGetUUIDString(virStoragePoolPtr pool,
*
* Returns 0 on success, or -1 on failure.
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
@ -1112,7 +1112,7 @@ virStoragePoolGetInfo(virStoragePoolPtr pool,
*
* Returns a XML document (caller frees), or NULL on error
*
* Since: v0.4.1
* Since: 0.4.1
*/
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
@ -1152,7 +1152,7 @@ virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
*
* Returns 0 on success, -1 on failure
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
@ -1194,7 +1194,7 @@ virStoragePoolGetAutostart(virStoragePoolPtr pool,
*
* Returns 0 on success, -1 on failure
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
@ -1244,7 +1244,7 @@ virStoragePoolSetAutostart(virStoragePoolPtr pool,
* for calling virStorageVolFree() on each array element, then calling
* free() on @vols.
*
* Since: v0.10.2
* Since: 0.10.2
*/
int
virStoragePoolListAllVolumes(virStoragePoolPtr pool,
@ -1282,7 +1282,7 @@ virStoragePoolListAllVolumes(virStoragePoolPtr pool,
*
* Returns the number of storage pools, or -1 on failure
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolNumOfVolumes(virStoragePoolPtr pool)
@ -1323,7 +1323,7 @@ virStoragePoolNumOfVolumes(virStoragePoolPtr pool)
*
* Returns the number of names fetched, or -1 on error
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStoragePoolListVolumes(virStoragePoolPtr pool,
@ -1364,7 +1364,7 @@ virStoragePoolListVolumes(virStoragePoolPtr pool,
*
* Returns the virConnectPtr or NULL in case of failure.
*
* Since: v0.4.1
* Since: 0.4.1
*/
virConnectPtr
virStorageVolGetConnect(virStorageVolPtr vol)
@ -1392,7 +1392,7 @@ virStorageVolGetConnect(virStorageVolPtr vol)
*
* Returns a storage volume, or NULL if not found / error
*
* Since: v0.4.1
* Since: 0.4.1
*/
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
@ -1434,7 +1434,7 @@ virStorageVolLookupByName(virStoragePoolPtr pool,
*
* Returns a storage volume, or NULL if not found / error
*
* Since: v0.4.1
* Since: 0.4.1
*/
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
@ -1476,7 +1476,7 @@ virStorageVolLookupByKey(virConnectPtr conn,
*
* Returns a storage volume, or NULL if not found / error
*
* Since: v0.4.1
* Since: 0.4.1
*/
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
@ -1514,7 +1514,7 @@ virStorageVolLookupByPath(virConnectPtr conn,
*
* Returns the volume name, or NULL on error
*
* Since: v0.4.1
* Since: 0.4.1
*/
const char*
virStorageVolGetName(virStorageVolPtr vol)
@ -1539,7 +1539,7 @@ virStorageVolGetName(virStorageVolPtr vol)
*
* Returns the volume key, or NULL on error
*
* Since: v0.4.1
* Since: 0.4.1
*/
const char*
virStorageVolGetKey(virStorageVolPtr vol)
@ -1574,7 +1574,7 @@ virStorageVolGetKey(virStorageVolPtr vol)
*
* Returns the storage volume, or NULL on error
*
* Since: v0.4.1
* Since: 0.4.1
*/
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
@ -1627,7 +1627,7 @@ virStorageVolCreateXML(virStoragePoolPtr pool,
*
* Returns the storage volume, or NULL on error
*
* Since: v0.6.4
* Since: 0.6.4
*/
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
@ -1693,7 +1693,7 @@ virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
*
* Returns 0, or -1 upon error.
*
* Since: v0.9.0
* Since: 0.9.0
*/
int
virStorageVolDownload(virStorageVolPtr vol,
@ -1778,7 +1778,7 @@ virStorageVolDownload(virStorageVolPtr vol,
*
* Returns 0, or -1 upon error.
*
* Since: v0.9.0
* Since: 0.9.0
*/
int
virStorageVolUpload(virStorageVolPtr vol,
@ -1833,7 +1833,7 @@ virStorageVolUpload(virStorageVolPtr vol,
*
* Returns 0 on success, or -1 on error
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStorageVolDelete(virStorageVolPtr vol,
@ -1884,7 +1884,7 @@ virStorageVolDelete(virStorageVolPtr vol,
*
* Returns 0 on success, or -1 on error
*
* Since: v0.8.0
* Since: 0.8.0
*/
int
virStorageVolWipe(virStorageVolPtr vol,
@ -1932,7 +1932,7 @@ virStorageVolWipe(virStorageVolPtr vol,
*
* Returns 0 on success, or -1 on error.
*
* Since: v0.9.10
* Since: 0.9.10
*/
int
virStorageVolWipePattern(virStorageVolPtr vol,
@ -1974,7 +1974,7 @@ virStorageVolWipePattern(virStorageVolPtr vol,
*
* Returns 0 on success, or -1 on error
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStorageVolFree(virStorageVolPtr vol)
@ -2007,7 +2007,7 @@ virStorageVolFree(virStorageVolPtr vol)
*
* Returns 0 in case of success, -1 in case of failure.
*
* Since: v0.6.0
* Since: 0.6.0
*/
int
virStorageVolRef(virStorageVolPtr vol)
@ -2033,7 +2033,7 @@ virStorageVolRef(virStorageVolPtr vol)
*
* Returns 0 on success, or -1 on failure
*
* Since: v0.4.1
* Since: 0.4.1
*/
int
virStorageVolGetInfo(virStorageVolPtr vol,
@ -2085,7 +2085,7 @@ virStorageVolGetInfo(virStorageVolPtr vol,
*
* Returns 0 on success, or -1 on failure
*
* Since: v3.0.0
* Since: 3.0.0
*/
int
virStorageVolGetInfoFlags(virStorageVolPtr vol,
@ -2131,7 +2131,7 @@ virStorageVolGetInfoFlags(virStorageVolPtr vol,
*
* Returns the XML document, or NULL on error
*
* Since: v0.4.1
* Since: 0.4.1
*/
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
@ -2174,7 +2174,7 @@ virStorageVolGetXMLDesc(virStorageVolPtr vol,
* Returns the storage volume path, or NULL on error. The
* caller must free() the returned path after use.
*
* Since: v0.4.1
* Since: 0.4.1
*/
char *
virStorageVolGetPath(virStorageVolPtr vol)
@ -2237,7 +2237,7 @@ virStorageVolGetPath(virStorageVolPtr vol)
*
* Returns 0 on success, or -1 on error.
*
* Since: v0.9.10
* Since: 0.9.10
*/
int
virStorageVolResize(virStorageVolPtr vol,
@ -2288,7 +2288,7 @@ virStorageVolResize(virStorageVolPtr vol,
*
* Returns 1 if running, 0 if inactive, -1 on error
*
* Since: v0.7.3
* Since: 0.7.3
*/
int
virStoragePoolIsActive(virStoragePoolPtr pool)
@ -2323,7 +2323,7 @@ virStoragePoolIsActive(virStoragePoolPtr pool)
*
* Returns 1 if persistent, 0 if transient, -1 on error
*
* Since: v0.7.3
* Since: 0.7.3
*/
int
virStoragePoolIsPersistent(virStoragePoolPtr pool)
@ -2383,7 +2383,7 @@ virStoragePoolIsPersistent(virStoragePoolPtr pool)
*
* Returns a callback identifier on success, -1 on failure.
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virConnectStoragePoolEventRegisterAny(virConnectPtr conn,
@ -2448,7 +2448,7 @@ virConnectStoragePoolEventRegisterAny(virConnectPtr conn,
*
* Returns 0 on success, -1 on failure
*
* Since: v2.0.0
* Since: 2.0.0
*/
int
virConnectStoragePoolEventDeregisterAny(virConnectPtr conn,
@ -2489,7 +2489,7 @@ virConnectStoragePoolEventDeregisterAny(virConnectPtr conn,
*
* Returns NULL in case of error or an XML string defining the capabilities.
*
* Since: v5.2.0
* Since: 5.2.0
*/
char *
virConnectGetStoragePoolCapabilities(virConnectPtr conn,

34
src/libvirt-stream.c
View File

@ -53,7 +53,7 @@ VIR_LOG_INIT("libvirt.stream");
*
* Returns the new stream, or NULL upon error
*
* Since: v0.7.2
* Since: 0.7.2
*/
virStreamPtr
virStreamNew(virConnectPtr conn,
@ -88,7 +88,7 @@ virStreamNew(virConnectPtr conn,
*
* Returns 0 in case of success, -1 in case of failure
*
* Since: v0.7.2
* Since: 0.7.2
*/
int
virStreamRef(virStreamPtr stream)
@ -168,7 +168,7 @@ virStreamRef(virStreamPtr stream)
* Returns -2 if the outgoing transmit buffers are full &
* the stream is marked as non-blocking.
*
* Since: v0.7.2
* Since: 0.7.2
*/
int
virStreamSend(virStreamPtr stream,
@ -265,7 +265,7 @@ virStreamSend(virStreamPtr stream,
* Returns -2 if there is no data pending to be read & the
* stream is marked as non-blocking.
*
* Since: v0.7.2
* Since: 0.7.2
*/
int
virStreamRecv(virStreamPtr stream,
@ -354,7 +354,7 @@ virStreamRecv(virStreamPtr stream,
* Returns -3 if there is a hole in stream and caller requested
* to stop at a hole.
*
* Since: v3.4.0
* Since: 3.4.0
*/
int
virStreamRecvFlags(virStreamPtr stream,
@ -423,7 +423,7 @@ virStreamRecvFlags(virStreamPtr stream,
* Returns 0 on success,
* -1 error
*
* Since: v3.4.0
* Since: 3.4.0
*/
int
virStreamSendHole(virStreamPtr stream,
@ -468,7 +468,7 @@ virStreamSendHole(virStreamPtr stream,
* Returns 0 on success,
* -1 on error or when there's currently no hole in the stream
*
* Since: v3.4.0
* Since: 3.4.0
*/
int
virStreamRecvHole(virStreamPtr stream,
@ -592,7 +592,7 @@ virStreamInData(virStreamPtr stream,
* having been called, so the caller need only call
* virStreamFree().
*
* Since: v0.7.2
* Since: 0.7.2
*/
int
virStreamSendAll(virStreamPtr stream,
@ -723,7 +723,7 @@ virStreamSendAll(virStreamPtr stream,
* having been called, so the caller need only call
* virStreamFree().
*
* Since: v3.4.0
* Since: 3.4.0
*/
int virStreamSparseSendAll(virStreamPtr stream,
virStreamSourceFunc handler,
@ -864,7 +864,7 @@ int virStreamSparseSendAll(virStreamPtr stream,
* having been called, so the caller need only call
* virStreamFree()
*
* Since: v0.7.2
* Since: 0.7.2
*/
int
virStreamRecvAll(virStreamPtr stream,
@ -979,7 +979,7 @@ virStreamRecvAll(virStreamPtr stream,
* Returns -1 upon any error, with virStreamAbort() already
* having been called, so the caller need only call virStreamFree().
*
* Since: v3.4.0
* Since: 3.4.0
*/
int
virStreamSparseRecvAll(virStreamPtr stream,
@ -1074,7 +1074,7 @@ virStreamSparseRecvAll(virStreamPtr stream,
*
* Returns 0 on success, -1 upon error
*
* Since: v0.7.2
* Since: 0.7.2
*/
int
virStreamEventAddCallback(virStreamPtr stream,
@ -1119,7 +1119,7 @@ virStreamEventAddCallback(virStreamPtr stream,
*
* Returns 0 on success, -1 if no callback is registered
*
* Since: v0.7.2
* Since: 0.7.2
*/
int
virStreamEventUpdateCallback(virStreamPtr stream,
@ -1156,7 +1156,7 @@ virStreamEventUpdateCallback(virStreamPtr stream,
*
* Returns 0 on success, -1 on error
*
* Since: v0.7.2
* Since: 0.7.2
*/
int
virStreamEventRemoveCallback(virStreamPtr stream)
@ -1202,7 +1202,7 @@ virStreamEventRemoveCallback(virStreamPtr stream)
*
* Returns 0 on success, -1 upon error
*
* Since: v0.7.2
* Since: 0.7.2
*/
int
virStreamFinish(virStreamPtr stream)
@ -1246,7 +1246,7 @@ virStreamFinish(virStreamPtr stream)
*
* Returns 0 on success, -1 upon error
*
* Since: v0.7.2
* Since: 0.7.2
*/
int
virStreamAbort(virStreamPtr stream)
@ -1292,7 +1292,7 @@ virStreamAbort(virStreamPtr stream)
*
* Returns 0 upon success, or -1 on error
*
* Since: v0.7.2
* Since: 0.7.2
*/
int
virStreamFree(virStreamPtr stream)

12
src/libvirt.c
View File

@ -297,7 +297,7 @@ virGlobalInit(void)
*
* Returns 0 in case of success, -1 in case of error
*
* Since: v0.1.0
* Since: 0.1.0
*/
int
virInitialize(void)
@ -800,7 +800,7 @@ virStateStop(void)
* Returns -1 in case of failure, 0 otherwise, and values for @libVer and
* @typeVer have the format major * 1,000,000 + minor * 1,000 + release.
*
* Since: v0.0.3
* Since: 0.0.3
*/
int
virGetVersion(unsigned long *libVer, const char *type G_GNUC_UNUSED,
@ -1190,7 +1190,7 @@ virConnectOpenInternal(const char *name,
*
* Returns a pointer to the hypervisor connection or NULL in case of error
*
* Since: v0.0.3
* Since: 0.0.3
*/
virConnectPtr
virConnectOpen(const char *name)
@ -1225,7 +1225,7 @@ virConnectOpen(const char *name)
*
* Returns a pointer to the hypervisor connection or NULL in case of error
*
* Since: v0.0.3
* Since: 0.0.3
*/
virConnectPtr
virConnectOpenReadOnly(const char *name)
@ -1261,7 +1261,7 @@ virConnectOpenReadOnly(const char *name)
*
* Returns a pointer to the hypervisor connection or NULL in case of error
*
* Since: v0.4.0
* Since: 0.4.0
*/
virConnectPtr
virConnectOpenAuth(const char *name,
@ -1311,7 +1311,7 @@ virConnectOpenAuth(const char *name,
* connection, but the application should not try to further use a
* connection after the virConnectClose that matches the initial open.
*
* Since: v0.0.3
* Since: 0.0.3
*/
int
virConnectClose(virConnectPtr conn)

30
src/util/virerror.c
View File

@ -255,7 +255,7 @@ virLastErrorObject(void)
*
* Returns a pointer to the last error or NULL if none occurred.
*
* Since: v0.1.0
* Since: 0.1.0
*/
virErrorPtr
virGetLastError(void)
@ -274,7 +274,7 @@ virGetLastError(void)
*
* Returns the most recent error code, or VIR_ERR_OK if none is set.
*
* Since: v4.5.0
* Since: 4.5.0
*/
int
virGetLastErrorCode(void)
@ -294,7 +294,7 @@ virGetLastErrorCode(void)
* Returns a numerical value of the most recent error's origin, or VIR_FROM_NONE
* if none is set.
*
* Since: v4.5.0
* Since: 4.5.0
*/
int
virGetLastErrorDomain(void)
@ -314,7 +314,7 @@ virGetLastErrorDomain(void)
* Returns the most recent error message string in this
* thread, or a generic message if none is set
*
* Since: v1.0.6
* Since: 1.0.6
*/
const char *
virGetLastErrorMessage(void)
@ -370,7 +370,7 @@ virSetError(virErrorPtr newerr)
*
* Returns error code or -1 in case of parameter error.
*
* Since: v0.1.0
* Since: 0.1.0
*/
int
virCopyLastError(virErrorPtr to)
@ -403,7 +403,7 @@ virCopyLastError(virErrorPtr to)
* It is the caller's responsibility to free the error with
* virFreeError().
*
* Since: v0.6.1
* Since: 0.6.1
*/
virErrorPtr
virSaveLastError(void)
@ -468,7 +468,7 @@ virErrorRestore(virErrorPtr *savederr)
*
* Reset the error being pointed to
*
* Since: v0.1.0
* Since: 0.1.0
*/
void
virResetError(virErrorPtr err)
@ -488,7 +488,7 @@ virResetError(virErrorPtr err)
*
* Resets and frees the given error.
*
* Since: v0.6.1
* Since: 0.6.1
*/
void
virFreeError(virErrorPtr err)
@ -506,7 +506,7 @@ virFreeError(virErrorPtr err)
* threads can safely access this concurrently, only resetting
* their own error object.
*
* Since: v0.1.0
* Since: 0.1.0
*/
void
virResetLastError(void)
@ -538,7 +538,7 @@ virResetLastError(void)
*
* Returns a pointer to the last error or NULL if none occurred.
*
* Since: v0.1.0
* Since: 0.1.0
*/
virErrorPtr
virConnGetLastError(virConnectPtr conn)
@ -574,7 +574,7 @@ virConnGetLastError(virConnectPtr conn)
* Returns 0 if no error was found and the error code otherwise and -1 in case
* of parameter error.
*
* Since: v0.1.0
* Since: 0.1.0
*/
int
virConnCopyLastError(virConnectPtr conn, virErrorPtr to)
@ -602,7 +602,7 @@ virConnCopyLastError(virConnectPtr conn, virErrorPtr to)
*
* Reset the last error caught on that connection
*
* Since: v0.1.0
* Since: 0.1.0
*/
void
virConnResetLastError(virConnectPtr conn)
@ -623,7 +623,7 @@ virConnResetLastError(virConnectPtr conn)
* it will reset to default printing on stderr. The error raised there
* are those for which no handler at the connection level could caught.
*
* Since: v0.1.0
* Since: 0.1.0
*/
void
virSetErrorFunc(void *userData, virErrorFunc handler)
@ -642,7 +642,7 @@ virSetErrorFunc(void *userData, virErrorFunc handler)
* it will reset to default which is to pass error back to the global
* library handler.
*
* Since: v0.1.0
* Since: 0.1.0
*/
void
virConnSetErrorFunc(virConnectPtr conn, void *userData,
@ -662,7 +662,7 @@ virConnSetErrorFunc(virConnectPtr conn, void *userData,
*
* Default routine reporting an error to stderr.
*
* Since: v0.1.0
* Since: 0.1.0
*/
void
virDefaultErrorFunc(virErrorPtr err)

18
src/util/virevent.c
View File

@ -70,7 +70,7 @@ static virEventRemoveTimeoutFunc removeTimeoutImpl;
* Returns -1 if the file handle cannot be registered, otherwise a handle
* watch number to be used for updating and unregistering for events.
*
* Since: v0.9.3
* Since: 0.9.3
*/
int
virEventAddHandle(int fd,
@ -97,7 +97,7 @@ virEventAddHandle(int fd,
*
* Will not fail if fd exists.
*
* Since: v0.9.3
* Since: 0.9.3
*/
void
virEventUpdateHandle(int watch, int events)
@ -117,7 +117,7 @@ virEventUpdateHandle(int watch, int events)
*
* Returns -1 if the file handle was not registered, 0 upon success.
*
* Since: v0.9.3
* Since: 0.9.3
*/
int
virEventRemoveHandle(int watch)
@ -146,7 +146,7 @@ virEventRemoveHandle(int watch)
* Returns -1 if the timer cannot be registered, a positive
* integer timer id upon success.
*
* Since: v0.9.3
* Since: 0.9.3
*/
int
virEventAddTimeout(int timeout,
@ -175,7 +175,7 @@ virEventAddTimeout(int timeout,
*
* Will not fail if timer exists.
*
* Since: v0.9.3
* Since: 0.9.3
*/
void
virEventUpdateTimeout(int timer, int timeout)
@ -195,7 +195,7 @@ virEventUpdateTimeout(int timer, int timeout)
*
* Returns -1 if the timer was not registered, 0 upon success.
*
* Since: v0.9.3
* Since: 0.9.3
*/
int
virEventRemoveTimeout(int timer)
@ -245,7 +245,7 @@ virEventRemoveTimeout(int timer)
* to stop running the event loop immediately after closing
* the connection.
*
* Since: v0.5.0
* Since: 0.5.0
*/
void virEventRegisterImpl(virEventAddHandleFunc addHandle,
virEventUpdateHandleFunc updateHandle,
@ -315,7 +315,7 @@ int virEventRequireImpl(void)
*
* Returns 0 on success, -1 on failure.
*
* Since: v0.9.0
* Since: 0.9.0
*/
int virEventRegisterDefaultImpl(void)
{
@ -352,7 +352,7 @@ int virEventRegisterDefaultImpl(void)
*
* Returns 0 on success, -1 on failure.
*
* Since: v0.9.0
* Since: 0.9.0
*/
int virEventRunDefaultImpl(void)
{

38
src/util/virtypedparam-public.c
View File

@ -128,7 +128,7 @@ virTypedParameterAssignFromStr(virTypedParameterPtr param,
* Returns pointer to the parameter or NULL if it does not exist in @params.
* This function does not raise an error, even when returning NULL.
*
* Since: v1.0.2
* Since: 1.0.2
*/
virTypedParameterPtr
virTypedParamsGet(virTypedParameterPtr params,
@ -179,7 +179,7 @@ virTypedParamsGet(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsGetInt(virTypedParameterPtr params,
@ -217,7 +217,7 @@ virTypedParamsGetInt(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsGetUInt(virTypedParameterPtr params,
@ -255,7 +255,7 @@ virTypedParamsGetUInt(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsGetLLong(virTypedParameterPtr params,
@ -293,7 +293,7 @@ virTypedParamsGetLLong(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsGetULLong(virTypedParameterPtr params,
@ -331,7 +331,7 @@ virTypedParamsGetULLong(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsGetDouble(virTypedParameterPtr params,
@ -369,7 +369,7 @@ virTypedParamsGetDouble(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsGetBoolean(virTypedParameterPtr params,
@ -409,7 +409,7 @@ virTypedParamsGetBoolean(virTypedParameterPtr params,
* Returns 1 on success, 0 when the parameter does not exist in @params, or
* -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsGetString(virTypedParameterPtr params,
@ -450,7 +450,7 @@ virTypedParamsGetString(virTypedParameterPtr params,
*
* Returns 0 on success, -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsAddInt(virTypedParameterPtr *params,
@ -498,7 +498,7 @@ virTypedParamsAddInt(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsAddUInt(virTypedParameterPtr *params,
@ -546,7 +546,7 @@ virTypedParamsAddUInt(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsAddLLong(virTypedParameterPtr *params,
@ -594,7 +594,7 @@ virTypedParamsAddLLong(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsAddULLong(virTypedParameterPtr *params,
@ -642,7 +642,7 @@ virTypedParamsAddULLong(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsAddDouble(virTypedParameterPtr *params,
@ -690,7 +690,7 @@ virTypedParamsAddDouble(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsAddBoolean(virTypedParameterPtr *params,
@ -740,7 +740,7 @@ virTypedParamsAddBoolean(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsAddString(virTypedParameterPtr *params,
@ -788,7 +788,7 @@ virTypedParamsAddString(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
* Since: v1.2.17
* Since: 1.2.17
*/
int
virTypedParamsAddStringList(virTypedParameterPtr *params,
@ -835,7 +835,7 @@ virTypedParamsAddStringList(virTypedParameterPtr *params,
*
* Returns 0 on success, -1 on error.
*
* Since: v1.0.2
* Since: 1.0.2
*/
int
virTypedParamsAddFromString(virTypedParameterPtr *params,
@ -875,7 +875,7 @@ virTypedParamsAddFromString(virTypedParameterPtr *params,
*
* Returns nothing.
*
* Since: v1.0.2
* Since: 1.0.2
*/
void
virTypedParamsClear(virTypedParameterPtr params,
@ -903,7 +903,7 @@ virTypedParamsClear(virTypedParameterPtr params,
*
* Returns nothing.
*
* Since: v1.0.2
* Since: 1.0.2
*/
void
virTypedParamsFree(virTypedParameterPtr params,