HCE::sphinx::SphinxFunctionalObject Class Reference

#include <SphinxFunctionalObject.hpp>

Inheritance diagram for HCE::sphinx::SphinxFunctionalObject:

Collaboration diagram for HCE::sphinx::SphinxFunctionalObject:

Public Member Functions
	SphinxFunctionalObject (const std::string &nodeName_="", const std::string &homeDir_=sphinx_search_const::defaultHomeDir, const std::string &indexName_="", bool startSearchd_=false, bool stopSearchd_=false)
	SphinxFunctionalObject (const std::string &nodeName_, unsigned int nodeNumber, const std::string &homeDir_=sphinx_search_const::defaultHomeDir, const std::string &indexName_="", bool startSearchd_=false, bool stopSearchd_=false)
virtual	~SphinxFunctionalObject (void)
bool	loadConfiguration (const std::string &indexName)
std::string	Process (const std::string &json)
SphinxOutputJsonMessage	Process (SphinxInputJsonMessage &inputJsonMessage)
void	resizeResultData (size_t matchesCount, size_t attributesCount)
bool	isLoadedConfig (void) const
bool	easyStart (void)
bool	startSearchd (void)
bool	stopSearchd (void)
bool	isActiveSearchd (void)
bool	isConnected (void) const
bool	open (void)
bool	close (void)
void	resetError (void)
void	applyError (const std::string &msg, unsigned int code)
std::string	getErrorMsg (void) const
unsigned int	getErrorCode (void) const
void	setServerHost (const std::string &serverHost_)
std::string	getServerHost (void) const
void	setServerPort (int serverPort_)
int	getServerPort (void) const
bool	setIndexFileName (const std::string &indexFileName_)
std::string	getIndexFileName (void) const
void	setTimeoutedRequests (unsigned long long timeoutedRequests_)
unsigned long long	getTimeoutedRequests (void) const
void	resetTimeoutedRequests (void)
void	setDefaultRequestTimeout (unsigned long defaultRequestTimeout_)
unsigned long	getDefaultRequestTimeout (void) const
void	setCheckIncomingDocuments (bool checkIncomingDocuments_)
bool	getCheckIncomingDocuments (void) const
void	setPackIncomingDocuments (bool packIncomingDocuments_)
bool	getPackIncomingDocuments (void) const
void	setMinNumberFieldsPacking (unsigned int minNumberFieldsPacking_)
unsigned int	getMinNumberFieldsPacking (void) const
void	resetLogStream (void)
void	setLogStream (std::ostream &os)
std::string	logMsg (bool isReset=true)
std::ostream &	log (LoggerStream::Priority logPriority)
void	setLoggable (Loggable loggable)
void	resetLoggable (void)
CustomMessage &	getCustomMessage (void)
void	setMatchMode (unsigned int matchMode_)
unsigned int	getMatchMode (void) const
void	setSortMode (unsigned int sortMode_)
unsigned int	getSortMode (void) const
void	setRankingMode (unsigned int rankingMode_, const std::string &rankerExpression_="")
unsigned int	getRankingMode (void) const
void	setRankerExpression (const std::string &rankerExpression_)
std::string	getRankerExpression (void) const
Public Member Functions inherited from HCE::sphinx::SphinxSearchInterface
	SphinxSearchInterface (void)
virtual	~SphinxSearchInterface (void)
void	setErrorMsg (const std::string &errorMsg_)
void	setErrorCode (unsigned int errorCode_)
void	isError (bool isError_)
bool	isError (void) const
Public Member Functions inherited from HCE::sphinx::SphinxNodeOptions
	SphinxNodeOptions (const std::string &nodeName_="", unsigned int nodeNumber_=0, const std::string &homeDir_=sphinx_search_const::defaultHomeDir, const std::string &indexName_="")
virtual	~SphinxNodeOptions (void)
void	setNodeName (const std::string &nodeName_)
std::string	getNodeName (void) const
void	setNodeNumber (unsigned int nodeNumber_)
unsigned int	getNodeNumber (void) const
void	setHomeDir (const std::string &homeDir_)
std::string	getHomeDir (void) const
void	setIndexName (const std::string &indexName_)
std::string	getIndexName (void) const
std::string	getDataDir (void) const
std::string	getRunDir (void) const
std::string	getLogDir (void) const
std::string	getEtcDir (void) const

Static Public Member Functions
static void	parseHostPort (const std::string &in, std::string &host, unsigned int &port) throw (std::exception)
static std::string	makeErrorMessage (const std::string &inputMessage, unsigned int errorCode, const std::string &errorMessage)
Static Public Member Functions inherited from HCE::sphinx::SphinxSearchInterface
static bool	insensitiveCompare (const std::string &lhs, const std::string &rhs)
static size_t	getTimeInterval (timeval &start, timeval &stop)

Additional Inherited Members
Protected Attributes inherited from HCE::sphinx::SphinxSearchInterface
std::string	errorMsg
unsigned int	errorCode
bool	_isError

Detailed Description

Definition at line 32 of file SphinxFunctionalObject.hpp.

Constructor & Destructor Documentation

HCE::sphinx::SphinxFunctionalObject::SphinxFunctionalObject ( const std::string &  nodeName_ = "", const std::string &  homeDir_ = sphinx_search_const::defaultHomeDir, const std::string &  indexName_ = "", bool  startSearchd_ = false, bool  stopSearchd_ = false  )

explicit

Definition at line 22 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

HCE::sphinx::SphinxFunctionalObject::SphinxFunctionalObject	(	const std::string &	nodeName_,
		unsigned int	nodeNumber,
		const std::string &	homeDir_ = sphinx_search_const::defaultHomeDir,
		const std::string &	indexName_ = "",
		bool	startSearchd_ = false,
		bool	stopSearchd_ = false
	)

Definition at line 42 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

HCE::sphinx::SphinxFunctionalObject::~SphinxFunctionalObject ( void  )

virtual

Definition at line 62 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Member Function Documentation

void HCE::sphinx::SphinxFunctionalObject::applyError	(	const std::string &	msg,
		unsigned int	code
	)

Definition at line 274 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool HCE::sphinx::SphinxFunctionalObject::close

(

void

)

Definition at line 256 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool HCE::sphinx::SphinxFunctionalObject::easyStart

(

void

)

Definition at line 223 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool HCE::sphinx::SphinxFunctionalObject::getCheckIncomingDocuments ( void  ) const

inline

Definition at line 79 of file SphinxFunctionalObject.hpp.

Here is the caller graph for this function:

CustomMessage& HCE::sphinx::SphinxFunctionalObject::getCustomMessage ( void  )

inline

Definition at line 98 of file SphinxFunctionalObject.hpp.

unsigned long HCE::sphinx::SphinxFunctionalObject::getDefaultRequestTimeout

(

void

)

const

Definition at line 355 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

unsigned int HCE::sphinx::SphinxFunctionalObject::getErrorCode

(

void

)

const

Reimplemented from HCE::sphinx::SphinxSearchInterface.

Definition at line 293 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

std::string HCE::sphinx::SphinxFunctionalObject::getErrorMsg

(

void

)

const

Reimplemented from HCE::sphinx::SphinxSearchInterface.

Definition at line 281 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

std::string HCE::sphinx::SphinxFunctionalObject::getIndexFileName

(

void

)

const

Definition at line 330 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int HCE::sphinx::SphinxFunctionalObject::getMatchMode ( void  ) const

inline

Definition at line 101 of file SphinxFunctionalObject.hpp.

unsigned int HCE::sphinx::SphinxFunctionalObject::getMinNumberFieldsPacking ( void  ) const

inline

Definition at line 85 of file SphinxFunctionalObject.hpp.

bool HCE::sphinx::SphinxFunctionalObject::getPackIncomingDocuments ( void  ) const

inline

Definition at line 82 of file SphinxFunctionalObject.hpp.

Here is the caller graph for this function:

std::string HCE::sphinx::SphinxFunctionalObject::getRankerExpression ( void  ) const

inline

Definition at line 110 of file SphinxFunctionalObject.hpp.

Here is the caller graph for this function:

unsigned int HCE::sphinx::SphinxFunctionalObject::getRankingMode ( void  ) const

inline

Definition at line 107 of file SphinxFunctionalObject.hpp.

Here is the caller graph for this function:

std::string HCE::sphinx::SphinxFunctionalObject::getServerHost

(

void

)

const

Definition at line 310 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

int HCE::sphinx::SphinxFunctionalObject::getServerPort

(

void

)

const

Definition at line 320 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int HCE::sphinx::SphinxFunctionalObject::getSortMode ( void  ) const

inline

Definition at line 104 of file SphinxFunctionalObject.hpp.

unsigned long long HCE::sphinx::SphinxFunctionalObject::getTimeoutedRequests

(

void

)

const

Definition at line 340 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool HCE::sphinx::SphinxFunctionalObject::isActiveSearchd

(

void

)

Definition at line 238 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool HCE::sphinx::SphinxFunctionalObject::isConnected

(

void

)

const

Definition at line 243 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool HCE::sphinx::SphinxFunctionalObject::isLoadedConfig ( void  ) const

inline

Definition at line 46 of file SphinxFunctionalObject.hpp.

Here is the caller graph for this function:

bool HCE::sphinx::SphinxFunctionalObject::loadConfiguration

(

const std::string &

indexName

)

Definition at line 121 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

std::ostream & HCE::sphinx::SphinxFunctionalObject::log

(

LoggerStream::Priority

logPriority

)

Definition at line 84 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

std::string HCE::sphinx::SphinxFunctionalObject::logMsg

(

bool

isReset = true

)

Definition at line 79 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

std::string HCE::sphinx::SphinxFunctionalObject::makeErrorMessage ( const std::string &  inputMessage, unsigned int  errorCode, const std::string &  errorMessage  )

static

Definition at line 489 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool HCE::sphinx::SphinxFunctionalObject::open

(

void

)

Definition at line 248 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

void HCE::sphinx::SphinxFunctionalObject::parseHostPort ( const std::string &  in, std::string &  host, unsigned int &  port  ) throw (std::exception)

static

Definition at line 99 of file SphinxFunctionalObject.cpp.

Here is the caller graph for this function:

std::string HCE::sphinx::SphinxFunctionalObject::Process ( const std::string &  json )

virtual

Implements HCE::sphinx::SphinxSearchInterface.

Definition at line 360 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

SphinxOutputJsonMessage HCE::sphinx::SphinxFunctionalObject::Process ( SphinxInputJsonMessage &  inputJsonMessage )

virtual

Implements HCE::sphinx::SphinxSearchInterface.

Definition at line 427 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

void HCE::sphinx::SphinxFunctionalObject::resetError

(

void

)

Definition at line 261 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void HCE::sphinx::SphinxFunctionalObject::resetLoggable

(

void

)

Definition at line 94 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

void HCE::sphinx::SphinxFunctionalObject::resetLogStream

(

void

)

Definition at line 69 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

void HCE::sphinx::SphinxFunctionalObject::resetTimeoutedRequests

(

void

)

Definition at line 345 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

void HCE::sphinx::SphinxFunctionalObject::resizeResultData	(	size_t	matchesCount,
		size_t	attributesCount
	)

Definition at line 218 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

void HCE::sphinx::SphinxFunctionalObject::setCheckIncomingDocuments ( bool  checkIncomingDocuments_ )

inline

Definition at line 78 of file SphinxFunctionalObject.hpp.

Here is the caller graph for this function:

void HCE::sphinx::SphinxFunctionalObject::setDefaultRequestTimeout

(

unsigned long

defaultRequestTimeout_

)

Definition at line 350 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

bool HCE::sphinx::SphinxFunctionalObject::setIndexFileName

(

const std::string &

indexFileName_

)

Definition at line 325 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

void HCE::sphinx::SphinxFunctionalObject::setLoggable

(

Loggable

loggable

)

Definition at line 89 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

void HCE::sphinx::SphinxFunctionalObject::setLogStream

(

std::ostream &

os

)

Definition at line 74 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void HCE::sphinx::SphinxFunctionalObject::setMatchMode ( unsigned int  matchMode_ )

inline

Definition at line 100 of file SphinxFunctionalObject.hpp.

void HCE::sphinx::SphinxFunctionalObject::setMinNumberFieldsPacking ( unsigned int  minNumberFieldsPacking_ )

inline

Definition at line 84 of file SphinxFunctionalObject.hpp.

void HCE::sphinx::SphinxFunctionalObject::setPackIncomingDocuments ( bool  packIncomingDocuments_ )

inline

Definition at line 81 of file SphinxFunctionalObject.hpp.

Here is the caller graph for this function:

void HCE::sphinx::SphinxFunctionalObject::setRankerExpression ( const std::string &  rankerExpression_ )

inline

Definition at line 109 of file SphinxFunctionalObject.hpp.

Here is the caller graph for this function:

void HCE::sphinx::SphinxFunctionalObject::setRankingMode	(	unsigned int	rankingMode_,
		const std::string &	rankerExpression_ = ""
	)

Definition at line 114 of file SphinxFunctionalObject.cpp.

Here is the caller graph for this function:

void HCE::sphinx::SphinxFunctionalObject::setServerHost

(

const std::string &

serverHost_

)

Definition at line 305 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void HCE::sphinx::SphinxFunctionalObject::setServerPort

(

int

serverPort_

)

Definition at line 315 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void HCE::sphinx::SphinxFunctionalObject::setSortMode ( unsigned int  sortMode_ )

inline

Definition at line 103 of file SphinxFunctionalObject.hpp.

void HCE::sphinx::SphinxFunctionalObject::setTimeoutedRequests

(

unsigned long long

timeoutedRequests_

)

Definition at line 335 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool HCE::sphinx::SphinxFunctionalObject::startSearchd

(

void

)

Definition at line 228 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool HCE::sphinx::SphinxFunctionalObject::stopSearchd

(

void

)

Definition at line 233 of file SphinxFunctionalObject.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• sources/utils/sphinx/src/SphinxFunctionalObject.hpp
• sources/utils/sphinx/src/SphinxFunctionalObject.cpp