## Uses of Class
org.apache.tinkerpop.gremlin.driver.message.RequestMessage

- Packages that use RequestMessage
  Package | Description
  --- | ---
  org.apache.tinkerpop.gremlin.driver |
  org.apache.tinkerpop.gremlin.driver.handler |
  org.apache.tinkerpop.gremlin.driver.message |
  org.apache.tinkerpop.gremlin.driver.ser |
  org.apache.tinkerpop.gremlin.driver.ser.binary |
  org.apache.tinkerpop.gremlin.driver.simple |
  org.apache.tinkerpop.gremlin.server |
  org.apache.tinkerpop.gremlin.server.authz |
  org.apache.tinkerpop.gremlin.server.handler |
  org.apache.tinkerpop.gremlin.server.op |
  org.apache.tinkerpop.gremlin.server.op.session |

- - ### Uses of RequestMessage in org.apache.tinkerpop.gremlin.driver

    Methods in org.apache.tinkerpop.gremlin.driver that return RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `RequestMessage` | MessageSerializer.`deserializeRequest(io.netty.buffer.ByteBuf msg)` Deserialize a Netty `ByteBuf` into a `RequestMessage`.
    `RequestMessage` | ResultSet.`getOriginalRequestMessage()`

    Methods in org.apache.tinkerpop.gremlin.driver with parameters of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `protected abstract org.apache.tinkerpop.gremlin.driver.Connection` | Client.`chooseConnection(RequestMessage msg)` Chooses a `Connection` to write the message to.
    `protected org.apache.tinkerpop.gremlin.driver.Connection` | Client.ClusteredClient.`chooseConnection(RequestMessage msg)` Uses a `LoadBalancingStrategy` to choose the best `Host` and then selects the best connection from that host's connection pool.
    `protected org.apache.tinkerpop.gremlin.driver.Connection` | Client.AliasClusteredClient.`chooseConnection(RequestMessage msg)` Delegates to the underlying `Client.ClusteredClient`.
    `protected org.apache.tinkerpop.gremlin.driver.Connection` | Client.SessionedClient.`chooseConnection(RequestMessage msg)` Since the session is bound to a single host, simply borrow a connection from that pool.
    `Iterator<Host>` | LoadBalancingStrategy.`select(RequestMessage msg)` Provide an ordered list of hosts to send the given `RequestMessage` to.
    `Iterator<Host>` | LoadBalancingStrategy.RoundRobin.`select(RequestMessage msg)`
    `io.netty.buffer.ByteBuf` | MessageSerializer.`serializeRequestAsBinary(RequestMessage requestMessage, io.netty.buffer.ByteBufAllocator allocator)` Serialize a `ResponseMessage` to a Netty `ByteBuf`.
    `CompletableFuture<ResultSet>` | Client.`submitAsync(RequestMessage msg)` A low-level method that allows the submission of a manually constructed `RequestMessage`.
    `CompletableFuture<ResultSet>` | Client.AliasClusteredClient.`submitAsync(RequestMessage msg)`

    Constructors in org.apache.tinkerpop.gremlin.driver with parameters of type RequestMessage
    Constructor and Description
    `ResultSet(org.apache.tinkerpop.gremlin.driver.ResultQueue resultQueue, ExecutorService executor, CompletableFuture<Void> readCompleted, RequestMessage originalRequestMessage, Host host)`

  - ### Uses of RequestMessage in org.apache.tinkerpop.gremlin.driver.handler

    Methods in org.apache.tinkerpop.gremlin.driver.handler with parameters of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | WebSocketGremlinRequestEncoder.`encode(io.netty.channel.ChannelHandlerContext channelHandlerContext, RequestMessage requestMessage, List<Object> objects)`

  - ### Uses of RequestMessage in org.apache.tinkerpop.gremlin.driver.message

    Fields in org.apache.tinkerpop.gremlin.driver.message declared as RequestMessage
    Modifier and Type | Field and Description
    --- | ---
    `static RequestMessage` | RequestMessage.`INVALID` An "invalid" message.

    Methods in org.apache.tinkerpop.gremlin.driver.message that return RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `RequestMessage` | RequestMessage.Builder.`create()` Create the request message given the settings provided to the `RequestMessage.Builder`.

    Methods in org.apache.tinkerpop.gremlin.driver.message with parameters of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `static ResponseMessage.Builder` | ResponseMessage.`build(RequestMessage requestMessage)`
    `static RequestMessage.Builder` | RequestMessage.`from(RequestMessage msg)`

  - ### Uses of RequestMessage in org.apache.tinkerpop.gremlin.driver.ser

    Methods in org.apache.tinkerpop.gremlin.driver.ser that return RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `RequestMessage` | AbstractGraphSONMessageSerializerV2d0.RequestMessageDeserializer.`createObject(Map<String,Object> data)`
    `RequestMessage` | AbstractGryoMessageSerializerV1d0.`deserializeRequest(io.netty.buffer.ByteBuf msg)` Deprecated.
    `RequestMessage` | AbstractGraphSONMessageSerializerV2d0.`deserializeRequest(io.netty.buffer.ByteBuf msg)`
    `RequestMessage` | AbstractGryoMessageSerializerV3d0.`deserializeRequest(io.netty.buffer.ByteBuf msg)` Deprecated.
    `RequestMessage` | AbstractGraphSONMessageSerializerV1d0.`deserializeRequest(io.netty.buffer.ByteBuf msg)`
    `RequestMessage` | GraphBinaryMessageSerializerV1.`deserializeRequest(io.netty.buffer.ByteBuf msg)`
    `RequestMessage` | MessageTextSerializer.`deserializeRequest(String msg)`
    `RequestMessage` | GraphSONMessageSerializerV2d0.`deserializeRequest(String msg)`
    `RequestMessage` | GraphSONMessageSerializerV3d0.`deserializeRequest(String msg)`
    `RequestMessage` | GraphSONMessageSerializerV1d0.`deserializeRequest(String msg)`
    `<I extends InputShim> RequestMessage` | RequestMessageGryoSerializer.`read(KryoShim<I,?> kryo, I input, Class<RequestMessage> aClass)`

    Methods in org.apache.tinkerpop.gremlin.driver.ser with parameters of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `void` | AbstractGraphSONMessageSerializerV2d0.RequestMessageSerializer.`ser(RequestMessage requestMessage, org.apache.tinkerpop.shaded.jackson.core.JsonGenerator jsonGenerator, org.apache.tinkerpop.shaded.jackson.databind.SerializerProvider serializerProvider, org.apache.tinkerpop.shaded.jackson.databind.jsontype.TypeSerializer typeSerializer)`
    `void` | AbstractGraphSONMessageSerializerV2d0.RequestMessageSerializer.`serialize(RequestMessage requestMessage, org.apache.tinkerpop.shaded.jackson.core.JsonGenerator jsonGenerator, org.apache.tinkerpop.shaded.jackson.databind.SerializerProvider serializerProvider)`
    `io.netty.buffer.ByteBuf` | AbstractGryoMessageSerializerV1d0.`serializeRequestAsBinary(RequestMessage requestMessage, io.netty.buffer.ByteBufAllocator allocator)` Deprecated.
    `io.netty.buffer.ByteBuf` | AbstractGraphSONMessageSerializerV2d0.`serializeRequestAsBinary(RequestMessage requestMessage, io.netty.buffer.ByteBufAllocator allocator)`
    `io.netty.buffer.ByteBuf` | AbstractGryoMessageSerializerV3d0.`serializeRequestAsBinary(RequestMessage requestMessage, io.netty.buffer.ByteBufAllocator allocator)` Deprecated.
    `io.netty.buffer.ByteBuf` | AbstractGraphSONMessageSerializerV1d0.`serializeRequestAsBinary(RequestMessage requestMessage, io.netty.buffer.ByteBufAllocator allocator)`
    `io.netty.buffer.ByteBuf` | GraphBinaryMessageSerializerV1.`serializeRequestAsBinary(RequestMessage requestMessage, io.netty.buffer.ByteBufAllocator allocator)`
    `String` | MessageTextSerializer.`serializeRequestAsString(RequestMessage requestMessage)`
    `String` | GraphSONMessageSerializerV2d0.`serializeRequestAsString(RequestMessage requestMessage)`
    `String` | GraphSONMessageSerializerV3d0.`serializeRequestAsString(RequestMessage requestMessage)`
    `String` | GraphSONMessageSerializerV1d0.`serializeRequestAsString(RequestMessage requestMessage)`
    `void` | AbstractGraphSONMessageSerializerV2d0.RequestMessageSerializer.`serializeWithType(RequestMessage requestMessage, org.apache.tinkerpop.shaded.jackson.core.JsonGenerator jsonGenerator, org.apache.tinkerpop.shaded.jackson.databind.SerializerProvider serializerProvider, org.apache.tinkerpop.shaded.jackson.databind.jsontype.TypeSerializer typeSerializer)`
    `<O extends OutputShim> void` | RequestMessageGryoSerializer.`write(KryoShim<?,O> kryo, O output, RequestMessage requestMessage)`

    Method parameters in org.apache.tinkerpop.gremlin.driver.ser with type arguments of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `<I extends InputShim> RequestMessage` | RequestMessageGryoSerializer.`read(KryoShim<I,?> kryo, I input, Class<RequestMessage> aClass)`

  - ### Uses of RequestMessage in org.apache.tinkerpop.gremlin.driver.ser.binary

    Methods in org.apache.tinkerpop.gremlin.driver.ser.binary that return RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `RequestMessage` | RequestMessageSerializer.`readValue(io.netty.buffer.ByteBuf byteBuf, GraphBinaryReader context)`

    Methods in org.apache.tinkerpop.gremlin.driver.ser.binary with parameters of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `void` | RequestMessageSerializer.`writeValue(RequestMessage value, io.netty.buffer.ByteBuf byteBuf, GraphBinaryWriter context)`

  - ### Uses of RequestMessage in org.apache.tinkerpop.gremlin.driver.simple

    Methods in org.apache.tinkerpop.gremlin.driver.simple with parameters of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `List<ResponseMessage>` | AbstractClient.`submit(RequestMessage requestMessage)`
    `List<ResponseMessage>` | SimpleClient.`submit(RequestMessage requestMessage)`
    `void` | AbstractClient.`submit(RequestMessage requestMessage, Consumer<ResponseMessage> callback)`
    `void` | SimpleClient.`submit(RequestMessage requestMessage, Consumer<ResponseMessage> callback)`
    `CompletableFuture<List<ResponseMessage>>` | AbstractClient.`submitAsync(RequestMessage requestMessage)`
    `CompletableFuture<List<ResponseMessage>>` | SimpleClient.`submitAsync(RequestMessage requestMessage)`
    `abstract void` | AbstractClient.`writeAndFlush(RequestMessage requestMessage)`
    `void` | WebSocketClient.`writeAndFlush(RequestMessage requestMessage)`

  - ### Uses of RequestMessage in org.apache.tinkerpop.gremlin.server

    Methods in org.apache.tinkerpop.gremlin.server that return RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `RequestMessage` | Context.`getRequestMessage()` Gets the current request to Gremlin Server.

    Constructors in org.apache.tinkerpop.gremlin.server with parameters of type RequestMessage
    Constructor and Description
    `Context(RequestMessage requestMessage, io.netty.channel.ChannelHandlerContext ctx, Settings settings, GraphManager graphManager, GremlinExecutor gremlinExecutor, ScheduledExecutorService scheduledExecutorService)`

  - ### Uses of RequestMessage in org.apache.tinkerpop.gremlin.server.authz

    Methods in org.apache.tinkerpop.gremlin.server.authz with parameters of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `void` | Authorizer.`authorize(AuthenticatedUser user, RequestMessage msg)` Checks whether a user is authorized to have a script request from a gremlin client answered and raises an `AuthorizationException` if this is not the case.

  - ### Uses of RequestMessage in org.apache.tinkerpop.gremlin.server.handler

    Fields in org.apache.tinkerpop.gremlin.server.handler with type parameters of type RequestMessage
    Modifier and Type | Field and Description
    --- | ---
    `static io.netty.util.AttributeKey<RequestMessage>` | StateKey.`REQUEST_MESSAGE` The key for the current request.

    Methods in org.apache.tinkerpop.gremlin.server.handler with parameters of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | UnifiedHandler.`channelRead0(io.netty.channel.ChannelHandlerContext ctx, RequestMessage msg)`
    `protected void` | OpSelectorHandler.`decode(io.netty.channel.ChannelHandlerContext ctx, RequestMessage msg, List<Object> objects)`
    `protected void` | UnifiedHandler.`validateRequest(RequestMessage message, GraphManager graphManager)`

    Method parameters in org.apache.tinkerpop.gremlin.server.handler with type arguments of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | OpExecutorHandler.`channelRead0(io.netty.channel.ChannelHandlerContext ctx, org.javatuples.Pair<RequestMessage,ThrowingConsumer<Context>> objects)`

    Constructors in org.apache.tinkerpop.gremlin.server.handler with parameters of type RequestMessage
    Constructor and Description
    `SessionTask(RequestMessage requestMessage, io.netty.channel.ChannelHandlerContext ctx, Settings settings, GraphManager graphManager, GremlinExecutor gremlinExecutor, ScheduledExecutorService scheduledExecutorService)`

  - ### Uses of RequestMessage in org.apache.tinkerpop.gremlin.server.op

    Methods in org.apache.tinkerpop.gremlin.server.op with parameters of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `protected static void` | AbstractOpProcessor.`attemptCommit(RequestMessage msg, GraphManager graphManager, boolean strict)`
    `protected static void` | AbstractOpProcessor.`attemptRollback(RequestMessage msg, GraphManager graphManager, boolean strict)`
    `protected Map<String,Object>` | AbstractOpProcessor.`generateResultMetaData(io.netty.channel.ChannelHandlerContext ctx, RequestMessage msg, ResponseStatusCode code, Iterator itty, Settings settings)` Generates response result meta-data to put on a `ResponseMessage`.
    `protected Map<String,Object>` | AbstractOpProcessor.`generateStatusAttributes(io.netty.channel.ChannelHandlerContext ctx, RequestMessage msg, ResponseStatusCode code, Iterator itty, Settings settings)` Generates response status meta-data to put on a `ResponseMessage`.
    `protected boolean` | AbstractOpProcessor.`isForceFlushed(io.netty.channel.ChannelHandlerContext ctx, RequestMessage msg, Iterator itty)` Determines if a `Frame` should be force flushed outside of the `resultIterationBatchSize` and the termination of the iterator.
    `protected void` | AbstractOpProcessor.`iterateComplete(io.netty.channel.ChannelHandlerContext ctx, RequestMessage msg, Iterator itty)` Called when iteration within `AbstractOpProcessor.handleIterator(Context, Iterator)` is on its final pass and the final frame is about to be sent back to the client.
    `protected static Frame` | AbstractOpProcessor.`makeFrame(Context ctx, RequestMessage msg, MessageSerializer<?> serializer, boolean useBinary, List<Object> aggregate, ResponseStatusCode code, Map<String,Object> responseMetaData, Map<String,Object> statusAttributes)`
    `protected Optional<ThrowingConsumer<Context>>` | AbstractEvalOpProcessor.`validateEvalMessage(RequestMessage message)`

  - ### Uses of RequestMessage in org.apache.tinkerpop.gremlin.server.op.session

    Methods in org.apache.tinkerpop.gremlin.server.op.session with parameters of type RequestMessage
    Modifier and Type | Method and Description
    --- | ---
    `protected static Session` | SessionOpProcessor.`getSession(Context context, RequestMessage msg)` Examines the `RequestMessage` and extracts the session token.
    `protected Optional<ThrowingConsumer<Context>>` | SessionOpProcessor.`validateEvalMessage(RequestMessage message)`

Copyright © 2013–2022 Apache Software Foundation. All rights reserved.