WebSocket is a protocol and a proper noun - CTR
Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/4d117cbd Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/4d117cbd Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/4d117cbd Branch: refs/heads/TINKERPOP-786 Commit: 4d117cbd6df0ccc9f8ccef47011e855cea392447 Parents: ec4f83c Author: Robert Dale <robd...@gmail.com> Authored: Mon Apr 24 12:12:24 2017 -0400 Committer: Robert Dale <robd...@gmail.com> Committed: Mon Apr 24 12:12:24 2017 -0400 ---------------------------------------------------------------------- docs/src/dev/provider/index.asciidoc | 8 ++++---- docs/src/reference/gremlin-applications.asciidoc | 8 ++++---- docs/src/tutorials/getting-started/index.asciidoc | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/4d117cbd/docs/src/dev/provider/index.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/dev/provider/index.asciidoc b/docs/src/dev/provider/index.asciidoc index aa89020..69060af 100644 --- a/docs/src/dev/provider/index.asciidoc +++ b/docs/src/dev/provider/index.asciidoc @@ -626,7 +626,7 @@ which should provide enough information to develop a driver for a specific langu image::gremlin-server-flow.png[width=300,float=right] -Gremlin Server is distributed with a configuration that utilizes link:http://en.wikipedia.org/wiki/WebSocket[WebSockets] +Gremlin Server is distributed with a configuration that utilizes link:http://en.wikipedia.org/wiki/WebSocket[WebSocket] with a custom sub-protocol. Under this configuration, Gremlin Server accepts requests containing a Gremlin script, evaluates that script and then streams back the results. The notion of "streaming" is depicted in the diagram to the right. @@ -674,7 +674,7 @@ A `RequestMessage` to evaluate a script with variable bindings looks like this i ---- The above JSON represents the "body" of the request to send to Gremlin Server. When sending this "body" over -websockets Gremlin Server can accept a packet frame using a "text" (1) or a "binary" (2) opcode. Using "text" +WebSocket, Gremlin Server can accept a packet frame using a "text" (1) or a "binary" (2) opcode. Using "text" is a bit more limited in that Gremlin Server will always process the body of that request as JSON. Generally speaking "text" is just for testing purposes. @@ -689,7 +689,7 @@ The first byte represents the length of the "mime type" string value that follow Gremlin Server, this value should be set to `application/json`. The "payload" represents the JSON message above encoded as bytes. -NOTE: Gremlin Server will only accept masked packets as it pertains to websocket packet header construction. +NOTE: Gremlin Server will only accept masked packets as it pertains to a WebSocket packet header construction. When Gremlin Server receives that request, it will decode it given the "mime type", pass it to the requested `OpProcessor` which will execute the `op` defined in the message. In this case, it will evaluate the script @@ -716,7 +716,7 @@ In this case the `ResponseMessage` returned to the client would look something l "status":{"code":206,"attributes":{},"message":""}} ---- -Gremlin Server is capable of streaming results such that additional responses will arrive over the websocket until +Gremlin Server is capable of streaming results such that additional responses will arrive over the WebSocket connection until the iteration of the result on the server is complete. Each successful incremental message will have a `ResultCode` of `206`. Termination of the stream will be marked by a final `200` status code. Note that all messages without a `206` represent terminating conditions for a request. The following table details the various status codes that http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/4d117cbd/docs/src/reference/gremlin-applications.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/gremlin-applications.asciidoc b/docs/src/reference/gremlin-applications.asciidoc index c4a1493..a5c162e 100644 --- a/docs/src/reference/gremlin-applications.asciidoc +++ b/docs/src/reference/gremlin-applications.asciidoc @@ -297,7 +297,7 @@ NOTE: Gremlin Server is the replacement for link:http://rexster.tinkerpop.com[Re NOTE: Please see the link:http://tinkerpop.apache.org/docs/x.y.z/dev/provider/[Provider Documentation] for information on how to develop a driver for Gremlin Server. -By default, communication with Gremlin Server occurs over link:http://en.wikipedia.org/wiki/WebSocket[WebSockets] and +By default, communication with Gremlin Server occurs over link:http://en.wikipedia.org/wiki/WebSocket[WebSocket] and exposes a custom sub-protocol for interacting with the server. [[starting-gremlin-server]] @@ -691,7 +691,7 @@ Connecting via REST ~~~~~~~~~~~~~~~~~~~ image:gremlin-rexster.png[width=225,float=left] While the default behavior for Gremlin Server is to provide a -WebSockets-based connection, it can also be configured to support link:http://en.wikipedia.org/wiki/Representational_state_transfer[REST]. +WebSocket-based connection, it can also be configured to support link:http://en.wikipedia.org/wiki/Representational_state_transfer[REST]. The REST endpoint provides for a communication protocol familiar to most developers, with a wide support of programming languages, tools and libraries for accessing it. As a result, REST provides a fast way to get started with Gremlin Server. It also may represent an easier upgrade path from link:http://rexster.tinkerpop.com/[Rexster] @@ -767,7 +767,7 @@ string argument with by setting the `language` key. WARNING: Consider the size of the result of a submitted script being returned from the REST endpoint. A script that iterates thousands of results will serialize each of those in memory into a single JSON result set. It is quite possible that such a script will generate `OutOfMemoryError` exceptions on the server. Consider the default -WebSockets configuration, which supports streaming, if that type of use case is required. +WebSocket configuration, which supports streaming, if that type of use case is required. Configuring ~~~~~~~~~~~ @@ -802,7 +802,7 @@ The following table describes the various configuration options that Gremlin Ser |Key |Description |Default |authentication.className |The fully qualified classname of an `Authenticator` implementation to use. If this setting is not present, then authentication is effectively disabled. |`AllowAllAuthenticator` |authentication.config |A `Map` of configuration settings to be passes to the `Authenticator` when it is constructed. The settings available are dependent on the implementation. |_none_ -|channelizer |The fully qualified classname of the `Channelizer` implementation to use. A `Channelizer` is a "channel initializer" which Gremlin Server uses to define the type of processing pipeline to use. By allowing different `Channelizer` implementations, Gremlin Server can support different communication protocols (e.g. Websockets, Java NIO, etc.). |`WebSocketChannelizer` +|channelizer |The fully qualified classname of the `Channelizer` implementation to use. A `Channelizer` is a "channel initializer" which Gremlin Server uses to define the type of processing pipeline to use. By allowing different `Channelizer` implementations, Gremlin Server can support different communication protocols (e.g. WebSocket, Java NIO, etc.). |`WebSocketChannelizer` |graphs |A `Map` of `Graph` configuration files where the key of the `Map` becomes the name to which the `Graph` will be bound and the value is the file name of a `Graph` configuration file. |_none_ |gremlinPool |The number of "Gremlin" threads available to execute actual scripts in a `ScriptEngine`. This pool represents the workers available to handle blocking operations in Gremlin Server. |8 |host |The name of the host to bind the server to. |localhost http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/4d117cbd/docs/src/tutorials/getting-started/index.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/tutorials/getting-started/index.asciidoc b/docs/src/tutorials/getting-started/index.asciidoc index 3ac80ce..7af5364 100644 --- a/docs/src/tutorials/getting-started/index.asciidoc +++ b/docs/src/tutorials/getting-started/index.asciidoc @@ -527,7 +527,7 @@ Gremlin Server image:gremlin-server-protocol.png[width=325,float=right] link:http://tinkerpop.apache.org/docs/x.y.z/reference/#gremlin-server[Gremlin Server] provides a way to remotely execute Gremlin scripts against one or more `Graph` instances hosted within it. It does this by exposing different endpoints, such as link:http://tinkerpop.apache.org/docs/x.y.z/reference/#_connecting_via_rest[REST] -and link:http://tinkerpop.apache.org/docs/x.y.z/reference/#_connecting_via_java[websockets], which allow a request +and link:http://tinkerpop.apache.org/docs/x.y.z/reference/#_connecting_via_java[WebSocket], which allow a request containing a Gremlin script to be processed with results returned. [source,text] @@ -574,7 +574,7 @@ applied to the script on execution and is essentially a way to parameterize your critical to link:http://tinkerpop.apache.org/docs/x.y.z/reference/#_best_practices[performance]. Whenever possible, parameterize your queries. -As mentioned earlier, Gremlin Server can also be configured with a websockets endpoint. This endpoint has an +As mentioned earlier, Gremlin Server can also be configured with a WebSocket endpoint. This endpoint has an embedded link:http://tinkerpop.apache.org/docs/x.y.z/reference/#_developing_a_driver[subprotocol] that allow a compliant driver to communicate with it. TinkerPop supplies a link:http://tinkerpop.apache.org/docs/x.y.z/reference/#_connecting_via_java[reference driver] written in Java, but
