The SphinxClient type exposes the following members.

Constructors

  Name Description
Public method SphinxClient()()()()
Initializes a new instance of the SphinxClient class with 127.0.0.1 as host, 9312 as port and 0.9.9 as version.
Public method SphinxClient(IPEndPoint)
Initializes a new instance of the SphinxClient class.
Public method SphinxClient(String, Int32)
Initializes a new instance of the SphinxClient class.

Methods

  Name Description
Public method AddQuery(String)
Adds a new query with the current SearchOptions to the search request.
Public method AddQuery(String, String)
Adds a new query with the current SearchOptions for the index with the given name to the search request.
Public method AddQuery(String, String, String)
Adds a new query with the current SearchOptions for the index with the given name, and the given comment to the search request.
Public method BuildExcerpts(IEnumerable<(Of <<'(String>)>>), String, String)
Builds excerpts for the given documents using the settings from the given index name and inserting the default values for BeforeMatch and AfterMatch before and after the given highlight words.
Public method BuildExcerpts(IEnumerable<(Of <<'(String>)>>), String, String, BuildExcerptsOptions)
Builds excerpts for the given documents using the settings from the given index name and the given options.
Public method BuildKeywords
Builds a list of keywords from the given query, using the settings from the specified index.
Public method ClearQueries
Clears the (internal) list of scheduled queries (queries which have been added via AddQuery(String)).
Public method ClosePersistentConnection
Closes a persistent connection.
Public method Dispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public method FlushAttributes
Causes Sphinx to do an attribute flush.
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method GetStatus
Gets an array of SphinxStatusInfo instances for each status variable from searchd.
Public method GetType
Gets the type of the current instance.
(Inherited from Object.)
Public method OpenPersistentConnection
Opens a persistent connection to searchd.
Public method Query(String)
Sends the specified query to searchd and returns its result. The query is run on all indices.
Public method Query(String, String)
Sends the specified query for the index with the given name to searchd and returns its result.
Public method Query(String, String, String)
Sends the specified query for the index with the given name and a comment, which will be written to the query log, to searchd and returns its result.
Public method QueryWithSphinxQL Obsolete.
Query searchd with SphinxQL.
Public method ResetSearchOptions
Resets the search options to their default values and clears field weights, index weights etc.
Public method RunQueries
Runs the queries which have been added via the AddQuery method.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public method UpdateAttributes<(Of <<'(TUpdateable>)>>)
Updates attributes for the index with the given name with values from the given sequence of SphinxAttributeUpdateItems.

Properties

  Name Description
Public property ConnectTimeout
Gets or sets the connect timeout. Default is 30 seconds.
Public property Encoding
Gets or sets the encoding which is used when sending strings to searchd. Default is UTF8.
Public property Host
Gets or sets the host on which searchd is running. Default is 127.0.0.1.
Public property IPEndpoint
Gets or sets the ip end point of searchd. Alternatively Host and Port properties can be used.
Public property IsConnected
Gets a value indicating whether the current instance is connected to Sphinx.
Public property Static member License
Gets or sets the license information.
Public property Port
Gets or sets the port on which searchd is listening. Default is 9312.
Public property SearchOptions
Gets or sets the search options which are applied when a query is sent to searchd.
Public property Version
Gets or sets the version of Sphinx which this instance will connect to. Default is 0.9.9.

See Also