/**********************************************************************
// @@@ START COPYRIGHT @@@
//
// 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.
//
// @@@ END COPYRIGHT @@@
// File:         sscpIpc.h
// Description:  Class declaration for SSCP IPC infrastructure
//
// Created:      5/01/2006
**********************************************************************/
#ifndef _SSCPIPC_H_
#define _SSCPIPC_H_
#include "Ipc.h"
#include "SqlStats.h"


class StatsGlobals ;
class ExStatisticsArea ;
class RtsQueryId;
/////////////////////////////////////////////////////////////
// class SscpGlobals
/////////////////////////////////////////////////////////////

class SscpGlobals
{
public:

  SscpGlobals(NAHeap *sscpheap, StatsGlobals *statsGlobals);
  ~SscpGlobals();
  NAHeap *getHeap() { return heap_; }
  StatsGlobals *getStatsGlobals() { return statsGlobals_; }
  void releaseOrphanEntries() {}
  Long &getSemId() { return semId_; }
  pid_t myPin() { return myPin_; }
  inline void incSscpReqMsg(Int64 msgBytes) { statsGlobals_->incSscpReqMsg(msgBytes); }
  inline void incSscpReplyMsg(Int64 msgBytes) { statsGlobals_->incSscpReplyMsg(msgBytes); }
  bool shouldLogCancelKillServers() { return doLogCancelKillServers_; }
private:

  NAHeap *heap_;            // pointer to heap for process duration storage
  StatsGlobals *statsGlobals_;
  Long semId_;
  pid_t myPin_; 
  bool doLogCancelKillServers_;
}; // SSCPGlobals


class SscpGuaReceiveControlConnection : public GuaReceiveControlConnection
{
public:

   SscpGuaReceiveControlConnection(
       IpcEnvironment *env,
       SscpGlobals *sscpGlobals,
       short receiveDepth = 256) :
       GuaReceiveControlConnection(env,
				   receiveDepth)
  { sscpGlobals_ = sscpGlobals; } 

  virtual void actOnSystemMessage(
       short                  messageNum,
       IpcMessageBufferPtr    sysMsg,
       IpcMessageObjSize      sysMsgLen,
       short                  clientFileNumber,
       const GuaProcessHandle &clientPhandle,
       GuaConnectionToClient  *connection);
  SscpGlobals *getSscpGlobals() { return sscpGlobals_; }

private:

  SscpGlobals *sscpGlobals_;
}; // SscpGuaReceiveControlConnection
// -----------------------------------------------------------------------
// An object that holds a new connection, created by a Guardian open
// system message, until the first application message comes in
// -----------------------------------------------------------------------

class SscpNewIncomingConnectionStream : public IpcMessageStream
{
public:

  SscpNewIncomingConnectionStream(NAHeap * heap, IpcEnvironment *env,
    SscpGlobals *sscpGlobals);

  virtual void actOnSend(IpcConnection *connection);
  virtual void actOnSendAllComplete();
  virtual void actOnReceive(IpcConnection *connection);
  virtual void actOnReceiveAllComplete();
  NAHeap *getHeap() { return heap_; }
  SscpGlobals *getSscpGlobals() { return sscpGlobals_; }
  void processStatsReq(IpcConnection *connection);
  void processCpuStatsReq(IpcConnection *connection);
  void processKillServersReq();
  void suspendActivateSchedulers();
  void processSecInvReq();
private:

  SscpGlobals *sscpGlobals_;
  IpcEnvironment *ipcEnv_;
  NAHeap *heap_;
}; // SscpNewIncomingConnectionStream

#endif // _SSCPIPC_H_