class ZCLIENT_BASE : public ZSESSION

Basic Z39.50 Client Class

Inheritance:

Public Methods

GDT_BOOLEAN Add_Records (const STRING &Database, ZRECORDLIST *Records)
Request server to add new records to a database
GDT_BOOLEAN Delete_Records (const STRING &Database, ZRECORDLIST *Records)
Request server to delete records from a database
void GetDiagnosticList (STRLIST *MsgList)
Return Diagnostic Error List
void GetErrorMessage (STRING *Message)
Get the current error message
void GetGeneralMessage (STRING *Msg)
Return General Message
INT4 GetHitCount ()
Get Hit Count
INT GetLastError ()
Get Last Error
void GetMOTD (STRING *Msg)
Return Message of the Day
GDT_BOOLEAN Initialize ( const STRING &Host, const UINT Port, const STRING &RefId, const STRING &ProtVer, const STRING &Options, const INT4 PrefMsgSize, const INT4 ExceptionalRecSize, const STRING &GroupId, const STRING &UserId, const STRING &Password, const STRING &ImpId, const STRING &ImpName, const STRING &ImpVersion)
Initialize with Z39.50 Server
GDT_BOOLEAN Initialize ( const STRING &Host, const UINT Port, const STRING &GroupId, const STRING &UserId, const STRING &Password)
Initialize with Z39.50 Server
GDT_BOOLEAN Initialize ( const STRING &Host, const UINT Port)
GDT_BOOLEAN Initialize ( const STRING &Host, const UINT Port, STRING pass)
Initialize with Z39.50 Server
void MapError (INT Code, STRING *Message)
Convert Error Code to String
GDT_BOOLEAN Present ( const INT4 Start, const INT4 Count, const STRING &PreferredRecordSyntax, const STRING &ResultSetName, const STRING &ElementSetName, ZRECORDLIST *Records)
Request one or more records
virtual GDT_BOOLEAN Search (const STRING &Database, const STRING &Term, const STRING &ResultSetName, INT4 *HitCount, STRING UserId, INT Start, INT Fetch, ZRECORDLIST *Records)
Perform a Search
GDT_BOOLEAN Sort ( const STRING &InputResultSetNames, const STRING &SortedResultSetName, const STRING &SortSequence)
Issue a Z39.50 Sort Request
ZCLIENT_BASE ()
Basic Constructor
GDT_BOOLEAN ZCLIENT_BASE::Scan ( const CHR *DatabaseName, const CHR *Term, const INT PrefPos, const INT StepSize, const INT NumRequest, ZRECORDLIST *Records)
Perform a SCAN (EXPAND)
virtual ~ZCLIENT_BASE ()
Basic Destructor

Private Fields

STRLIST c_diaglist
c_element_set_name
INT c_error
c_error_msg
c_general_message
INT4 c_hitcount
c_host
c_motd
STRING c_postings
STRING c_query

Private Methods

void GetRecordsOrDiagnostics (BERBROWSER *b, ZRECORDLIST *Records)
void StoreDefaults (const STRING & Group)

Inherited from ZSESSION:

Public Methods

INT Close()
INT GetDebugLevel()
GDT_BOOLEAN GetOption(const INT Option)
void GetProtocolVersion(INT *Version)
void SetDebugLevel(INT Level)

Protected Classes

enum
SEARCH
PRESENT
DELSET
RESOURCEREPORT
TRIGGERRESOURCECTRL
RESOURCECTRL
ACCESSCTRL
SCAN
SORT
RESERVED
EXTENDEDSERVICES
LEVEL1SEG
LEVEL2SEG
CONCURRENTOPS
NAMEDRESULTSETS
enum
open
closed

Protected Fields

c_dbname
INT c_debuglevel
REGISTRY* c_defaults
c_group
c_inifile
c_maxrecordsize
c_options
UINT c_port
INT4 c_prefmsgsize
STRING c_protocol_version
c_refid
TCPSOCK* c_tcp
c_timeout

Protected Methods

void ClearOptions()
void LoadDefaultsFromCommandLine(int ac, char **argv, STRING & File, STRING & Group, STRING *LastGroup, STRING *LastFile)
void LoadDefaultsFromFile(const STRING & Filename, const STRING & Group)
void PrintConnectionDetails()
PUCHR ReadPDU(INT4 *len, unsigned short *type)
PUCHR ReadPresentPDU(INT4 *len, unsigned short *type)
INT4 SendPDU(PZPDU pdu)
INT4 SendPresentPDU(PZPDU pdu)
void SetExceptionalRecordSize(const INT4 Value)
void SetOption(const INT Option, const GDT_BOOLEAN Value)
void SetOptions(const STRING & Options)
void SetPreferredMessageSize(const INT4 Value)
void SetProtocolVersion(const STRING & Value)

Protected

enum
SEARCH
PRESENT
DELSET
RESOURCEREPORT
TRIGGERRESOURCECTRL
RESOURCECTRL
ACCESSCTRL
SCAN
SORT
RESERVED
EXTENDEDSERVICES
LEVEL1SEG
LEVEL2SEG
CONCURRENTOPS
NAMEDRESULTSETS
enum
open
closed

Documentation

Basic Z39.50 Client Class
void StoreDefaults(const STRING & Group)

void GetRecordsOrDiagnostics(BERBROWSER *b, ZRECORDLIST *Records)

STRING c_query

c_host

c_element_set_name

c_motd

c_general_message

c_error_msg

STRLIST c_diaglist

INT c_error

INT4 c_hitcount

STRING c_postings

ZCLIENT_BASE()
Basic Constructor

virtual ~ZCLIENT_BASE()
Basic Destructor

void MapError(INT Code, STRING *Message)
Convert Error Code to String

GDT_BOOLEAN Initialize( const STRING &Host, const UINT Port)

GDT_BOOLEAN Initialize( const STRING &Host, const UINT Port, STRING pass)
Initialize with Z39.50 Server

GDT_BOOLEAN Initialize( const STRING &Host, const UINT Port, const STRING &GroupId, const STRING &UserId, const STRING &Password)
Initialize with Z39.50 Server

GDT_BOOLEAN Initialize( const STRING &Host, const UINT Port, const STRING &RefId, const STRING &ProtVer, const STRING &Options, const INT4 PrefMsgSize, const INT4 ExceptionalRecSize, const STRING &GroupId, const STRING &UserId, const STRING &Password, const STRING &ImpId, const STRING &ImpName, const STRING &ImpVersion)
Initialize with Z39.50 Server

virtual GDT_BOOLEAN Search(const STRING &Database, const STRING &Term, const STRING &ResultSetName, INT4 *HitCount, STRING UserId, INT Start, INT Fetch, ZRECORDLIST *Records)
Perform a Search

GDT_BOOLEAN Present( const INT4 Start, const INT4 Count, const STRING &PreferredRecordSyntax, const STRING &ResultSetName, const STRING &ElementSetName, ZRECORDLIST *Records)
Request one or more records

void GetMOTD(STRING *Msg)
Return Message of the Day

void GetGeneralMessage(STRING *Msg)
Return General Message

void GetDiagnosticList(STRLIST *MsgList)
Return Diagnostic Error List

GDT_BOOLEAN ZCLIENT_BASE::Scan( const CHR *DatabaseName, const CHR *Term, const INT PrefPos, const INT StepSize, const INT NumRequest, ZRECORDLIST *Records)
Perform a SCAN (EXPAND)

GDT_BOOLEAN Sort( const STRING &InputResultSetNames, const STRING &SortedResultSetName, const STRING &SortSequence)
Issue a Z39.50 Sort Request

INT4 GetHitCount()
Get Hit Count

INT GetLastError()
Get Last Error

GDT_BOOLEAN Add_Records(const STRING &Database, ZRECORDLIST *Records)
Request server to add new records to a database

GDT_BOOLEAN Delete_Records(const STRING &Database, ZRECORDLIST *Records)
Request server to delete records from a database

void GetErrorMessage(STRING *Message)
Get the current error message

This class has no child classes.

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Z&oumlckler, Roland Wunderling
contact: doc++@zib.de