Network.Greskell.WebSocket.Client

Make a Client

connect :: Host -> Port -> IO Client

Create a Client to a Gremlin Server, with the default Options.

connectWith :: Options -> Host -> Port -> IO Client

Create a Client to a Gremlin Server.

close :: Client -> IO ()

Close the connection to the server and release other resources of the Client.

data Client

A client that establishes a connection to the Gremlin Server. You can send Gremlin expression for evaluation by submit function.

type Host = String

Host name or an IP address.

type Port = Int

TCP port number.

Options for Client

module Network.Greskell.WebSocket.Client.Options

Submit evaluation requests

submit

Arguments

:: (ToGreskell g, r ~ GreskellReturn g, AsIterator r, v ~ IteratorItem r, FromGraphSON v)

=> Client

-> g

Gremlin script

-> Maybe Object

bindings

-> IO (ResultHandle v)

Submit a Gremlin script to the server. You can get its results by ResultHandle. The result type v is determined by the script type g.

Usually this function does not throw any exception. Exceptions about sending requests are reported when you operate on ResultHandle.

submitPair :: (ToGreskell g, r ~ GreskellReturn g, AsIterator r, v ~ IteratorItem r, FromGraphSON v) => Client -> (g, Object) -> IO (ResultHandle v)

Submit a pair of Gremlin script and variable binding. It's just a simple wrapper around submit.

Since: 0.1.2.0

submitRaw

Arguments

:: Client

-> Text

Gremlin script

-> Maybe Object

bindings

-> IO (ResultHandle GValue)

Less type-safe version of submit.

data ResultHandle v

A handle to receive the result of evaluation of a Gremlin script from the server.

nextResult :: ResultHandle v -> IO (Maybe v)

Get the next value from the ResultHandle. If you have got all values, it returns Nothing. This function may block for a new response to come.

On error, it may throw all sorts of exceptions including SubmitException and RequestException. For example, if the submitted Gremlin script throws an exception, nextResult throws ResponseError with ResponseCode of ScriptEvaluationError.

nextResultSTM :: ResultHandle v -> STM (Maybe v)

STM version of nextResult.

slurpResults :: ResultHandle v -> IO (Vector v)

Get all remaining results from ResultHandle.

drainResults :: ResultHandle v -> IO ()

Similar to slurpResults, but this function discards the results. Useful to execute a script whose side-effect is the only thing you care.

Since: 0.1.1.0

Exceptions

data SubmitException

Exception about submit operation and getting its result.

Constructors

ResponseError (ResponseMessage GValue)

The server returns a ResponseMessage with error ResponseCode.

ParseError (ResponseMessage GValue) String

The client fails to parse the "data" field of the ResponseMessage. The error message is kept in the String field.

Instances

Exception SubmitException

Defined in Network.Greskell.WebSocket.Client.Impl

Methods

toException :: SubmitException -> SomeException

fromException :: SomeException -> Maybe SubmitException

displayException :: SubmitException -> String

Show SubmitException

Defined in Network.Greskell.WebSocket.Client.Impl

Methods

showsPrec :: Int -> SubmitException -> ShowS

show :: SubmitException -> String

showList :: [SubmitException] -> ShowS