mq5.1-source.src.share.cclient.client.PingTimer.hpp Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2000-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

/*
 * @(#)PingTimer.hpp	1.4 06/26/07
 */ 

#ifndef PINGTIMER_HPP
#define PINGTIMER_HPP

#include "../error/ErrorCodes.h"
#include "../basictypes/Runnable.hpp"
#include "../basictypes/Monitor.hpp"

class Connection;

/**
 *
 */
class PingTimer : public Runnable {
private:
  /** The connection for which this PingTimer was created. */
  Connection * connection;

  PRIntervalTime pingInterval;

  /** True iff the ping thread was successfully started and running  */
  PRBool isAlive;

  /** True if the PingTimer is asked to exit */
  PRBool exit;

  Monitor monitor;

  MQError initializationError;

  /** The ID of the connection that created this PingTimer. */ 
  PRInt64 connectionID;

  void init();

  PRThread * pingThread;
  
public:
  /**
   * @param connection The connection on which this PingTimer was created.
   * @param interval The ping interval in millisec
   */
  PingTimer(Connection * const connection);

  virtual ~PingTimer();

  /** @return MQ_SUCCESS if the ping thread started successfully, error otherwise 
   */
  MQError getInitializationError() const;

  /**
   */
  void run();

  /**
   * Signals and wait the ping timer thread to exit
   */
  void terminate(); 

private:
  PingTimer(const PingTimer& pingTimer);
  PingTimer& operator=(const PingTimer& pingTimer);
};

#endif