com.gemstone.gemfire.cache.client.internal.CloseConnectionOp Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
SnappyData store based off Pivotal GemFireXD
The newest version!
/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed 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. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.cache.client.internal;

import com.gemstone.gemfire.i18n.LogWriterI18n;
import com.gemstone.gemfire.internal.cache.tier.MessageType;
import com.gemstone.gemfire.internal.cache.tier.sockets.Message;

/**
 * Tell a server that a connection is being closed
 * @author darrel
 * @since 5.7
 */
public class CloseConnectionOp {
  /**
   * Tell a server that a connection is being closed
   * @param logger the logger to log to
   * @param con the connection that is being closed
   * @param keepAlive whether to keep the proxy alive on the server
   */
  public static void execute(LogWriterI18n logger, Connection con, boolean keepAlive)
    throws Exception
  {
    AbstractOp op = new CloseConnectionOpImpl(logger, keepAlive);
    con.execute(op);
  }
                                                               
  private CloseConnectionOp() {
    // no instances allowed
  }
  
  private static class CloseConnectionOpImpl extends AbstractOp {
    /**
     * @throws com.gemstone.gemfire.SerializationException if serialization fails
     */
    public CloseConnectionOpImpl(LogWriterI18n lw, boolean keepAlive)  {
      super(lw, MessageType.CLOSE_CONNECTION, 1);
      getMessage().addRawPart(new byte[]{(byte)(keepAlive?1:0)}, false);
    }
    @Override  
    protected Message createResponseMessage() {
      // no response is sent
      return null;
    }

    @Override
    protected void processSecureBytes(Connection cnx, Message message)
        throws Exception {
    }

    @Override
    protected boolean needsUserId() {
      return false;
    }

    @Override
    protected void sendMessage(Connection cnx) throws Exception {
      getMessage().setEarlyAck((byte)(getMessage().getEarlyAckByte() & Message.MESSAGE_HAS_SECURE_PART));
      getMessage().send(false);
    }

    @Override  
    protected Object processResponse(Message msg) throws Exception {
      throw new IllegalStateException("should never be called");
    }
    @Override  
    protected boolean isErrorResponse(int msgType) {
      return false;
    }
    @Override  
    protected long startAttempt(ConnectionStats stats) {
      return stats.startCloseCon();
    }
    @Override  
    protected void endSendAttempt(ConnectionStats stats, long start) {
      stats.endCloseConSend(start, hasFailed());
    }
    @Override  
    protected void endAttempt(ConnectionStats stats, long start) {
      stats.endCloseCon(start, hasTimedOut(), hasFailed());
    }
  }
}