From 1dd49e921f24177de8cd8dfae32f2f77701343f8 Mon Sep 17 00:00:00 2001 From: Justin Clift Date: Thu, 28 Oct 2010 19:02:09 +1100 Subject: [PATCH] docs: updated the C# bindings page with arnauds latest changes --- docs/csharp.html.in | 129 ++++++++++++++++++++++++++++---------------- 1 file changed, 83 insertions(+), 46 deletions(-) diff --git a/docs/csharp.html.in b/docs/csharp.html.in index a32fbd2d3e..dc67d7cbf5 100644 --- a/docs/csharp.html.in +++ b/docs/csharp.html.in @@ -24,6 +24,8 @@

These bindings depend upon the libvirt libraries being installed. +

+

In the .NET case, this is libvirt-0.dll, produced from compiling libvirt for windows.

@@ -67,18 +69,51 @@ git clone git://libvirt.org/libvirt-csharp.git

Usage

- The class library exposes the LibvirtBindings namespace. - This namespace exposes all of the needed types (enum, struct), - and 2 main classes, libVirt and libvirtError. + The libvirt C# bindings class library exposes the Libvirt + namespace. This namespace exposes all of the needed types (enum, + struct), plus many classes exposing the libvirt API methods.

- The libVirt class exposes all of the interfaces of the - libvirt library for handling virtualized domains. + These classes are grouped into functional areas, with each class + exposing libvirt methods related to that area.

- The libvirtError class exposes all of the interfaces of - the libvirt library for handling errors raised while using the library. + For example, the libvirt methods related to connections, such as + virConnectOpenAuth and virConnectNumOfDomains, are in + the Connect class. +
+ They are accessed as Connect.OpenAuth, and + Connect.NumOfDomains respectively.

+

+ In the same manner, the other class name mappings are: +

+ + + + + + + + + + + +
Name of libvirt functionC# class name
virDomain...Domain
virEvent...Event
virInterface...Interface
virNetwork...Network
virNode...Node
virSecret...Secret
virStoragePool...StoragePool
virStorageVolume...StorageVolume
virStream...Stream
+

+ There are some additions as well: +

+

 

@@ -92,14 +127,16 @@ git clone git://libvirt.org/libvirt-csharp.git

 

-

Notes on testing

+

Test Configuration

- Windows testing is performed on Windows 7, with .NET 4, Visual Studio 2010, and MonoDevelop 2.4. -

-

- Linux testing is performed on Fedora 13 i686, with MonoDevelop 2.2. + Testing is performed using the following configurations:

+

 

@@ -109,7 +146,7 @@ git clone git://libvirt.org/libvirt-csharp.git Coverage of the libvirt types is:

- + @@ -122,7 +159,7 @@ git clone git://libvirt.org/libvirt-csharp.git - + @@ -130,12 +167,12 @@ git clone git://libvirt.org/libvirt-csharp.git - - - - - - + + + + + + @@ -149,7 +186,7 @@ git clone git://libvirt.org/libvirt-csharp.git - + @@ -162,10 +199,10 @@ git clone git://libvirt.org/libvirt-csharp.git - + @@ -186,10 +223,10 @@ git clone git://libvirt.org/libvirt-csharp.git Coverage of the libvirt functions is:

