X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Fapi.xml;h=1d53b247b9a226846c168657c24a6b261717a341;hb=2a6ced8bd8ce528ca91107d862b544737a467f78;hp=5a593711b25abdd04b8964d5526d4105dfbfffa0;hpb=6237bfee0d4ae98813f4d52779eaf5b569d1f54f;p=yazpp-moved-to-github.git diff --git a/doc/api.xml b/doc/api.xml index 5a59371..1d53b24 100644 --- a/doc/api.xml +++ b/doc/api.xml @@ -3,7 +3,7 @@ YAZ C++ API 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. @@ -34,7 +34,7 @@ interface. - #include <yaz++/socket-observer.h> + #include <yazpp/socket-observer.h> class my_socketobservable : public IYazSocketObservable { // Add an observer interested in socket fd @@ -43,7 +43,7 @@ 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 @@ -52,14 +52,14 @@ }; -
IYazZSocketObserver +
IYazSocketObserver This interface is interested in socket events supporting the IYazSocketObservable interface. - #include <yaz++/socket-observer.h> + #include <yazpp/socket-observer.h> class my_socketobserver : public IYazSocketObserver { public: @@ -76,7 +76,7 @@ is notified. - #include <yaz++/pdu-observer.h> + #include <yazpp/pdu-observer.h> class my_pduobservable : public IYaz_PDU_Observable { public: @@ -104,7 +104,7 @@ IYaz_PDU_Observable. - #include <yaz++/pdu-observer.h> + #include <yazpp/pdu-observer.h> class my_pduobserver : public IYaz_PDU_Observer { public: @@ -127,7 +127,7 @@ Abstract query. - #include <yaz++/query.h> + #include <yazpp/query.h> class my_query : public Yaz_Query { public: // Print query in buffer described by str and len @@ -147,7 +147,7 @@ command line clients, etc. - #include <yaz++/socket-manager.h> + #include <yazpp/socket-manager.h> class Yaz_SocketManager : public IYazSocketObservable { public: @@ -179,7 +179,7 @@ that transmits BER encoded PDUs (or those offered by YAZ COMSTACK). - #include <yaz++/pdu-assoc.h> + #include <yazpp/pdu-assoc.h> class Yaz_PDU_Assoc : public IYaz_PDU_Observable, IYazSocketObserver { @@ -223,13 +223,13 @@ Z-Association. - #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); @@ -298,7 +298,7 @@ more facilities for the Z39.50 client role. - #include <yaz++/ir-assoc.h> + #include <yazpp/ir-assoc.h> class Yaz_IR_Assoc : public Yaz_Z_Assoc { ... @@ -316,7 +316,7 @@ more facilities for the Z39.50 server role. - #include <yaz++/z-server.h> + #include <yazpp/z-server.h> class Yaz_Z_Server : public Yaz_Z_Server { ... @@ -327,24 +327,6 @@ uses this class.
-
Yaz_Proxy - - This object is a specialization of - Yaz_Z_Assoc and implements - the YAZ proxy. - - - #include <yaz++/proxy.h> - - class Yaz_Proxy : public Yaz_Z_Server { - ... - }; - - - The proxy server, yaz-proxy-main.cpp, - uses this class. - -