dependencies/yaz_3.0.14/doc/asn.pdu.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>5. PDU Contents Table</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="YAZ User's Guide and Reference"><link rel="up" href="asn.html" title="Chapter 7. The Z39.50 ASN.1 Module"><link rel="prev" href="asn.external.html" title="4. EXTERNAL Data"><link rel="next" href="soap.html" title="Chapter 8. SOAP and SRU"></head><body><link rel="stylesheet" type="text/css" href="common/style1.css"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">5. PDU Contents Table</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="asn.external.html">Prev</a> </td><th width="60%" align="center">Chapter 7. The Z39.50 ASN.1 Module</th><td width="20%" align="right"> <a accesskey="n" href="soap.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="asn.pdu"></a>5. PDU Contents Table</h2></div></div></div><p>
   2     We include, for reference, a listing of the fields of each top-level
   3     PDU, as well as their default settings.
   4    </p><div class="table"><a name="asn.default.initialize.request"></a><p class="title"><b>Table 7.1. Default settings for PDU Initialize Request</b></p><div class="table-contents"><table summary="Default settings for PDU Initialize Request" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
   5        referenceId</td><td>Z_ReferenceId</td><td>NULL
   6       </td></tr><tr><td>
   7        protocolVersion</td><td>Odr_bitmask</td><td>Empty bitmask
   8       </td></tr><tr><td>
   9        options</td><td>Odr_bitmask</td><td>Empty bitmask
  10       </td></tr><tr><td>
  11        preferredMessageSize</td><td>int</td><td>30*1024
  12       </td></tr><tr><td>
  13        maximumRecordSize</td><td>int</td><td>30*1024
  14       </td></tr><tr><td>
  15        idAuthentication</td><td>Z_IdAuthentication</td><td>NULL
  16       </td></tr><tr><td>
  17        implementationId</td><td>char*</td><td>"81"
  18       </td></tr><tr><td>
  19        implementationName</td><td>char*</td><td>"YAZ"
  20       </td></tr><tr><td>
  21        implementationVersion</td><td>char*</td><td>YAZ_VERSION
  22       </td></tr><tr><td>
  23        userInformationField</td><td>Z_UserInformation</td><td>NULL
  24       </td></tr><tr><td>
  25        otherInfo</td><td>Z_OtherInformation</td><td>NULL
  26       </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.initialize.response"></a><p class="title"><b>Table 7.2. Default settings for PDU Initialize
  27     Response</b></p><div class="table-contents"><table summary="Default settings for PDU Initialize
  28     Response" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
  29         referenceId</td><td>Z_ReferenceId</td><td>NULL
  30        </td></tr><tr><td>
  31         protocolVersion</td><td>Odr_bitmask</td><td>Empty bitmask
  32        </td></tr><tr><td>
  33         options</td><td>Odr_bitmask</td><td>Empty bitmask
  34        </td></tr><tr><td>
  35         preferredMessageSize</td><td>int</td><td>30*1024
  36        </td></tr><tr><td>
  37         maximumRecordSize</td><td>int</td><td>30*1024
  38        </td></tr><tr><td>
  39         result</td><td>bool_t</td><td>TRUE
  40        </td></tr><tr><td>
  41         implementationId</td><td>char*</td><td>"id)"
  42        </td></tr><tr><td>
  43         implementationName</td><td>char*</td><td>"YAZ"
  44        </td></tr><tr><td>
  45         implementationVersion</td><td>char*</td><td>YAZ_VERSION
  46        </td></tr><tr><td>
  47         userInformationField</td><td>Z_UserInformation</td><td>NULL
  48        </td></tr><tr><td>
  49         otherInfo</td><td>Z_OtherInformation</td><td>NULL
  50        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.search.request"></a><p class="title"><b>Table 7.3. Default settings for PDU Search Request</b></p><div class="table-contents"><table summary="Default settings for PDU Search Request" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
  51         referenceId</td><td>Z_ReferenceId</td><td>NULL
  52        </td></tr><tr><td>
  53         smallSetUpperBound</td><td>int</td><td>0
  54        </td></tr><tr><td>
  55         largeSetLowerBound</td><td>int</td><td>1
  56        </td></tr><tr><td>
  57         mediumSetPresentNumber</td><td>int</td><td>0
  58        </td></tr><tr><td>
  59         replaceIndicator</td><td>bool_t</td><td>TRUE
  60        </td></tr><tr><td>
  61         resultSetName</td><td>char *</td><td>"default"
  62        </td></tr><tr><td>
  63         num_databaseNames</td><td>int</td><td>0
  64        </td></tr><tr><td>
  65         databaseNames</td><td>char **</td><td>NULL
  66        </td></tr><tr><td>
  67         smallSetElementSetNames</td><td>Z_ElementSetNames
  68        </td><td>NULL
  69        </td></tr><tr><td>
  70         mediumSetElementSetNames</td><td>Z_ElementSetNames
  71        </td><td>NULL
  72        </td></tr><tr><td>
  73         preferredRecordSyntax</td><td>Odr_oid</td><td>NULL
  74        </td></tr><tr><td>
  75         query</td><td>Z_Query</td><td>NULL
  76        </td></tr><tr><td>
  77         additionalSearchInfo</td><td>Z_OtherInformation
  78        </td><td>NULL
  79        </td></tr><tr><td>
  80         otherInfo</td><td>Z_OtherInformation</td><td>NULL
  81        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.search.response"></a><p class="title"><b>Table 7.4. Default settings for PDU Search Response</b></p><div class="table-contents"><table summary="Default settings for PDU Search Response" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
  82         referenceId</td><td>Z_ReferenceId</td><td>NULL
  83        </td></tr><tr><td>
  84         resultCount</td><td>int</td><td>0
  85        </td></tr><tr><td>
  86         numberOfRecordsReturned</td><td>int</td><td>0
  87        </td></tr><tr><td>
  88         nextResultSetPosition</td><td>int</td><td>0
  89        </td></tr><tr><td>
  90         searchStatus</td><td>bool_t</td><td>TRUE
  91        </td></tr><tr><td>
  92         resultSetStatus</td><td>int</td><td>NULL
  93        </td></tr><tr><td>
  94         presentStatus</td><td>int</td><td>NULL
  95        </td></tr><tr><td>
  96         records</td><td>Z_Records</td><td>NULL
  97        </td></tr><tr><td>
  98         additionalSearchInfo</td><td>Z_OtherInformation</td><td>NULL
  99        </td></tr><tr><td>
 100         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 101        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.present.request"></a><p class="title"><b>Table 7.5. Default settings for PDU Present Request</b></p><div class="table-contents"><table summary="Default settings for PDU Present Request" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 102         referenceId</td><td>Z_ReferenceId</td><td>NULL
 103        </td></tr><tr><td>
 104         resultSetId</td><td>char*</td><td>"default"
 105        </td></tr><tr><td>
 106         resultSetStartPoint</td><td>int</td><td>1
 107        </td></tr><tr><td>
 108         numberOfRecordsRequested</td><td>int</td><td>10
 109        </td></tr><tr><td>
 110         num_ranges</td><td>int</td><td>0
 111        </td></tr><tr><td>
 112         additionalRanges</td><td>Z_Range</td><td>NULL
 113        </td></tr><tr><td>
 114         recordComposition</td><td>Z_RecordComposition</td><td>NULL
 115        </td></tr><tr><td>
 116         preferredRecordSyntax</td><td>Odr_oid</td><td>NULL
 117        </td></tr><tr><td>
 118         maxSegmentCount</td><td>int</td><td>NULL
 119        </td></tr><tr><td>
 120         maxRecordSize</td><td>int</td><td>NULL
 121        </td></tr><tr><td>
 122         maxSegmentSize</td><td>int</td><td>NULL
 123        </td></tr><tr><td>
 124         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 125        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.present.response"></a><p class="title"><b>Table 7.6. Default settings for PDU Present Response</b></p><div class="table-contents"><table summary="Default settings for PDU Present Response" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 126         referenceId</td><td>Z_ReferenceId</td><td>NULL
 127        </td></tr><tr><td>
 128         numberOfRecordsReturned</td><td>int</td><td>0
 129        </td></tr><tr><td>
 130         nextResultSetPosition</td><td>int</td><td>0
 131        </td></tr><tr><td>
 132         presentStatus</td><td>int</td><td>Z_PresentStatus_success
 133        </td></tr><tr><td>
 134         records</td><td>Z_Records</td><td>NULL
 135        </td></tr><tr><td>
 136         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 137        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.delete.result.set.request"></a><p class="title"><b>Table 7.7. Default settings for Delete Result Set Request
 138     </b></p><div class="table-contents"><table summary="Default settings for Delete Result Set Request
 139     " border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>referenceId
 140        </td><td>Z_ReferenceId</td><td>NULL
 141        </td></tr><tr><td>
 142         deleteFunction</td><td>int</td><td>Z_DeleteResultSetRequest_list
 143        </td></tr><tr><td>
 144         num_ids</td><td>int</td><td>0
 145        </td></tr><tr><td>
 146         resultSetList</td><td>char**</td><td>NULL
 147        </td></tr><tr><td>
 148         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 149        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.delete.result.set.response"></a><p class="title"><b>Table 7.8. Default settings for Delete Result Set Response
 150     </b></p><div class="table-contents"><table summary="Default settings for Delete Result Set Response
 151     " border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 152         referenceId</td><td>Z_ReferenceId</td><td>NULL
 153        </td></tr><tr><td>
 154         deleteOperationStatus</td><td>int</td><td>Z_DeleteStatus_success</td></tr><tr><td>
 155         num_statuses</td><td>int</td><td>0
 156        </td></tr><tr><td>
 157         deleteListStatuses</td><td>Z_ListStatus**</td><td>NULL
 158        </td></tr><tr><td>
 159         numberNotDeleted</td><td>int</td><td>NULL
 160        </td></tr><tr><td>
 161         num_bulkStatuses</td><td>int</td><td>0
 162        </td></tr><tr><td>
 163         bulkStatuses</td><td>Z_ListStatus</td><td>NUL
 164         L</td></tr><tr><td>
 165         deleteMessage</td><td>char*</td><td>NULL
 166        </td></tr><tr><td>
 167         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 168        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.scan.request"></a><p class="title"><b>Table 7.9. Default settings for Scan Request
 169     </b></p><div class="table-contents"><table summary="Default settings for Scan Request
 170     " border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 171         referenceId</td><td>Z_ReferenceId</td><td>NULL
 172        </td></tr><tr><td>
 173         num_databaseNames</td><td>int</td><td>0
 174        </td></tr><tr><td>
 175         databaseNames</td><td>char**</td><td>NULL
 176        </td></tr><tr><td>
 177         attributeSet</td><td>Odr_oid</td><td>NULL
 178        </td></tr><tr><td>
 179         termListAndStartPoint</td><td>Z_AttributesPlus...
 180        </td><td>NULL</td></tr><tr><td>
 181         stepSize</td><td>int</td><td>NULL
 182        </td></tr><tr><td>
 183         numberOfTermsRequested</td><td>int</td><td>20
 184        </td></tr><tr><td>
 185         preferredPositionInResponse</td><td>int</td><td>NULL
 186        </td></tr><tr><td>
 187         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 188        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.scan.response"></a><p class="title"><b>Table 7.10. Default settings for Scan Response
 189     </b></p><div class="table-contents"><table summary="Default settings for Scan Response
 190     " border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 191         referenceId</td><td>Z_ReferenceId</td><td>NULL
 192        </td></tr><tr><td>
 193         stepSize</td><td>int</td><td>NULL
 194        </td></tr><tr><td>
 195         scanStatus</td><td>int</td><td>Z_Scan_success
 196        </td></tr><tr><td>
 197         numberOfEntriesReturned</td><td>int</td><td>0
 198        </td></tr><tr><td>
 199         positionOfTerm</td><td>int</td><td>NULL
 200        </td></tr><tr><td>
 201         entries</td><td>Z_ListEntris</td><td>NULL
 202        </td></tr><tr><td>
 203         attributeSet</td><td>Odr_oid</td><td>NULL
 204        </td></tr><tr><td>
 205         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 206        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.trigger.resource.control.request"></a><p class="title"><b>Table 7.11. Default settings for Trigger Resource Control Request </b></p><div class="table-contents"><table summary="Default settings for Trigger Resource Control Request " border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 207         referenceId</td><td>Z_ReferenceId</td><td>NULL
 208        </td></tr><tr><td>
 209         requestedAction</td><td>int</td><td>
 210         Z_TriggerResourceCtrl_resou..
 211        </td></tr><tr><td>
 212         prefResourceReportFormat</td><td>Odr_oid</td><td>NULL
 213        </td></tr><tr><td>
 214         resultSetWanted</td><td>bool_t</td><td>NULL
 215        </td></tr><tr><td>
 216         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 217        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.resource.control.request"></a><p class="title"><b>Table 7.12. Default settings for Resource Control Request</b></p><div class="table-contents"><table summary="Default settings for Resource Control Request" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 218         referenceId</td><td>Z_ReferenceId</td><td>NULL
 219        </td></tr><tr><td>
 220         suspendedFlag</td><td>bool_t</td><td>NULL
 221        </td></tr><tr><td>
 222         resourceReport</td><td>Z_External</td><td>NULL
 223        </td></tr><tr><td>
 224         partialResultsAvailable</td><td>int</td><td>NULL
 225        </td></tr><tr><td>
 226         responseRequired</td><td>bool_t</td><td>FALSE
 227        </td></tr><tr><td>
 228         triggeredRequestFlag</td><td>bool_t</td><td>NULL
 229        </td></tr><tr><td>
 230         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 231        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.resource.control.response"></a><p class="title"><b>Table 7.13. Default settings for Resource Control Response</b></p><div class="table-contents"><table summary="Default settings for Resource Control Response" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 232         referenceId</td><td>Z_ReferenceId</td><td>NULL
 233        </td></tr><tr><td>
 234         continueFlag</td><td>bool_t</td><td>TRUE
 235        </td></tr><tr><td>
 236         resultSetWanted</td><td>bool_t</td><td>NULL
 237        </td></tr><tr><td>
 238         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 239        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.access.control.request"></a><p class="title"><b>Table 7.14. Default settings for Access Control Request</b></p><div class="table-contents"><table summary="Default settings for Access Control Request" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 240         referenceId</td><td>Z_ReferenceId</td><td>NULL
 241        </td></tr><tr><td>
 242         which</td><td>enum</td><td>Z_AccessRequest_simpleForm;
 243        </td></tr><tr><td>
 244         u</td><td>union</td><td>NULL
 245        </td></tr><tr><td>
 246         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 247        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.access.control.response"></a><p class="title"><b>Table 7.15. Default settings for Access Control Response</b></p><div class="table-contents"><table summary="Default settings for Access Control Response" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 248         referenceId</td><td>Z_ReferenceId</td><td>NULL
 249        </td></tr><tr><td>
 250         which</td><td>enum</td><td>Z_AccessResponse_simpleForm
 251        </td></tr><tr><td>
 252         u</td><td>union</td><td>NULL
 253        </td></tr><tr><td>
 254         diagnostic</td><td>Z_DiagRec</td><td>NULL
 255        </td></tr><tr><td>
 256         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 257        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.segment"></a><p class="title"><b>Table 7.16. Default settings for Segment</b></p><div class="table-contents"><table summary="Default settings for Segment" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 258         referenceId</td><td>Z_ReferenceId</td><td>NULL
 259        </td></tr><tr><td>
 260         numberOfRecordsReturned</td><td>int</td><td>value=0
 261        </td></tr><tr><td>
 262         num_segmentRecords</td><td>int</td><td>0
 263        </td></tr><tr><td>
 264         segmentRecords</td><td>Z_NamePlusRecord</td><td>NULL
 265        </td></tr><tr><td>otherInfo</td><td>Z_OtherInformation</td><td>NULL
 266        </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="asn.default.close"></a><p class="title"><b>Table 7.17. Default settings for Close</b></p><div class="table-contents"><table summary="Default settings for Close" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Default Value</th></tr></thead><tbody><tr><td>
 267         referenceId</td><td>Z_ReferenceId</td><td>NULL
 268        </td></tr><tr><td>
 269         closeReason</td><td>int</td><td>Z_Close_finished
 270        </td></tr><tr><td>
 271         diagnosticInformation</td><td>char*</td><td>NULL
 272        </td></tr><tr><td>
 273         resourceReportFormat</td><td>Odr_oid</td><td>NULL
 274        </td></tr><tr><td>
 275         resourceFormat</td><td>Z_External</td><td>NULL
 276        </td></tr><tr><td>
 277         otherInfo</td><td>Z_OtherInformation</td><td>NULL
 278        </td></tr></tbody></table></div></div><br class="table-break"></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="asn.external.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="asn.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="soap.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">4. EXTERNAL Data </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 8. SOAP and SRU</td></tr></table></div></body></html>