librets Namespace Reference

The main librets namespace. More...


Namespaces

namespace  DmqlExpression
namespace  util

Classes

class  AndCriterion
class  BinaryData
 A helper class that wraps binary data. More...
class  CapabilityUrls
 CapabilityUrls contains the API that allows access to the URLs sent in response to the RETS LOGIN transaction. More...
class  CurlEasy
 (Internal) CurlEasy is a class that provides an interface to the libcurl "easy" interface. More...
class  CurlHttpClient
 (Internal) CurlHttpClient is a class that wraps client side interaction with libcurl. More...
class  CurlHttpClientPrivate
 (Internal) CurlHttpClientPrivate is a class that wraps the three libRETS classes that make up a single request and response. More...
class  CurlHttpResponse
 (Internal) CurlHttpResponse is a class that wraps the response from libcurl. More...
class  CurlMulti
 (Internal) CurlMulti is a class that provides an interface to the libcurl "multi" interface. More...
class  CurlSlist
 (Internal) CurlSlist is a class that wraps the libcurl curl_slist type. More...
class  CurlStream
 (Internal) CurlStream inherits from std::stringstream and is used to support the librets "streaming" data feature. More...
class  DefaultMetadataCollector
 (Internal) DefaultMetadataCollector is a class that implements the default MetadataFinder/MetadataElementCollector. More...
class  DefaultMetadataElementFactory
 (Internal) DefaultMetadataElementFactory is the default implementation of XmlMetadataElementFactory. More...
class  DmqlCriterion
class  DmqlQuery
class  EqCriterion
class  ExceptionErrorHandler
 ExceptionErrorHandler is an implementation of RetsErrorHandler that throws an exception on error conditions. More...
class  ExpatXmlParser
 (Internal) ExpatXmlParser defines the primary controlling class for the Expat XML Parser. More...
class  FieldCriterion
class  GetObjectQuery
class  GetObjectRequest
 A GetObjectRequest represents the parameters needed to perform a RETS GetObject transaction. More...
class  GetObjectResponse
 A GetObjectResponse represents a response from a RETS GetObject transaction. More...
class  GtCriterion
class  IncrementalMetadataFinder
 (Internal) IncrementalMetadataFinder implements MetadataFinder and will locate metadata as needed. More...
class  JunctionCriterion
class  KeyValueResponse
 KeyValueResponse is a class that parses a stream in the form of key=value, saves and enables access to the results. More...
class  LiteralCriterion
class  LoginResponse
 LoginResponse contains the API that allows access to the information sent in response to a successful RETS LOGIN transaction. More...
class  LogoutResponse
 LogoutResponse contains the API that allows access to the information sent in response to a successful RETS LOGOUT transaction. More...
class  LookupColumnsQuery
class  LookupCriterion
class  LookupOrCriterion
class  LookupQuery
class  LtCriterion
class  MetadataClass
 MetadataClass is an implementation of MetadataElement that represents Class information for the metadata. More...
class  MetadataEditMask
 MetadataEditMask is an implementation of MetadataElement that represents Edit mask metadata. More...
class  MetadataElement
 MetadataElement is the fundamental class that represents an element of metadata. More...
class  MetadataElementIdEqual
 MetadataElementIdEqual is a class that determines whether or not the ID of two metadata elements are the same. More...
class  MetadataElementCollector
 (Internal) Contains the prototype for the MetadataElementCollector from which other classes inherit. More...
class  MetadataFinder
 (Internal) MetadataFinder defines the API by which other classes that implement the actual metadata finding process inherit. More...
class  MetadataForeignKey
 MetadataForeignKey is an implementation of MetadataElement that represents Foreign Key information for the metadata. More...
class  MetadataLoader
 (Internal) MetadataLoader defines the API that loads the metadata tree More...
class  MetadataLookup
 MetadataLookup is an implementation of MetadataElement that represents Lookup metadata. More...
class  MetadataLookupType
 MetadataLookupType is an implementation of MetadataElement that represents Lookup Type metadata. More...
class  MetadataObject
 MetadataObject is an implementation of MetadataElement that represents Object metadata. More...
class  MetadataResource
 MetadataResource is an implementation of MetadataElement that represents Resource metadata. More...
class  MetadataSearchHelp
 MetadataSearchHelp is an implementation of MetadataElement that represents Search help metadata. More...
class  MetadataSystem
 MetadataSystem is an implementation of MetadataElement that represents System metadata. More...
class  MetadataTable
 MetadataTable is an implementation of MetadataElement that represents Table metadata. More...
class  MetadataUpdate
 MetadataUpdate is an implementation of MetadataElement that represents Update metadata. More...
class  MetadataUpdateHelp
 MetadataUpdateHelp is an implementation of MetadataElement that represents Update Help metadata. More...
class  MetadataUpdateType
 MetadataUpdateType is an implementation of MetadataElement that represents Update Type metadata. More...
class  MetadataValidationExpression
 MetadataValidationExpression is an implementation of MetadataElement that represents Validation Expression metadata. More...
class  MetadataValidationExternal
 MetadataValidationExternal is an implementation of MetadataElement that represents Validation External metadata. More...
