Class GremlinClient

Provides a mechanism for submitting Gremlin requests to one Gremlin Server.

Inheritance
System.Object
GremlinClient
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace:Gremlin.Net
Assembly:Gremlin.Net.dll
Syntax
public class GremlinClient : IGremlinClient, IDisposable

Constructors

| Improve this Doc View Source

GremlinClient(GremlinServer)

Initializes a new instance of the GremlinClient class for the specified Gremlin Server.

Declaration
public GremlinClient(GremlinServer gremlinServer)
Parameters
Type Name Description
GremlinServer gremlinServer

The GremlinServer the requests should be sent to.

Properties

| Improve this Doc View Source

NrConnections

Gets the number of open connections.

Declaration
public int NrConnections { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
Implements
System.IDisposable.Dispose()
| Improve this Doc View Source

Dispose(Boolean)

Releases the resources used by the GremlinClient instance.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Specifies whether managed resources should be released.
| Improve this Doc View Source

SubmitAsync<T>(ScriptRequestMessage)

Submits a request message as an asynchronous operation.

Declaration
public Task<IEnumerable<T>> SubmitAsync<T>(ScriptRequestMessage requestMessage)
Parameters
Type Name Description
ScriptRequestMessage requestMessage

The ScriptRequestMessage to send.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<T>>

An enumerable collection of the data returned from the server.
Type Parameters
Name Description
T

The type of the expected results.
Implements
Exceptions
Type Condition
ResponseException

Thrown when a response is received from Gremlin Server that indicates that an error occurred.

Extension Methods