TypeNameBinding?Tested?Sample Code?Works?Tested .Net/Windows Works?Tested Mono/Windows Works?Tested Mono/Linux Works?
TypeNameBinding?Tested?Sample Code?Works?Tested .Net/Windows Works?Tested Mono (32-bit)/Windows Works?Tested Mono (64-bit)/Linux Works?
enumvirCPUCompareResultNo      
structvirConnectYes, an IntPtr as the struct is not publicYes Yes   
structvirConnectAuthYesYesvirConnectOpenAuthYesYesYesYes
enumvirDomainCoreDumpFlagsNo      
enumvirDomainCreateFlagsNo      
enumvirDomainDeviceModifyFlagsNo      
enumvirDomainEventDefinedDetailTypeYes YesYes   
enumvirDomainEventDefinedDetailTypeYesYesvirEventRegisterImplYesYesYesYes
structvirDomainEventGraphicsAddressNo      
enumvirDomainEventGraphicsAddressTypeNo      
enumvirDomainEventGraphicsPhaseNo      
structvirDomainEventGraphicsSubjectIdentityNo      
enumvirDomainEventIDNo      
enumvirDomainEventIOErrorActionNo      
enumvirDomainEventResumedDetailTypeYesYes Yes   
enumvirDomainEventStartedDetailTypeYesYes Yes   
enumvirDomainEventStoppedDetailTypeYesYes Yes   
enumvirDomainEventSuspendedDetailTypeYesYes Yes   
enumvirDomainEventTypeYesYes Yes   
enumvirDomainEventUndefinedDetailTypeYesYes Yes   
enumvirDomainEventResumedDetailTypeYesYesvirEventRegisterImplYesYesYesYes
enumvirDomainEventStartedDetailTypeYesYesvirEventRegisterImplYesYesYesYes
enumvirDomainEventStoppedDetailTypeYesYesvirEventRegisterImplYesYesYesYes
enumvirDomainEventSuspendedDetailTypeYesYesvirEventRegisterImplYesYesYesYes
enumvirDomainEventTypeYesYesvirEventRegisterImplYesYesYesYes
enumvirDomainEventUndefinedDetailTypeYesYesvirEventRegisterImplYesYesYesYes
enumvirDomainEventWatchdogActionNo      
structvirDomainInfoYesYes Yes   
structvirDomainInterfaceStatsStructYesNo Maybe   
enumvirDomainSnapshotDeleteFlags       
enumvirDomainStateYesYes Yes   
enumvirDomainXMLFlagsYesYes Yes   
enumvirEventHandleTypeYesYes Yes   
enumvirEventHandleTypeYesYesvirEventRegisterImplYesYesYesYes
structvirInterfaceYes, an IntPtr as the struct is not public      
enumvirInterfaceXMLFlagsNo      
structvirNWFilterNo      
enumvirSecretUsageTypeNo      
structvirSecurityLabelNo      
structvirSecurityModelNo      
structvirStoragePoolYes, an IntPtr as the struct is not public      
enumvirStoragePoolBuildFlagsYesNo Maybe   
enumvirStoragePoolDeleteFlagsYesNo Maybe   
structvirStoragePoolInfoYesYes Yes   
structvirStoragePoolYes, an IntPtr as the struct is not public      
enumvirStoragePoolStateYesYes Yes   
structvirStorageVolYes, an IntPtr as the struct is not public      
enumvirStorageVolDeleteFlagsNo      
- - + + - + @@ -199,7 +236,7 @@ git clone git://libvirt.org/libvirt-csharp.git - + @@ -219,11 +256,11 @@ git clone git://libvirt.org/libvirt-csharp.git - + - + @@ -233,8 +270,8 @@ git clone git://libvirt.org/libvirt-csharp.git - - + + @@ -272,29 +309,29 @@ git clone git://libvirt.org/libvirt-csharp.git - + - + - + - + - + - + @@ -312,14 +349,14 @@ git clone git://libvirt.org/libvirt-csharp.git - - + + - + - + @@ -333,7 +370,7 @@ git clone git://libvirt.org/libvirt-csharp.git - + @@ -344,7 +381,7 @@ git clone git://libvirt.org/libvirt-csharp.git - + @@ -386,10 +423,10 @@ git clone git://libvirt.org/libvirt-csharp.git - + - + @@ -441,13 +478,13 @@ git clone git://libvirt.org/libvirt-csharp.git - + - +
NameBinding?Type?Tested?Sample Code?Working?Tested .Net/Windows Works?Tested Mono/Windows Works?Tested Mono/Linux Works?
virConnectAuthCallbackPtrYesdelegateYesvirConnectOpenAuthYesYesYes 
NameBinding?Type?Tested?Sample Code?Working?Tested .Net/Windows Works?Tested Mono (32-bit)/Windows Works?Tested Mono (64-bit)/Linux Works?
virConnectAuthCallbackYesdelegateYesvirConnectOpenAuthYesYesYesYes
virConnectBaselineCPUNofunction      
virConnectCloseYesfunctionYesvirConnectOpenAuth YesYesYes
virConnectCloseYesfunctionYesvirConnectOpenAuthYesYesYesYes
virConnectCompareCPUNofunction      
virConnectDomainEventCallbackYesdelegateYes Yes   
virConnectDomainEventDeregisterNofunction      
virConnectDomainEventIOErrorCallbackNodelegate      
virConnectDomainEventIOErrorReasonCallbackNodelegate      
virConnectDomainEventRTCChangeCallbackNodelegate      
virConnectDomainEventRegisterYesfunctionYes Yes   
virConnectDomainEventRegisterYesfunctionYesvirEventRegisterImplYesYesYesYes
virConnectDomainEventRegisterAnyNofunction      
virConnectDomainEventWatchdogCallbackNodelegate      
virConnectDomainXMLFromNativeNofunction      
virConnectListDefinedNetworksYesfunctionYes Yes   
virConnectListDefinedStoragePoolsYesfunctionYes Yes   
virConnectListDomainsYesfunctionYesvirConnectOpenAuthYesYesYesYes
virConnectListInterfacesYesfunctionYes Yes, if the host handles the method   
virConnectListInterfacesYesfunctionYes Yes, if the host handle the method   
virConnectListNWFilters Nofunction      
virConnectListNetworksYesfunctionYes Yes   
virConnectListSecretsYesfunctionNo Maybe   
virConnectListStoragePoolsYesfunctionYes Yes   
virConnectListStoragePoolsYesfunctionYesvirConnectOpenYesYesYesYes
virConnectNumOfDefinedDomainsYesfunctionYesvirConnectOpenAuthYesYesYesYes
virConnectNumOfDefinedInterfacesYesfunctionNo Maybe   
virConnectNumOfDefinedNetworksYesfunctionYes Yes   
virConnectNumOfNWFiltersNofunction      
virConnectNumOfNetworks YesfunctionYes Yes   
virConnectNumOfSecretsYesfunctionNo Maybe   
virConnectNumOfStoragePoolsYesfunctionYes Yes   
virConnectOpenYesfunctionYes Yes   
virConnectNumOfStoragePoolsYesfunctionYesvirConnectOpenYesYesYesYes
virConnectOpenYesfunctionYesvirConnectOpen, virEventRegisterImplYesYesYesYes
virConnectOpenAuthYesfunctionYesvirConnectOpenAuthYesYesYesYes
virConnectOpenReadOnlyYesfunctionNo Maybe   
virConnectRefYesfunctionNo Maybe   
virDomainGetXMLDescYesfunctionYes Yes   
virDomainHasCurrentSnapshotNofunction      
virDomainHasManagedSaveImageNofunction      
virDomainInterfaceStatsNofunction      
virDomainInterfaceStats Nofunction      
virDomainIsActiveYesfunctionYes Yes   
virDomainIsPersistentYesfunctionNo Maybe   
virDomainLookupByIDYesfunctionYesvirConnectOpenAuthYesYesYesYes
virDomainLookupByNameYesfunctionYes Yes   
virDomainLookupByUUIDYesfunctionNo Maybe   
virDomainLookupByUUIDStringYesfunctionNo Maybe   
virDomainManagedSaveNofunction      
virDomainManagedSave Nofunction      
virDomainManagedSaveRemoveNofunction      
virDomainMemoryPeekNofunction      
virDomainMemoryStatsNofunction      
virDomainMigrateNofunction      
virDomainMigrateSetMaxDowntimeNofunction      
virDomainMigrateToURINofunction      
virDomainMigrateToURI Nofunction      
virDomainPinVcpuNofunction      
virDomainRebootYesfunctionYes Yes   
virDomainRefYesfunctionNo Maybe   
virDomainRef YesfunctionNo Maybe   
virDomainRestoreYes functionNo Maybe   
virDomainResumeYesfunctionYes Yes   
virDomainResume YesfunctionYes Yes   
virDomainRevertToSnapshotNofunction      
virDomainSaveYesfunctionNo Maybe   
virDomainSetAutostartYesfunctionNo Maybe   
virDomainSetMaxMemoryYesfunctionNo Maybe   
virDomainSetMaxMemory YesfunctionNo Maybe   
virDomainSetMemoryYesfunctionNo Maybe   
virDomainSetSchedulerParametersNofunction      
virDomainSetVcpusYesfunctionNo Maybe   
virDomainUpdateDeviceFlagsNofunction      
virEventAddHandleFuncYesdelegateYes Yes   
virEventAddTimeoutFuncYesdelegateYes Yes   
virEventHandleCallbackYesdelegateYes Yes   
virEventRegisterImplYesfunctionYes Yes   
virEventHandleCallbackYesdelegateYesvirEventRegisterImplYesYesYesYes
virEventRegisterImplYesfunctionYesvirEventRegisterImplYesYesYesYes
virEventRemoveHandleFuncYesdelegateYes Yes   
virEventRemoveTimeoutFuncYesdelegateYes Yes   
virEventTimeoutCallbackYesdelegateYes Yes   
virEventTimeoutCallbackYesdelegateYesvirEventRegisterImplYesYesYesYes
virEventUpdateHandleFuncYesdelegateYes Yes   
virEventUpdateTimeoutFuncYesdelegateYes Yes   
virFreeCallbackYesfunctionYes Yes   
virFreeCallbackYesfunctionYesvirEventRegisterImplYesYesYesYes
virGetVersionYesfunctionYes Yes   
virInitializeYesfunctionYes Yes   
virInterfaceCreateNofunction      
virInterfaceIsActiveNofunction      
virInterfaceLookupByMACStringNofunction      
virInterfaceLookupByNameNofunction      
virInterfaceRefNofunction      
virInterfaceRef Nofunction      
virInterfaceUndefineNofunction      
virNWFilterDefineXMLNofunction      
virNWFilterFreeNofunction      
virNWFilterLookupByName Nofunction      
virNWFilterLookupByUUIDNofunction      
virNWFilterLookupByUUIDStringNofunction      
virNWFilterRefNofunction      
virNWFilterRef Nofunction      
virNWFilterUndefineNofunction      
virNetworkCreateYesfunctionYes Yes   
virNetworkCreateXMLYesfunctionNo Maybe   
virNodeListDevicesYesfunctionYes Yes   
virNodeNumOfDevicesYesfunctionYes Yes   
virSecretDefineXMLNofunction      
virSecretFreeNofunction      
virSecretFree Nofunction      
virSecretGetConnectNofunction      
virSecretGetUUIDNofunction      
virSecretGetUUIDStringNofunction      
virSecretGetUUIDString Nofunction      
virSecretGetUsageIDNofunction      
virSecretGetUsageTypeNofunction      
virSecretGetValueNofunction      
virStorageVolLookupByPathYesfunctionYes Yes   
virStorageVolRefYesfunctionNo No   
virStorageVolWipeNofunction      
virStreamAbortNofunction      
virStreamAbort Nofunction      
virStreamEventAddCallbackNofunction      
virStreamEventCallbackNodelegate      
virStreamEventRemoveCallbackNofunction      
virStreamEventUpdateCallbackNofunction      
virStreamFinish Nofunction      
virStreamFreeNofunction      
virStreamFree Nofunction      
virStreamNewNofunction      
virStreamRecvNofunction      
virStreamRecvAllNofunction