class  MetadataValidationExternalType
 MetadataValidationExternalType is an implementation of MetadataElement that represents Validation External Type metadata. More...
class  MetadataValidationLookup
 MetadataValidationLookup is an implementation of MetadataElement that represents Validation Lookup metadata. More...
class  MetadataValidationLookupType
 MetadataValidationLookupType is an implementation of MetadataElement that represents Validation Lookup Type metadata. More...
class  NotCriterion
class  ObjectDescriptor
 An ObjectDescriptor represents a single object retrieved from a GetObject transaction. More...
class  OrCriterion
class  RetsAST
 Custom AST class that adds line and column numbers to the AST nodes. More...
class  RetsErrorHandler
 RetsErrorHandler is an error handling interface that can be used by users to set error handling policy. More...
class  NullErrorHandler
 An implementation of RetsErrorHandler that just silently ignores all errors. More...
class  RetsException
 RetsException is the base class for all libRETS exceptions. More...
class  RetsExceptionContext
 RetsExceptionContext implements the exception handling context for the library. More...
class  RetsHttpClient
 (Internal) RetsHttpClient is the super class defining the activities that a client may perform. More...
class  RetsHttpException
 RetsHttpException is an implementation of RetsException that is thrown when an Http transport error is seen. More...
class  RetsHttpLogger
 (Internal) RetsHttpLogger is the super class that defines those operations that can be logged by libcurl when the verbose option is enabled. More...
class  NullHttpLogger
 NullHttpLogger is a Null RetsHttpLogger class that is used with libcurl when no logging is desired. More...
class  RetsHttpRequest
 (Internal) RetsHttpRequest is a class that defines the http client requests that can be made through libcurl. More...
class  RetsHttpResponse
 (Internal) RetsHttpResponse is the super class that defines those operations to be returned as the result of an http transaction by libcurl. More...
class  RetsMetadata
 RetsMetadata contains the API that is the main interface to all of the metadata. More...
class  RetsObject
 RetsObject is the base class for libRETS. More...
class  RetsReplyException
 RetsReplyException is an implementation of RetsException that is thrown when the RETS REPLY-CODE is non-zero. More...
class  RetsSession
 RetsSession contains the API that is the main controlling interface to the RETS server. More...
class  RetsSqlException
 RetsSqlException is an implementation of RetsException that is thrown for errors in the Sql to Dmql parser. More...
class  RetsUnknownMetadataException
 RetsReplyException is an implementation of RetsException that is thrown when the RETS REPLY-CODE is non-zero. More...
class  RetsXmlAttribute
 (Internal) RetsXmlAttribute is a class that contains an XML attribute and value. More...
class  RetsXmlEndDocumentEvent
 (Internal) RetsXmlEndDocumentEvent is a class that handles the Expat "end document" XML event. More...
class  RetsXmlEndElementEvent
 (Internal) RetsXmlEndElementEvent is a class that handles the Expat "end" element XML event. More...
class  RetsXmlEvent
 (Internal) RetsXmlEvent is the super class from which the other Xml parsing classes inherit. More...
class  RetsXmlParser
 (Internal) RetsXmlParser is the primary XML Parser class for use with libexpat. More...
class  RetsXmlStartElementEvent
 (Internal) RetsXmlStartElementEvent is a class that handles the Expat "start" element XML event. More...
class  RetsXmlTextEvent
 (Internal) RetsXmlTextEvent is a class that handles the Expat "end" element XML event. More...
class  SearchRequest
 SearchRequest contains the API that is used to set up and customer a RETS SEARCH transaciton. More...
class  SearchResultSet
 SearchResultSet contains the API that is used to handle the response to the RETS SEARCH transaciton. More...
class  ServerInformationRequest
 ServerInformationRequest is the API that allows access to the RETS 1.7 SERVERINFORMATION transaction. More...
class  ServerInformationResponse
 ServerInformationResponse is the API that allows access to the RETS 1.7 SERVERINFORMATION transaction results. More...
class  SqlMetadata
class  SqlToDmqlCompiler
class  str_stream
class  StreamHttpLogger
 (Internal) StreamHttpLogger defines the interface to be used with libcurl for logging operations. More...
class  UpdateRequest
 UpdateRequest contains the API that is used to set up and customer a RETS UPDATE transaciton. More...
class  UpdateResponse
 SearchResultSet contains the API that is used to handle the response to the RETS SEARCH transaciton. More...
class  Uri
class  UserAgentAuthCalculator
 (Internal) UserAgentAuthCalculator is an internal support class used during the calculation of User Agent Authentication value. More...
class  XmlMetadataElementFactory
 (Internal) Contains the prototype for the XmlMetadataElementFactory from which other classes inherit. More...
class  XmlMetadataParser
 (Internal) XmlMetadataParser is the primary class for parsing metadata. More...

Typedefs

typedef std::auto_ptr< BinaryDataBinaryDataAPtr
typedef boost::shared_ptr
< std::stringstream > 
stringstreamPtr
typedef boost::shared_ptr
< RetsHttpClient
RetsHttpClientPtr
 Smart pointer to RetsHttpClient.
