<title>YAZ C++ API</title>
<para>
The YAZ C++ API is an client - and server API that exposes
- all YAZ features. The API doesn't hide YAZ C datastructures, but
+ all YAZ features. The API doesn't hide YAZ C data structures, but
provides a set of useful high-level objects for creating clients -
and servers.
</para>
</para>
<note>
<para>
- The documentation here is very limited. We plan to enhance it
+ The documentation here is very limited. We plan to enhance it -
provided there is interest for it.
</para>
</note>
interface.
</para>
<synopsis>
- #include <yaz++/socket-observer.h>
+ #include <yazpp/socket-observer.h>
class my_socketobservable : public IYazSocketObservable {
// Add an observer interested in socket fd
virtual void deleteObserver(IYazSocketObserver *observer) = 0;
// Delete all observers
virtual void deleteObservers() = 0;
- // Specify the events that the observer is intersted in.
+ // Specify the events that the observer is interested in.
virtual void maskObserver(IYazSocketObserver *observer,
int mask) = 0;
// Specify timeout
};
</synopsis>
</section>
- <section id="IYazSocketObserver"><title>IYazZSocketObserver</title>
+ <section id="IYazSocketObserver"><title>IYazSocketObserver</title>
<para>
This interface is interested in socket events supporting
the <link linkend="IYazSocketObservable">IYazSocketObservable</link>
interface.
</para>
<synopsis>
- #include <yaz++/socket-observer.h>
+ #include <yazpp/socket-observer.h>
class my_socketobserver : public IYazSocketObserver {
public:
is notified.
</para>
<synopsis>
- #include <yaz++/pdu-observer.h>
+ #include <yazpp/pdu-observer.h>
class my_pduobservable : public IYaz_PDU_Observable {
public:
<link linkend="IYaz_PDU_Observable">IYaz_PDU_Observable</link>.
</para>
<synopsis>
- #include <yaz++/pdu-observer.h>
+ #include <yazpp/pdu-observer.h>
class my_pduobserver : public IYaz_PDU_Observer {
public:
Abstract query.
</para>
<synopsis>
- #include <yaz++/query.h>
+ #include <yazpp/query.h>
class my_query : public Yaz_Query {
public:
// Print query in buffer described by str and len
command line clients, etc.
</para>
<synopsis>
- #include <yaz++/socket-manager.h>
+ #include <yazpp/socket-manager.h>
class Yaz_SocketManager : public IYazSocketObservable {
public:
that transmits BER encoded PDUs (or those offered by YAZ COMSTACK).
</para>
<synopsis>
- #include <yaz++/pdu-assoc.h>
+ #include <yazpp/pdu-assoc.h>
class Yaz_PDU_Assoc : public IYaz_PDU_Observable,
IYazSocketObserver {
Z-Association.
</para>
<synopsis>
- #include <yaz++/z-assoc.h>
+ #include <yazpp/z-assoc.h>
class Yaz_Z_Assoc : public IYaz_PDU_Observer {
public:
// Create object using the PDU Observer specified
Yaz_Z_Assoc(IYaz_PDU_Observable *the_PDU_Observable);
- // Destroy assocation and close PDU Observer
+ // Destroy association and close PDU Observer
virtual ~Yaz_Z_Assoc();
// Receive PDU
void recv_PDU(const char *buf, int len);
more facilities for the Z39.50 client role.
</para>
<synopsis>
- #include <yaz++/ir-assoc.h>
+ #include <yazpp/ir-assoc.h>
class Yaz_IR_Assoc : public Yaz_Z_Assoc {
...
more facilities for the Z39.50 server role.
</para>
<synopsis>
- #include <yaz++/z-server.h>
+ #include <yazpp/z-server.h>
class Yaz_Z_Server : public Yaz_Z_Server {
...
uses this class.
</para>
</section>
- <section id="Yaz_Proxy"><title>Yaz_Proxy</title>
- <para>
- This object is a specialization of
- <link linkend="Yaz_Z_Assoc">Yaz_Z_Assoc</link> and implements
- the YAZ proxy.
- </para>
- <synopsis>
- #include <yaz++/proxy.h>
-
- class Yaz_Proxy : public Yaz_Z_Server {
- ...
- };
- </synopsis>
- <para>
- The proxy server, <filename>yaz-proxy-main.cpp</filename>,
- uses this class.
- </para>
- </section>
</section>
</chapter>
<!-- Keep this comment at the end of the file
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
- sgml-parent-document: "yaz++.xml"
+ sgml-parent-document: "yazpp.xml"
sgml-local-catalogs: nil
sgml-namecase-general:t
End: