Class lucene_utilitymsg

Description

The lucene utility message class. Used for special Lucene operations.

Located in /lucene-defs.php (line 1214)

search
   |
   --lucene_connection
      |
      --lucene_msg
         |
         --lucene_message
            |
            --lucene_utilitymsg
Method Summary
 lucene_utilitymsg lucene_utilitymsg ([string $utilitycmd = ""], [string $application = "?"], [string $host = ""], [string $port = ""])
 boolean send ([integer $timeoutsecs = ""])
Variables
Methods
Constructor lucene_utilitymsg (line 1221)

Constructor

lucene_utilitymsg lucene_utilitymsg ([string $utilitycmd = ""], [string $application = "?"], [string $host = ""], [string $port = ""])
  • string $utilitycmd: Command for this utility message.
  • string $application: Optional application specifier
  • string $host: Hostname or IP of Lucene server
  • string $port: Port of Lucene server
send (line 1237)

Send the message to Lucene, and then post-process the response for indication of a successful utility operation. We expect to receive a response back from Lucene which has nothing much it, unless there has been an error.

returns True if the operation was successful, else False.

  • return: True if operation was successful.
boolean send ([integer $timeoutsecs = ""])
  • integer $timeoutsecs: Override for timeout in seconds

Redefinition of:
lucene_msg::send()
Sends the current message to Lucene, and checks for protocol errors in the received response.

Inherited Methods

Inherited From lucene_message

 lucene_message::lucene_message()
 lucene_message::define_field()
 lucene_message::set_first()
 lucene_message::set_limit()
 lucene_message::set_range()
 lucene_message::set_returnfields()
 lucene_message::set_sortorder()
 lucene_message::set_stopwords()

Inherited From lucene_msg

 lucene_msg::lucene_msg()
 lucene_msg::add_field()
 lucene_msg::add_xmltag()
 lucene_msg::clear()
 lucene_msg::send()
 lucene_msg::set_application()
 lucene_msg::set_domain()

Inherited From lucene_connection

 lucene_connection::lucene_connection()
 lucene_connection::send()
 lucene_connection::set_timeout()

Inherited From search

 search::search()
 search::clear_daterange()
 search::clear_search()
 search::does_not_match()
 search::has_daterange()
 search::hitcount()
 search::initialise()
 search::match()
 search::may_match()
 search::must_match()
 search::reset_search()
 search::set_daterange()
 search::set_maxresults()
 search::set_skipresults()
 search::termcount()

Documentation generated by phpDocumentor 1.3.0RC3