typedef boost::shared_ptr
< RetsHttpRequest
RetsHttpRequestPtr
 Smart pointer to RetsHttpRequest.
typedef boost::shared_ptr
< RetsHttpResponse
RetsHttpResponsePtr
 Smart pointer to RetsHttpResponse.
typedef boost::shared_ptr
< RetsHttpLogger
RetsHttpLoggerPtr
 Smart pointer to RetsHttpLogger.
typedef boost::shared_ptr
< CurlEasy
CurlEasyPtr
 Smart pointer to CurlEasy.
typedef std::vector< CurlEasyPtrCurlEasyVector
 A vector of CurlEasy objects.
typedef boost::shared_ptr
< CurlEasyVector
CurlEasyVectorPtr
 Smart pointer to CurlEasyVector.
typedef boost::shared_ptr
< CurlHttpClient
CurlHttpClientPtr
 Smart pointer to CurlHttpClient.
typedef boost::shared_ptr
< CurlHttpRequest > 
CurlHttpRequestPtr
 Smart pointer to CurlHttpRequest.
typedef boost::shared_ptr
< CurlHttpResponse
CurlHttpResponsePtr
 Smart pointer to CurlHttpResponse.
typedef boost::shared_ptr
< RetsMetadata
RetsMetadataPtr
 Smart pointer to RetsMetadata.
typedef boost::shared_ptr
< MetadataElement
MetadataElementPtr
 Smart pointer to MetadataElement.
typedef boost::shared_ptr
< MetadataSystem
MetadataSystemPtr
 Smart pointer to MetadataSystem.
typedef boost::shared_ptr
< MetadataResource
MetadataResourcePtr
 Smart pointer to MetadataResource.
typedef boost::shared_ptr
< MetadataClass
MetadataClassPtr
 Smart pointer to MetadataClass.
typedef boost::shared_ptr
< MetadataTable
MetadataTablePtr
 Smart pointer to MetadataTable.
typedef boost::shared_ptr
< MetadataUpdate
MetadataUpdatePtr
 Smart pointer to MetadataUpdate.
typedef boost::shared_ptr
< MetadataUpdateType
MetadataUpdateTypePtr
 Smart pointer to MetadataUpdateType.
typedef boost::shared_ptr
< MetadataObject
MetadataObjectPtr
 Smart pointer to MetadataObject.
typedef boost::shared_ptr
< MetadataSearchHelp
MetadataSearchHelpPtr
 Smart pointer to MetadataSearchHelp.
typedef boost::shared_ptr
< MetadataEditMask
MetadataEditMaskPtr
 Smart pointer to MetadataEditMask.
typedef boost::shared_ptr
< MetadataLookup
MetadataLookupPtr
 Smart pointer to MetadataLookup.
typedef boost::shared_ptr
< MetadataLookupType
MetadataLookupTypePtr
 Smart pointer to MetadataLookupType.
typedef boost::shared_ptr
< MetadataUpdateHelp
MetadataUpdateHelpPtr
 Smart pointer to MetadataUpdateHelp.
typedef boost::shared_ptr
< MetadataValidationLookup
MetadataValidationLookupPtr
 Smart pointer to MetadataValidationLookup.
typedef boost::shared_ptr
< MetadataValidationLookupType
MetadataValidationLookupTypePtr
 Smart pointer to MetadataValidationLookupType.
typedef boost::shared_ptr
< MetadataValidationExternal
MetadataValidationExternalPtr
 Smart pointer to MetadataValidationExternal.
typedef boost::shared_ptr
< MetadataValidationExternalType
MetadataValidationExternalTypePtr
 Smart pointer to MetadataValidationExternalType.
typedef boost::shared_ptr
< MetadataValidationExpression
MetadataValidationExpressionPtr
 Smart pointer to MetadataValidationExpression.
typedef boost::shared_ptr
< MetadataForeignKey
MetadataForeignKeyPtr
 Smart pointer to MetadataForeignKey.
typedef boost::shared_ptr
< MetadataElementCollector
MetadataElementCollectorPtr
 Smart pointer to MetadataElementCollector.
typedef boost::shared_ptr
< MetadataLoader
MetadataLoaderPtr
 Smart pointer to MetadataLoader.
typedef boost::shared_ptr
< MetadataFinder
MetadataFinderPtr
 Smart pointer to MetadataFinder.
typedef boost::shared_ptr
< IncrementalMetadataFinder
IncrementalMetadataFinderPtr
 Smart pointer to IncrementalMetadataFinder.
typedef boost::shared_ptr
< XmlMetadataParser
XmlMetadataParserPtr
 Smart pointer to XmlMetadataParser.
typedef boost::shared_ptr
< XmlMetadataElementFactory
XmlMetadataElementFactoryPtr
 Smart pointer to XmlMetadataElementFactory.
typedef boost::shared_ptr
< DefaultMetadataElementFactory
DefaultMetadataElementFactoryPtr
 Smart pointer to DefaultMetadataElementFactory.
typedef boost::shared_ptr
< DefaultMetadataCollector
DefaultMetadataCollectorPtr
 Smart pointer to DefaultMetadataCollector.
typedef std::vector
< MetadataElementPtr
MetadataElementList
 A vector of MetadataElement objects.
typedef boost::shared_ptr
< MetadataElementList
MetadataElementListPtr
 A smart pointer to MetadataElementList.
typedef std::vector
< MetadataValidationExternalTypePtr
MetadataValidationExternalTypeList
 A vector of MetadataValidationExternal objects.
typedef boost::shared_ptr
< MetadataValidationExternalTypeList
MetadataValidationExternalTypeListPtr
 A smart pointer to MetadataValidationExternalTypeList.
typedef std::vector
< MetadataValidationLookupTypePtr
MetadataValidationLookupTypeList
 A vector of MetadataValidationLookupType objects.
typedef boost::shared_ptr
< MetadataValidationLookupTypeList
MetadataValidationLookupTypeListPtr
 A smart pointer to MetadataValidationLookupTypeList.
typedef boost::shared_ptr
< RetsSession
RetsSessionPtr
 Smart pointer to RetsSession.
typedef boost::shared_ptr
< LoginResponse
LoginResponsePtr
 Smart pointer to LoginResponse.
typedef std::auto_ptr
< LoginResponse
LoginResponseAPtr
typedef boost::shared_ptr
< CapabilityUrls
CapabilityUrlsPtr
 Smart pointer to CapabilityUrls.
typedef std::auto_ptr
< CapabilityUrls
CapabilityUrlsAPtr
typedef boost::shared_ptr
< SearchRequest
SearchRequestPtr
 Smart pointer to SearchRequest.
typedef std::auto_ptr
< SearchRequest
SearchRequestAPtr
typedef boost::shared_ptr
< SearchResultSet
SearchResultSetPtr
 Smart pointer to SearchResultSet.
typedef std::auto_ptr
< SearchResultSet
SearchResultSetAPtr
typedef boost::shared_ptr
< GetObjectRequest
GetObjectRequestPtr
 Smart pointer to GetObjectRequest.
typedef std::auto_ptr
< GetObjectRequest
GetObjectRequestAPtr
typedef boost::shared_ptr
< ObjectDescriptor
ObjectDescriptorPtr
 Smart pointer to ObjectDescriptor.
typedef std::auto_ptr
< ObjectDescriptor
ObjectDescriptorAPtr
typedef boost::shared_ptr
< GetObjectResponse
GetObjectResponsePtr
 Smart pointer to GetObjectResponse.
typedef std::auto_ptr
< GetObjectResponse
GetObjectResponseAPtr
typedef boost::shared_ptr
< LogoutResponse
LogoutResponsePtr
 Smart pointer to LogoutResponse.
typedef std::auto_ptr
< LogoutResponse
LogoutResponseAPtr
typedef boost::shared_ptr
< ServerInformationRequest
ServerInformationRequestPtr
 Smart pointer to ServerInformationRequest.
typedef std::auto_ptr
< ServerInformationRequest
ServerInformationRequestAPtr
typedef boost::shared_ptr
< ServerInformationResponse
ServerInformationResponsePtr
 Smart pointer to ServerInformationResponse.
typedef std::auto_ptr
< ServerInformationResponse
ServerInformationResponseAPtr
typedef boost::shared_ptr
< UpdateRequest
UpdateRequestPtr
 Smart pointer to UpdateRequest.
typedef std::auto_ptr
< UpdateRequest
UpdateRequestAPtr
typedef boost::shared_ptr
< UpdateResponse
UpdateResponsePtr
 Smart pointer to UpdateResponse.
typedef std::auto_ptr
< UpdateResponse
UpdateResponseAPtr
typedef antlr::ASTRefCount
< RetsAST
RefRetsAST
typedef std::map< std::string,
std::string > 
StringMap
 A key/value map using strings.
typedef std::vector
< MetadataResource * > 
MetadataResourceList
 A vector of MetadataResource objects.
typedef boost::shared_ptr
< MetadataResourceList
MetadataResourceListPtr
 A smart pointer to MetadataResourceList.
typedef std::vector
< MetadataClass * > 
MetadataClassList
 A vector of MetadataClass objects.
typedef boost::shared_ptr
< MetadataClassList
MetadataClassListPtr
 A smart pointer to MetadataClassList.
typedef std::vector
< MetadataTable * > 
MetadataTableList
 A vector of MetadataTables objects.
typedef boost::shared_ptr
< MetadataTableList
MetadataTableListPtr
 A smart pointer to MetadataTableList.
typedef std::vector
< MetadataLookup * > 
MetadataLookupList
 A vector of MetadataLookup objects.
typedef std::vector
< MetadataLookupType * > 
MetadataLookupTypeList
 A vector of MetadataLookupType objects.
typedef std::vector
< MetadataObject * > 
MetadataObjectList
 A vector of MetadataObject objects.
typedef std::vector
< MetadataForeignKey * > 
MetadataForeignKeyList
 A vector of MetadataForeignKeys objects.
typedef boost::shared_ptr
< MetadataForeignKeyList
MetadataForeignKeyListPtr
 A smart pointer to MetadataForeignKeyList.
typedef boost::shared_ptr
< RetsObject
RetsObjectPtr
 Smart pointer to RetsObject.
typedef std::vector
< RetsXmlAttributePtr
RetsXmlAttributeList
typedef boost::shared_ptr
< RetsXmlAttributeList
RetsXmlAttributeListPtr
typedef boost::shared_ptr
< DmqlCriterion
DmqlCriterionPtr
 Smart pointer to DmqlCriterion.
typedef boost::shared_ptr
< JunctionCriterion
JunctionCriterionPtr
 Smart pointer to JunctionCriterion.
typedef boost::shared_ptr
< LookupCriterion
LookupCriterionPtr
 Smart pointer to LookupCriterion.
typedef boost::shared_ptr
< LiteralCriterion
LiteralCriterionPtr
 Smart pointer to LiteralCriterion.
typedef boost::shared_ptr
< EqCriterion
EqCriterionPtr
 Smart pointer to EqCriterion.
typedef boost::shared_ptr
< GtCriterion
GtCriterionPtr
 Smart pointer to GtCriterion.
typedef boost::shared_ptr
< LtCriterion
LtCriterionPtr
 Smart pointer to LtCriterion.
typedef boost::shared_ptr
< OrCriterion
OrCriterionPtr
 Smart pointer to OnCriterion.
typedef boost::shared_ptr
< AndCriterion
AndCriterionPtr
 Smart pointer to AndCriterion.
typedef boost::shared_ptr
< NotCriterion
NotCriterionPtr
 Smart pointer to NotCriterion.
typedef boost::shared_ptr
< LookupOrCriterion
LookupOrCriterionPtr
 Smart pointer to LookupOrCriterion.
typedef boost::shared_ptr
< DmqlQuery
DmqlQueryPtr
 Smart pointer to DmqlQuery.
typedef boost::shared_ptr
< GetObjectQuery
GetObjectQueryPtr
 Smart pointer to GetObjectQuery.
typedef boost::shared_ptr
< LookupQuery
LookupQueryPtr
 Smart pointer to LookupQuery.
typedef boost::shared_ptr
< LookupColumnsQuery
LookupColumnsQueryPtr
 Smart pointer to LookupColumnsQuery.
typedef boost::shared_ptr
< SqlToDmqlCompiler
SqlToDmqlCompilerPtr
 Smart pointer to SqlToDmqlCompiler.
typedef boost::shared_ptr
< SqlMetadata
SqlMetadataPtr
 Smart pointer to SqlMetadata.
typedef boost::shared_ptr
< std::istream > 
istreamPtr
 A smart pointer to a standard input stream.
typedef boost::shared_ptr
< std::ostream > 
ostreamPtr
 A smart pointer to a standard output stream.
typedef boost::shared_ptr
< std::iostream > 
iostreamPtr
 A smart pointer to a standard input/output stream.
typedef boost::shared_ptr
< std::ofstream > 
ofstreamPtr
 A smart pointer to an output stream wrapped around a file.
typedef std::auto_ptr
< std::istream > 
istreamAPtr
 An auto_ptr to a standard input stream.
typedef std::auto_ptr
< std::ostream > 
ostreamAPtr
 An auto_ptr to a standard output stream.
typedef std::auto_ptr
< std::iostream > 
iostreamAPtr
 An auto_ptr to a standard input/output stream.
typedef std::vector< std::string > StringVector
 A vector of strings.
typedef boost::shared_ptr
< StringVector
StringVectorPtr
 A smart pointer to a vector of strings.
typedef std::vector< int > IntVector
 A vector of integers.
typedef boost::shared_ptr
< IntVector
IntVectorPtr
 A smart pointer to a vector of integers.
typedef boost::shared_ptr
< RetsXmlParser
RetsXmlParserPtr
 Smart pointer to RetsXmlParser.
typedef boost::shared_ptr
< RetsXmlEvent
RetsXmlEventPtr
 Smart pointer to RetsXmlEvent.
typedef boost::shared_ptr
< RetsXmlAttribute
RetsXmlAttributePtr
 Smart pointer to RetsXmlAttribute.
typedef boost::shared_ptr
< RetsXmlStartElementEvent
RetsXmlStartElementEventPtr
 Smart pointer to RetsXmlStartElementEvent.
typedef boost::shared_ptr
< RetsXmlEndElementEvent
RetsXmlEndElementEventPtr
 Smart pointer to RetsXmlEndEvent.
typedef boost::shared_ptr
< RetsXmlTextEvent
RetsXmlTextEventPtr
 Smart pointer to RetsXmlTextEvent.
typedef boost::shared_ptr
< RetsXmlEndDocumentEvent
RetsXmlEndDocumentEventPtr
 Smart pointer to RetsXmlEndDocumentEvent.
typedef std::vector
< RetsXmlEventPtr
RetsXmlEventList
 A vector of RetsXmlEvent objects.
typedef boost::shared_ptr
< RetsXmlEventList
RetsXmlEventListPtr
 A smart pointer to RetsXmlEventList.
typedef boost::shared_ptr
< ExpatXmlParser
ExpatXmlParserPtr
 Smart pointer to ExpatXmlParser.

Enumerations

enum  EncodingType { RETS_XML_DEFAULT_ENCODING, RETS_XML_ISO_ENCODING, RETS_XML_UTF8_ENCODING }
 EncodingType contains the definitions of which type of parsing the XML parser will perform. More...
enum  RetsVersion { RETS_1_0, RETS_1_5, RETS_1_7, RETS_1_7_2 }
 RetsVersion contains the definitions of types the various protocol versions of RETS servers. More...
enum  UserAgentAuthType { USER_AGENT_AUTH_RETS_1_7, USER_AGENT_AUTH_INTEREALTY }

Functions

std::ostream & operator<< (std::ostream &s, const RetsObject &retsObject)
std::ostream & operator<< (std::ostream &s, RetsObject *retsObject)
bool operator== (const RetsObject &lhs, const RetsObject &rhs)
bool operator!= (const RetsObject &lhs, const RetsObject &rhs)
template<class type >
const str_streamoperator<< (const str_stream &out, const type &value)


Detailed Description

The main librets namespace.

See RetsSession.


Typedef Documentation

typedef boost::shared_ptr<AndCriterion> AndCriterionPtr

Smart pointer to AndCriterion.

typedef std::auto_ptr<BinaryData> BinaryDataAPtr

typedef std::auto_ptr<CapabilityUrls> CapabilityUrlsAPtr

typedef boost::shared_ptr<CapabilityUrls> CapabilityUrlsPtr

Smart pointer to CapabilityUrls.

typedef boost::shared_ptr<CurlEasy> CurlEasyPtr

Smart pointer to CurlEasy.

typedef std::vector<CurlEasyPtr> CurlEasyVector

A vector of CurlEasy objects.

typedef boost::shared_ptr<CurlEasyVector> CurlEasyVectorPtr

Smart pointer to CurlEasyVector.

typedef boost::shared_ptr<CurlHttpClient> CurlHttpClientPtr

Smart pointer to CurlHttpClient.

typedef boost::shared_ptr<CurlHttpRequest> CurlHttpRequestPtr

Smart pointer to CurlHttpRequest.

typedef boost::shared_ptr<CurlHttpResponse> CurlHttpResponsePtr

Smart pointer to CurlHttpResponse.

Smart pointer to DefaultMetadataCollector.

Smart pointer to DefaultMetadataElementFactory.

typedef boost::shared_ptr<DmqlCriterion> DmqlCriterionPtr

Smart pointer to DmqlCriterion.

typedef boost::shared_ptr<DmqlQuery> DmqlQueryPtr

Smart pointer to DmqlQuery.

typedef boost::shared_ptr<EqCriterion> EqCriterionPtr

Smart pointer to EqCriterion.

typedef boost::shared_ptr<ExpatXmlParser> ExpatXmlParserPtr

Smart pointer to ExpatXmlParser.

typedef boost::shared_ptr<GetObjectQuery> GetObjectQueryPtr

Smart pointer to GetObjectQuery.

typedef std::auto_ptr<GetObjectRequest> GetObjectRequestAPtr

typedef boost::shared_ptr<GetObjectRequest> GetObjectRequestPtr

Smart pointer to GetObjectRequest.

typedef std::auto_ptr<GetObjectResponse> GetObjectResponseAPtr

typedef boost::shared_ptr<GetObjectResponse> GetObjectResponsePtr

Smart pointer to GetObjectResponse.

typedef boost::shared_ptr<GtCriterion> GtCriterionPtr

Smart pointer to GtCriterion.

Smart pointer to IncrementalMetadataFinder.

typedef std::vector<int> IntVector

A vector of integers.

typedef boost::shared_ptr<IntVector> IntVectorPtr

A smart pointer to a vector of integers.

typedef std::auto_ptr<std::iostream> iostreamAPtr

An auto_ptr to a standard input/output stream.

typedef boost::shared_ptr<std::iostream> iostreamPtr

A smart pointer to a standard input/output stream.

typedef std::auto_ptr<std::istream> istreamAPtr

An auto_ptr to a standard input stream.

typedef boost::shared_ptr<std::istream> istreamPtr

A smart pointer to a standard input stream.

typedef boost::shared_ptr<JunctionCriterion> JunctionCriterionPtr

Smart pointer to JunctionCriterion.

typedef boost::shared_ptr<LiteralCriterion> LiteralCriterionPtr

Smart pointer to LiteralCriterion.

typedef std::auto_ptr<LoginResponse> LoginResponseAPtr

typedef boost::shared_ptr<LoginResponse> LoginResponsePtr

Smart pointer to LoginResponse.

typedef std::auto_ptr<LogoutResponse> LogoutResponseAPtr

typedef boost::shared_ptr<LogoutResponse> LogoutResponsePtr

Smart pointer to LogoutResponse.

typedef boost::shared_ptr<LookupColumnsQuery> LookupColumnsQueryPtr

Smart pointer to LookupColumnsQuery.

typedef boost::shared_ptr<LookupCriterion> LookupCriterionPtr

Smart pointer to LookupCriterion.

