ia64/xen-unstable

changeset 12815:e8f5cd2b7253

More description tidyups -- constructors and destructors this time.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
author Ewan Mellor <ewan@xensource.com>
date Wed Dec 06 13:28:37 2006 +0000 (2006-12-06)
parents 59d3be0dd1d4
children 0dfe894e37a4
files docs/xen-api/xenapi-datamodel.tex
line diff
     1.1 --- a/docs/xen-api/xenapi-datamodel.tex	Wed Dec 06 13:24:28 2006 +0000
     1.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Wed Dec 06 13:28:37 2006 +0000
     1.3 @@ -400,7 +400,7 @@ value of the field
     1.4  \subsubsection{RPC name:~create}
     1.5  
     1.6  {\bf Overview:} 
     1.7 -constructor for class session
     1.8 +Create a new session instance, and return its handle.
     1.9  
    1.10   \noindent {\bf Signature:} 
    1.11  \begin{verbatim} (session ref) create (session_id s, session record args)\end{verbatim}
    1.12 @@ -432,7 +432,7 @@ reference to the newly created object
    1.13  \subsubsection{RPC name:~destroy}
    1.14  
    1.15  {\bf Overview:} 
    1.16 -destructor for class session
    1.17 +Destroy the specified session instance.
    1.18  
    1.19   \noindent {\bf Signature:} 
    1.20  \begin{verbatim} void destroy (session_id s, session ref self)\end{verbatim}
    1.21 @@ -766,7 +766,7 @@ void
    1.22  \subsubsection{RPC name:~create}
    1.23  
    1.24  {\bf Overview:} 
    1.25 -constructor for class task
    1.26 +Create a new task instance, and return its handle.
    1.27  
    1.28   \noindent {\bf Signature:} 
    1.29  \begin{verbatim} (task ref) create (session_id s, task record args)\end{verbatim}
    1.30 @@ -798,7 +798,7 @@ reference to the newly created object
    1.31  \subsubsection{RPC name:~destroy}
    1.32  
    1.33  {\bf Overview:} 
    1.34 -destructor for class task
    1.35 +Destroy the specified task instance.
    1.36  
    1.37   \noindent {\bf Signature:} 
    1.38  \begin{verbatim} void destroy (session_id s, task ref self)\end{verbatim}
    1.39 @@ -3733,7 +3733,7 @@ void
    1.40  \subsubsection{RPC name:~create}
    1.41  
    1.42  {\bf Overview:} 
    1.43 -constructor for class VM
    1.44 +Create a new VM instance, and return its handle.
    1.45  
    1.46   \noindent {\bf Signature:} 
    1.47  \begin{verbatim} (VM ref) create (session_id s, VM record args)\end{verbatim}
    1.48 @@ -3765,7 +3765,7 @@ reference to the newly created object
    1.49  \subsubsection{RPC name:~destroy}
    1.50  
    1.51  {\bf Overview:} 
    1.52 -destructor for class VM
    1.53 +Destroy the specified VM instance.
    1.54  
    1.55   \noindent {\bf Signature:} 
    1.56  \begin{verbatim} void destroy (session_id s, VM ref self)\end{verbatim}
    1.57 @@ -4356,7 +4356,7 @@ value of the field
    1.58  \subsubsection{RPC name:~create}
    1.59  
    1.60  {\bf Overview:} 
    1.61 -constructor for class host
    1.62 +Create a new host instance, and return its handle.
    1.63  
    1.64   \noindent {\bf Signature:} 
    1.65  \begin{verbatim} (host ref) create (session_id s, host record args)\end{verbatim}
    1.66 @@ -4388,7 +4388,7 @@ reference to the newly created object
    1.67  \subsubsection{RPC name:~destroy}
    1.68  
    1.69  {\bf Overview:} 
    1.70 -destructor for class host
    1.71 +Destroy the specified host instance.
    1.72  
    1.73   \noindent {\bf Signature:} 
    1.74  \begin{verbatim} void destroy (session_id s, host ref self)\end{verbatim}
    1.75 @@ -4795,7 +4795,7 @@ value of the field
    1.76  \subsubsection{RPC name:~create}
    1.77  
    1.78  {\bf Overview:} 
    1.79 -constructor for class host\_cpu
    1.80 +Create a new host\_cpu instance, and return its handle.
    1.81  
    1.82   \noindent {\bf Signature:} 
    1.83  \begin{verbatim} (host_cpu ref) create (session_id s, host_cpu record args)\end{verbatim}
    1.84 @@ -4827,7 +4827,7 @@ reference to the newly created object
    1.85  \subsubsection{RPC name:~destroy}
    1.86  
    1.87  {\bf Overview:} 
    1.88 -destructor for class host\_cpu
    1.89 +Destroy the specified host\_cpu instance.
    1.90  
    1.91   \noindent {\bf Signature:} 
    1.92  \begin{verbatim} void destroy (session_id s, host_cpu ref self)\end{verbatim}
    1.93 @@ -5326,7 +5326,7 @@ void
    1.94  \subsubsection{RPC name:~create}
    1.95  
    1.96  {\bf Overview:} 
    1.97 -constructor for class network
    1.98 +Create a new network instance, and return its handle.
    1.99  
   1.100   \noindent {\bf Signature:} 
   1.101  \begin{verbatim} (network ref) create (session_id s, network record args)\end{verbatim}
   1.102 @@ -5358,7 +5358,7 @@ reference to the newly created object
   1.103  \subsubsection{RPC name:~destroy}
   1.104  
   1.105  {\bf Overview:} 
   1.106 -destructor for class network
   1.107 +Destroy the specified network instance.
   1.108  
   1.109   \noindent {\bf Signature:} 
   1.110  \begin{verbatim} void destroy (session_id s, network ref self)\end{verbatim}
   1.111 @@ -6069,7 +6069,7 @@ value of the field
   1.112  \subsubsection{RPC name:~create}
   1.113  
   1.114  {\bf Overview:} 
   1.115 -constructor for class VIF
   1.116 +Create a new VIF instance, and return its handle.
   1.117  
   1.118   \noindent {\bf Signature:} 
   1.119  \begin{verbatim} (VIF ref) create (session_id s, VIF record args)\end{verbatim}
   1.120 @@ -6101,7 +6101,7 @@ reference to the newly created object
   1.121  \subsubsection{RPC name:~destroy}
   1.122  
   1.123  {\bf Overview:} 
   1.124 -destructor for class VIF
   1.125 +Destroy the specified VIF instance.
   1.126  
   1.127   \noindent {\bf Signature:} 
   1.128  \begin{verbatim} void destroy (session_id s, VIF ref self)\end{verbatim}
   1.129 @@ -6713,7 +6713,7 @@ value of the field
   1.130  \subsubsection{RPC name:~create}
   1.131  
   1.132  {\bf Overview:} 
   1.133 -constructor for class PIF
   1.134 +Create a new PIF instance, and return its handle.
   1.135  
   1.136   \noindent {\bf Signature:} 
   1.137  \begin{verbatim} (PIF ref) create (session_id s, PIF record args)\end{verbatim}
   1.138 @@ -6745,7 +6745,7 @@ reference to the newly created object
   1.139  \subsubsection{RPC name:~destroy}
   1.140  
   1.141  {\bf Overview:} 
   1.142 -destructor for class PIF
   1.143 +Destroy the specified PIF instance.
   1.144  
   1.145   \noindent {\bf Signature:} 
   1.146  \begin{verbatim} void destroy (session_id s, PIF ref self)\end{verbatim}
   1.147 @@ -7279,7 +7279,7 @@ value of the field
   1.148  \subsubsection{RPC name:~create}
   1.149  
   1.150  {\bf Overview:} 
   1.151 -constructor for class SR
   1.152 +Create a new SR instance, and return its handle.
   1.153  
   1.154   \noindent {\bf Signature:} 
   1.155  \begin{verbatim} (SR ref) create (session_id s, SR record args)\end{verbatim}
   1.156 @@ -7311,7 +7311,7 @@ reference to the newly created object
   1.157  \subsubsection{RPC name:~destroy}
   1.158  
   1.159  {\bf Overview:} 
   1.160 -destructor for class SR
   1.161 +Destroy the specified SR instance.
   1.162  
   1.163   \noindent {\bf Signature:} 
   1.164  \begin{verbatim} void destroy (session_id s, SR ref self)\end{verbatim}
   1.165 @@ -8153,7 +8153,7 @@ void
   1.166  \subsubsection{RPC name:~create}
   1.167  
   1.168  {\bf Overview:} 
   1.169 -constructor for class VDI
   1.170 +Create a new VDI instance, and return its handle.
   1.171  
   1.172   \noindent {\bf Signature:} 
   1.173  \begin{verbatim} (VDI ref) create (session_id s, VDI record args)\end{verbatim}
   1.174 @@ -8185,7 +8185,7 @@ reference to the newly created object
   1.175  \subsubsection{RPC name:~destroy}
   1.176  
   1.177  {\bf Overview:} 
   1.178 -destructor for class VDI
   1.179 +Destroy the specified VDI instance.
   1.180  
   1.181   \noindent {\bf Signature:} 
   1.182  \begin{verbatim} void destroy (session_id s, VDI ref self)\end{verbatim}
   1.183 @@ -8796,7 +8796,7 @@ value of the field
   1.184  \subsubsection{RPC name:~create}
   1.185  
   1.186  {\bf Overview:} 
   1.187 -constructor for class VBD
   1.188 +Create a new VBD instance, and return its handle.
   1.189  
   1.190   \noindent {\bf Signature:} 
   1.191  \begin{verbatim} (VBD ref) create (session_id s, VBD record args)\end{verbatim}
   1.192 @@ -8828,7 +8828,7 @@ reference to the newly created object
   1.193  \subsubsection{RPC name:~destroy}
   1.194  
   1.195  {\bf Overview:} 
   1.196 -destructor for class VBD
   1.197 +Destroy the specified VBD instance.
   1.198  
   1.199   \noindent {\bf Signature:} 
   1.200  \begin{verbatim} void destroy (session_id s, VBD ref self)\end{verbatim}
   1.201 @@ -9104,7 +9104,7 @@ value of the field
   1.202  \subsubsection{RPC name:~create}
   1.203  
   1.204  {\bf Overview:} 
   1.205 -constructor for class VTPM
   1.206 +Create a new VTPM instance, and return its handle.
   1.207  
   1.208   \noindent {\bf Signature:} 
   1.209  \begin{verbatim} (VTPM ref) create (session_id s, VTPM record args)\end{verbatim}
   1.210 @@ -9136,7 +9136,7 @@ reference to the newly created object
   1.211  \subsubsection{RPC name:~destroy}
   1.212  
   1.213  {\bf Overview:} 
   1.214 -destructor for class VTPM
   1.215 +Destroy the specified VTPM instance.
   1.216  
   1.217   \noindent {\bf Signature:} 
   1.218  \begin{verbatim} void destroy (session_id s, VTPM ref self)\end{verbatim}
   1.219 @@ -9655,7 +9655,7 @@ void
   1.220  \subsubsection{RPC name:~create}
   1.221  
   1.222  {\bf Overview:} 
   1.223 -constructor for class user
   1.224 +Create a new user instance, and return its handle.
   1.225  
   1.226   \noindent {\bf Signature:} 
   1.227  \begin{verbatim} (user ref) create (session_id s, user record args)\end{verbatim}
   1.228 @@ -9687,7 +9687,7 @@ reference to the newly created object
   1.229  \subsubsection{RPC name:~destroy}
   1.230  
   1.231  {\bf Overview:} 
   1.232 -destructor for class user
   1.233 +Destroy the specified user instance.
   1.234  
   1.235   \noindent {\bf Signature:} 
   1.236  \begin{verbatim} void destroy (session_id s, user ref self)\end{verbatim}
   1.237 @@ -9832,7 +9832,7 @@ void
   1.238  \subsubsection{RPC name:~create}
   1.239  
   1.240  {\bf Overview:} 
   1.241 -constructor for class debug
   1.242 +Create a new debug instance, and return its handle.
   1.243  
   1.244   \noindent {\bf Signature:} 
   1.245  \begin{verbatim} (debug ref) create (session_id s, debug record args)\end{verbatim}
   1.246 @@ -9864,7 +9864,7 @@ reference to the newly created object
   1.247  \subsubsection{RPC name:~destroy}
   1.248  
   1.249  {\bf Overview:} 
   1.250 -destructor for class debug
   1.251 +Destroy the specified debug instance.
   1.252  
   1.253   \noindent {\bf Signature:} 
   1.254  \begin{verbatim} void destroy (session_id s, debug ref self)\end{verbatim}