ippSimpleServer.h

Go to the documentation of this file.

// 
// DISCLAIMER: 
//  This software was produced by the National Institute of Standards 
//  and Technology (NIST), an agency of the U.S. government, and by statute is 
//  not subject to copyright in the United States.  Recipients of this 
//  software assume all responsibility associated with its operation,
//  modification,maintenance, and subsequent redistribution. 
//
//  See NIST Administration Manual 4.09.07 b and Appendix I. 
#pragma once
#include "ippdme/ippdme.h"

#include "ippdme/Socket/ippSocket.h"

#include "ippdme/Response/ippErrorResponse.h"
#include "ippdme/Server/ippServerQueues.h"
#include "ippdme/Server/ippEngine.h"
#include "ippdme/Command/ippCommand.h"
#include "ippdme/ippDaemon.h"

#include <map>

class IPPDME_EXT_CLASS ippExecutor;
class IPPDME_EXT_CLASS ippCommandChecker;
class IPPDME_EXT_CLASS ippDaemon;


class IPPDME_EXT_CLASS ippSimpleServer : public ippEngine
{
public:
  enum STATE
  {
     uninitialized,
     listening,
     connected, 
  };
  // constructors
  ippSimpleServer(ippExecutor* _executor=0);

  virtual ~ippSimpleServer();

  // pulse
  virtual void HeartBeat();


  // --- action on the server
  virtual bool PowerOn(int portNumber = 1294);  
  virtual bool PowerOff();

  // call backs
  virtual void OnClientConnected();
  virtual void OnClientDisconnected();


  STATE GetState() const {return _state; }

  bool InSession() const;
  
  bool IsProcessingSlowCommand() const;

protected:
  virtual void ExecuteCommand(ippCommandPtr aCommand);
  ippCommandChecker* _checker;
  ippExecutor*       _executor;
private:
  ippSocket   _listenSocket;
  ippServerQueues    _serverQueues;
        short _portNumber;
  STATE _state;
  bool _inSession;
  int _tagBeingExecuted; // tag of the command being executed (not yet completed)
  bool _inErrorState;
  
  // prohibited copy constructors
  ippSimpleServer(const ippSimpleServer&);
  void operator=(const ippSimpleServer&);

  void PerformWrite();
  void PerformExecute();
  void PerformListening();
  
  void AbortPendingCommands();
  
  void ExecuteAbortE(const ippTag&);

  void StopAllDaemons();
  int  DaemonCount() const;

  void ClearAllErrors();

  void SendError(
    ippErrorResponsePtr errResponse,
    const char* rich_error
  );

  // send a response to the client
  void SendResponse(ippResponsePtr response);
  
  // send the acknowledge response for the command  (&)
  void SendAcknowledge(const ippTag& tag);
  
  // send the completion response for the command  (%)
  void SendComplete(const ippTag& tag);

  void ProcessCommand(const char* commandbuffer);

  bool GetLogDetails() const;

  void ProcessResponseList(const ippResponseList& aCommand);
  void WriteToSocket(const char* line);


  // -- overridden from ippEngine
  virtual void ProcessLine(const char* inputline);
  virtual void ProcessMisformedLine(const char* inputline);
  virtual void OnConnectionLost();

};

---