typedef boost::shared_ptr<LookupOrCriterion> LookupOrCriterionPtr

Smart pointer to LookupOrCriterion.

typedef boost::shared_ptr<LookupQuery> LookupQueryPtr

Smart pointer to LookupQuery.

typedef boost::shared_ptr<LtCriterion> LtCriterionPtr

Smart pointer to LtCriterion.

typedef std::vector<MetadataClass *> MetadataClassList

A vector of MetadataClass objects.

typedef boost::shared_ptr<MetadataClassList> MetadataClassListPtr

A smart pointer to MetadataClassList.

typedef boost::shared_ptr<MetadataClass> MetadataClassPtr

Smart pointer to MetadataClass.

typedef boost::shared_ptr<MetadataEditMask> MetadataEditMaskPtr

Smart pointer to MetadataEditMask.

Smart pointer to MetadataElementCollector.

A vector of MetadataElement objects.

typedef boost::shared_ptr<MetadataElementList> MetadataElementListPtr

A smart pointer to MetadataElementList.

typedef boost::shared_ptr<MetadataElement> MetadataElementPtr

Smart pointer to MetadataElement.

typedef boost::shared_ptr<MetadataFinder> MetadataFinderPtr

Smart pointer to MetadataFinder.

A vector of MetadataForeignKeys objects.

A smart pointer to MetadataForeignKeyList.

typedef boost::shared_ptr<MetadataForeignKey> MetadataForeignKeyPtr

Smart pointer to MetadataForeignKey.

typedef boost::shared_ptr<MetadataLoader> MetadataLoaderPtr

Smart pointer to MetadataLoader.

typedef std::vector<MetadataLookup *> MetadataLookupList

A vector of MetadataLookup objects.

typedef boost::shared_ptr<MetadataLookup> MetadataLookupPtr

Smart pointer to MetadataLookup.

A vector of MetadataLookupType objects.

typedef boost::shared_ptr<MetadataLookupType> MetadataLookupTypePtr

Smart pointer to MetadataLookupType.

typedef std::vector<MetadataObject *> MetadataObjectList

A vector of MetadataObject objects.

typedef boost::shared_ptr<MetadataObject> MetadataObjectPtr

Smart pointer to MetadataObject.

typedef std::vector<MetadataResource *> MetadataResourceList

A vector of MetadataResource objects.

typedef boost::shared_ptr<MetadataResourceList> MetadataResourceListPtr

A smart pointer to MetadataResourceList.

typedef boost::shared_ptr<MetadataResource> MetadataResourcePtr

Smart pointer to MetadataResource.

typedef boost::shared_ptr<MetadataSearchHelp> MetadataSearchHelpPtr

Smart pointer to MetadataSearchHelp.

typedef boost::shared_ptr<MetadataSystem> MetadataSystemPtr

Smart pointer to MetadataSystem.

typedef std::vector<MetadataTable *> MetadataTableList

A vector of MetadataTables objects.

typedef boost::shared_ptr<MetadataTableList> MetadataTableListPtr

A smart pointer to MetadataTableList.

typedef boost::shared_ptr<MetadataTable> MetadataTablePtr

Smart pointer to MetadataTable.

typedef boost::shared_ptr<MetadataUpdateHelp> MetadataUpdateHelpPtr

Smart pointer to MetadataUpdateHelp.

typedef boost::shared_ptr<MetadataUpdate> MetadataUpdatePtr

Smart pointer to MetadataUpdate.

typedef boost::shared_ptr<MetadataUpdateType> MetadataUpdateTypePtr

Smart pointer to MetadataUpdateType.

Smart pointer to MetadataValidationExpression.

Smart pointer to MetadataValidationExternal.

A vector of MetadataValidationExternal objects.

A smart pointer to MetadataValidationExternalTypeList.

Smart pointer to MetadataValidationExternalType.

Smart pointer to MetadataValidationLookup.

A vector of MetadataValidationLookupType objects.

A smart pointer to MetadataValidationLookupTypeList.

Smart pointer to MetadataValidationLookupType.

typedef boost::shared_ptr<NotCriterion> NotCriterionPtr

Smart pointer to NotCriterion.

typedef std::auto_ptr<ObjectDescriptor> ObjectDescriptorAPtr

typedef boost::shared_ptr<ObjectDescriptor> ObjectDescriptorPtr

Smart pointer to ObjectDescriptor.

typedef boost::shared_ptr<std::ofstream> ofstreamPtr

A smart pointer to an output stream wrapped around a file.

typedef boost::shared_ptr<OrCriterion> OrCriterionPtr

Smart pointer to OnCriterion.

typedef std::auto_ptr<std::ostream> ostreamAPtr

An auto_ptr to a standard output stream.

typedef boost::shared_ptr<std::ostream> ostreamPtr

A smart pointer to a standard output stream.

typedef antlr::ASTRefCount<RetsAST> RefRetsAST

typedef boost::shared_ptr<RetsHttpClient> RetsHttpClientPtr

Smart pointer to RetsHttpClient.

typedef boost::shared_ptr<RetsHttpLogger> RetsHttpLoggerPtr

