 | SphinxClient Class |
Provides methods to access the functions offered by Sphinx using the native Sphinx protocol.
This class cannot be inherited.
Inheritance HierarchyNamespace: SphinxConnector.NativeApi
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 5.4.1
SyntaxThe SphinxClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SphinxClient(IPEndPoint) |
Initializes a new instance of the SphinxClient class.
|
| SphinxClient(String, Int32) |
Initializes a new instance of the SphinxClient class.
|
Properties| Name | Description | |
|---|---|---|
 | ConnectTimeout |
Gets or sets the connect timeout. Default is 30 seconds.
|
| Encoding |
Gets or sets the encoding which is used when sending strings to searchd. Default is
UTF8.
|
| Host |
Gets or sets the host on which searchd is running. Default is 127.0.0.1.
|
| IPEndpoint | |
| IsConnected | Obsolete.
Gets a value indicating whether the current instance is connected to Sphinx.
|
| Port |
Gets or sets the port on which searchd is listening. Default is 9312.
|
| SearchOptions |
Gets or sets the search options which are applied when a query is sent to searchd.
|
 | Version |
Gets or sets the version of Sphinx which this instance will
connect to. Default is 2.2.1.
|
Methods| Name | Description | |
|---|---|---|
| AddQuery |
Adds a new query with the current SearchOptions to the search request.
If no index name is given, the query will be executed against all indexes. If a comment is
provided it will be written to the query log by searchd.
|
| BuildExcerpts(IEnumerableString, 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.
|
| BuildExcerpts(IEnumerableString, String, String, BuildExcerptsOptions) |
Builds excerpts for the given documents using the settings from the given index name and
the given options.
|
| BuildKeywords |
Builds a list of keywords from the given query, using the settings from the specified index.
|
| ClearQueries |
Clears the (internal) list of scheduled queries (queries which have been added via AddQuery(String, String, String)).
|
| ClosePersistentConnection |
Closes a persistent connection.
|
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| FlushAttributes |
Causes Sphinx to do an attribute flush.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetStatus |
Gets an array of SphinxStatusInfo instances for each
status variable from searchd.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| OpenPersistentConnection |
Opens a persistent connection to searchd.
|
| Query |
Sends the specified query to searchd returns its result. If no index name is given, the query will be executed
against all indexes. If a comment is provided it will be written to the query log by searchd.
|
| ResetSearchOptions |
Resets the search options to their default values and clears field weights,
index weights etc.
|
| RunQueries |
Runs the queries which have been added via the AddQuery method.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UpdateAttributesTUpdateable(String, SphinxAttributeUpdateTUpdateable) |
Updates attributes for the index with the given name with values from the given
sequence of SphinxAttributeUpdateItems.
|
| UpdateAttributesTUpdateable(String, UpdateAttributesOptions, SphinxAttributeUpdateTUpdateable) |
Updates attributes for the index with the given name with values from the given
sequence of SphinxAttributeUpdateItems.
|
Thread SafetyAny public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also