Print Friendly  .  About this website   .  Search 

 

 

 

Index Data  >  YAZ  >  YAZ User's Guide and Reference

YAZ User's Guide and Reference

Sebastian Hammer

Adam Dickmeiss

Mike Taylor

Heikki Levanto

3.0.47

Abstract

This document is the programmer's guide and reference to the YAZ package version 3.0.47. YAZ is a compact toolkit that provides access to the Z39.50 and SRW/SRU protocols, 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
Reading this Manual
The API
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. ZOOM
Connections
Z39.50 Protocol behavior
SRU Protocol behavior
Queries
Protocol behavior
Result sets
Z39.50 Protocol behavior
SRU Protocol behavior
Records
Z39.50 Protocol behavior
SRU Protocol behavior
Scan
Extended Services
Item Order
Record Update
Database Create
Database Drop
Commit Operation
Protocol behavior
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
GFS Configuration and Virtual Hosts
5. The Z39.50 ASN.1 Module
Introduction
Preparing PDUs
EXTERNAL Data
PDU Contents Table
6. SOAP and SRU
Introduction
HTTP
SOAP Packages
SRU
7. Supporting Tools
Query Syntax Parsers
Prefix Query Format
CCL
CQL
Object Identifiers
OID database
Standard OIDs
Nibble Memory
Log
MARC
Retrieval Facility
Retrieval XML format
Retrieval Facility Examples
API
8. The ODR Module
Introduction
Using ODR
ODR Streams
Memory Management
Encoding and Decoding Data
Printing
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
SSL
Diagnostics
Summary and Synopsis
10. Future Directions
I. Reference
yaz-client — Z39.50/SRU client for implementors
yaz-ztest — Z39.50 Test Server
yaz-config — Script to get information about YAZ.
yaz — Z39.50 toolkit.
zoomsh — ZOOM shell
yaz-asncomp — YAZ ASN.1 compiler
yaz-marcdump — MARC record dump utility
yaz-iconv — YAZ Character set conversion utility
yaz-log — Log handling in all yaz-based programs
yaz-illclient — ILL client
yaz-icu — YAZ ICU utility
Bib-1 Attribute Set — Bib-1 Attribute Set
A. List of Object Identifiers
B. License
Index Data Copyright
C. About Index Data
D. Credits

List of Figures

1.1. YAZ layers