Smart pointer to RetsHttpLogger.

typedef boost::shared_ptr<RetsHttpRequest> RetsHttpRequestPtr

Smart pointer to RetsHttpRequest.

typedef boost::shared_ptr<RetsHttpResponse> RetsHttpResponsePtr

Smart pointer to RetsHttpResponse.

typedef boost::shared_ptr<RetsMetadata> RetsMetadataPtr

Smart pointer to RetsMetadata.

typedef boost::shared_ptr<RetsObject> RetsObjectPtr

Smart pointer to RetsObject.

typedef boost::shared_ptr<RetsSession> RetsSessionPtr

Smart pointer to RetsSession.

typedef boost::shared_ptr<RetsXmlAttributeList> RetsXmlAttributeListPtr

typedef boost::shared_ptr<RetsXmlAttribute> RetsXmlAttributePtr

Smart pointer to RetsXmlAttribute.

Smart pointer to RetsXmlEndDocumentEvent.

Smart pointer to RetsXmlEndEvent.

typedef std::vector<RetsXmlEventPtr> RetsXmlEventList

A vector of RetsXmlEvent objects.

typedef boost::shared_ptr<RetsXmlEventList> RetsXmlEventListPtr

A smart pointer to RetsXmlEventList.

typedef boost::shared_ptr<RetsXmlEvent> RetsXmlEventPtr

Smart pointer to RetsXmlEvent.

typedef boost::shared_ptr<RetsXmlParser> RetsXmlParserPtr

Smart pointer to RetsXmlParser.

Smart pointer to RetsXmlStartElementEvent.

typedef boost::shared_ptr<RetsXmlTextEvent> RetsXmlTextEventPtr

Smart pointer to RetsXmlTextEvent.

typedef std::auto_ptr<SearchRequest> SearchRequestAPtr

typedef boost::shared_ptr<SearchRequest> SearchRequestPtr

Smart pointer to SearchRequest.

typedef std::auto_ptr<SearchResultSet> SearchResultSetAPtr

typedef boost::shared_ptr<SearchResultSet> SearchResultSetPtr

Smart pointer to SearchResultSet.

Smart pointer to ServerInformationRequest.

Smart pointer to ServerInformationResponse.

typedef boost::shared_ptr<SqlMetadata> SqlMetadataPtr

Smart pointer to SqlMetadata.

typedef boost::shared_ptr<SqlToDmqlCompiler> SqlToDmqlCompilerPtr

Smart pointer to SqlToDmqlCompiler.

typedef std::map< std::string, std::string > StringMap

A key/value map using strings.

typedef boost::shared_ptr<std::stringstream> stringstreamPtr

typedef std::vector<std::string> StringVector

A vector of strings.

typedef boost::shared_ptr<StringVector> StringVectorPtr

A smart pointer to a vector of strings.

typedef std::auto_ptr<UpdateRequest> UpdateRequestAPtr

typedef boost::shared_ptr<UpdateRequest> UpdateRequestPtr

Smart pointer to UpdateRequest.

typedef std::auto_ptr<UpdateResponse> UpdateResponseAPtr

typedef boost::shared_ptr<UpdateResponse> UpdateResponsePtr

Smart pointer to UpdateResponse.

Smart pointer to XmlMetadataElementFactory.

typedef boost::shared_ptr<XmlMetadataParser> XmlMetadataParserPtr

Smart pointer to XmlMetadataParser.


Enumeration Type Documentation

EncodingType contains the definitions of which type of parsing the XML parser will perform.

Note that the RETS standard is supposed to be US-ASCII, but there are non-compliant servers that provide data with ISO or UNICODE values that will cause the XML parsing to fail. In those instances, use RETS_XML_ISO_ENCODING or RETS_XML_UTF8_ENCODING to tell the parser to handle those characters.

Enumerator:
RETS_XML_DEFAULT_ENCODING  The data is only encoded as US-ASCII.
RETS_XML_ISO_ENCODING  The data may contain extended characters.
RETS_XML_UTF8_ENCODING  The data may contain characters in UTF-8 encoding.

RetsVersion contains the definitions of types the various protocol versions of RETS servers.

Enumerator:
RETS_1_0  This is a RETS 1.0 server.
RETS_1_5  This is a RETS 1.5 server.
RETS_1_7  This is a RETS 1.7 server.
RETS_1_7_2  This is a RETS 1.7.2 server.

Enumerator:
USER_AGENT_AUTH_RETS_1_7  RETS 1.7 user agent authorization.
USER_AGENT_AUTH_INTEREALTY  The Interealty variant of 1.7 user agent authorization.


Function Documentation

bool librets::operator!= ( const RetsObject &  lhs,
const RetsObject &  rhs 
)

const str_stream& librets::operator<< ( const str_stream &  out,
const type &  value 
) [inline]

std::ostream& librets::operator<< ( std::ostream &  s,
RetsObject *  retsObject 
)

std::ostream& librets::operator<< ( std::ostream &  s,
const RetsObject &  retsObject 
)

bool librets::operator== ( const RetsObject &  lhs,
const RetsObject &  rhs 
)


Generated by  doxygen