geode-core/src/main/java/org/apache/geode/internal/cache/DirectReplyMessage.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License. You may obtain a
 * copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package org.apache.geode.internal.cache;

import org.apache.geode.distributed.internal.DirectReplyProcessor;
import org.apache.geode.distributed.internal.DistributionManager;
import org.apache.geode.distributed.internal.DistributionMessage;

/**
 * A message that can reply directly to the sender
 *
 *
 *
 */
public interface DirectReplyMessage {
  /**
   * Called on the sending side. This reply processor will be handed the responses from the message.
   */
  DirectReplyProcessor getDirectReplyProcessor();

  /**
   * Indicates whether the message could send an acknowledgement back on the connection the request
   * was sent on. This flag only takes effect when
   * {@link org.apache.geode.distributed.DistributedSystem#setThreadsSocketPolicy(boolean)} is set
   * to <code>false</code> If this flag is set to true, the process method <b> must </b> reply by
   * calling {@link DistributionMessage#getReplySender(DistributionManager)} and using the result to
   * send the reply. the ReplySender determines whether to reply directly or through the shared
   * channel.
   *
   * @return true if a direct acknowledgement is allowed
   * @see org.apache.geode.distributed.internal.direct.DirectChannel
   */
  boolean supportsDirectAck();

  /**
   * Called on the sending side. This method is invoked if the message will end up using the shared
   * channel. The message is expected to register the processor and send it's id to the receiving
   * side.
   *
   */
  void registerProcessor();
}