Network.Greskell.WebSocket.Connection.Settings

Settings

data Settings s

Settings for making connection to Gremlin Server.

You can get the default Settings by defSettings function, and customize its fields by accessor functions.

Type s is the body of Response.

defSettings :: Codec s -> Settings s

defJSONSettings :: FromGraphSON s => Settings s

defSettings with jsonCodec.

accessor functions

codec :: Settings s -> Codec s

codec for the connection.

endpointPath :: Settings s -> String

Path of the WebSocket endpoint. Default: "/gremlin"

onGeneralException :: Settings s -> GeneralException -> IO ()

An exception handler for GeneralException. This exception is not fatal, so the connection survives after this handler is called. You don't have to re-throw the exception. Default: print the exception to stderr.

responseTimeout :: Settings s -> Int

Time out (in seconds) for responses. It is the maximum time for which the connection waits for a response to complete after it sends a request. If the response consists of more than one ResponseMessages, the timeout applies to the last of the ResponseMessages. Default: 60

concurrency :: Settings s -> Int

Maximum concurrent requests the connection can make to the server. If the client tries to make more concurrent requests than this value, later requests are queued in the connection or the client may be blocked. Default: 4

requestQueueSize :: Settings s -> Int

Size of the internal queue of requests. Usually you don't need to customize the field. See also concurrency. Default: 8.