>YAZ User's Guide and Reference

YAZ User's Guide and Reference

Sebastian Hammer

Edited by

Adam Dickmeiss

Copyright © 1995-2002 by Index Data

This document is the programmer's guide and reference to the YAZ package version 1.9.2. YAZ is a compact toolkit that provides access to the Z39.50 protocol, as well as a set of higher-level tools for implementing the server and client roles, respectively. The documentation can be used on its own, or as a reference when looking at the example applications provided with the package.

Table of Contents
1. Introduction
2. Compilation and Installation
Introduction
UNIX
Compiling from source on Unix
How to make apps using YAZ on UNIX
WIN32
Compiling from Source on WIN32
How to make apps using YAZ on WIN32
3. Building clients with ZOOM
Connections
Protocol behavior
Queries
Protocol behavior
Result sets
Protocol behavior
Records
Protocol behavior
Scan
Options
Events
4. Generic server
Introduction
The Database Frontend
The Backend API
Your main() Routine
The Backend Functions
Init
Search and retrieve
Delete
scan
Application Invocation
5. The YAZ client
Introduction
Invoking the YAZ client
Commands
Searching
6. The Z39.50 ASN.1 Module
Introduction
Preparing PDUs
Object Identifiers
EXTERNAL Data
PDU Contents Table
7. Supporting Tools
Query Syntax Parsers
Prefix Query Format
Common Command Language
Object Identifiers
Nibble Memory
8. The ODR Module
Introduction
Using ODR
ODR Streams
Memory Management
Encoding and Decoding Data
Diagnostics
Summary and Synopsis
Programming with ODR
The Primitive ASN.1 Types
Tagging Primitive Types
Constructed Types
Tagging Constructed Types
SEQUENCE OF
CHOICE Types
Debugging
9. The COMSTACK Module
Synopsis (blocking mode)
Introduction
Common Functions
Managing Endpoints
Data Exchange
Client Side
Server Side
Addresses
Diagnostics
Summary and Synopsis
10. Future Directions
A. License
Index Data Copyright
Additional Copyright Statements
B. About Index Data
C. Credits
List of Tables
3-1. ZOOM Connection Options
3-2. ZOOM Result set Options
3-3. ZOOM Scan Set Options
6-1. Default settings for PDU Initialize Request
6-2. Default settings for PDU Initialize Response
6-3. Default settings for PDU Search Request
6-4. Default settings for PDU Search Response
6-5. Default settings for PDU Present Request
6-6. Default settings for PDU Present Response
6-7. Default settings for Delete Result Set Request
6-8. Default settings for Delete Result Set Response
6-9. Default settings for Scan Request
6-10. Default settings for Scan Response
6-11. Default settings for Trigger Resource Control Request
6-12. Default settings for Resource Control Request
6-13. Default settings for Resource Control Response
6-14. Default settings for Access Control Request
6-15. Default settings for Access Control Response
6-16. Default settings for Segment
6-17. Default settings for Close
8-1. ODR Error codes
  Next
  Introduction