CODEX_APSS/StateInfo.h

/*
 * Copyright 2003 Michael A. Marsh, Cornell University. All rights reserved.
 * This software is released under the modified BSD license.
 * See the file LICENSE in the top-level directory for details.
 */
//
// $Id: StateInfo.h,v 1.4 2005/01/21 19:44:15 mmarsh Exp $
//
// $Log: StateInfo.h,v $
// Revision 1.4  2005/01/21 19:44:15  mmarsh
// Updated for compatibility with Doxygen 1.4.1
//
// Revision 1.3  2004/05/19 15:56:25  mmarsh
// Added copyright and license statements.
//
// Revision 1.2  2003/11/04 22:31:46  mmarsh
// *** empty log message ***
//
//

#ifndef __CODEX_APSS_STATEINFO_H__
#define __CODEX_APSS_STATEINFO_H__

#include <vector>
#include <map>

#include "CODEX_Server/ServerState.h"
#include "Message.h"
#include "Types.h"
#include "SecretManagement.h"
#include "APSSShareCallback.h"
#include "MessageDeliverer.h"

namespace CODEX_APSS
{
   class CODEX_VSS::Range;

   class StateInfo
   {
         //==========================================================
         // CONFIGURATION
         //==========================================================

      private :

      public :

         //==========================================================
         // TYPEDEFs
         //==========================================================

         typedef map< unsigned int, SecretManagement >     SecretManagementMap;

         const static unsigned int  NumShares = LabelType::NumShares;

         const static unsigned int  NumServers =
         CODEX_Server::ServerState::nServers;


         //==========================================================
         // UNIQUE INSTANCE
         //==========================================================
         
         static StateInfo* instance();

         static void destroy();


         //==========================================================
         // APSS CONFIGURATION
         //==========================================================

         void configure( const CONF* conf,
                         const char* sec,
                         const string& fname );

         void setDomain( unsigned char d ) { m_domain = d; }

         unsigned char domain() const { return m_domain; }

         void setMessageDeliverer( MessageDeliverer* deliverer )
         {
            m_deliverer = deliverer;
         }


         //==========================================================
         // SHARE MANAGEMENT
         //==========================================================

         unsigned int refreshInterval() const { return m_refreshInterval; }

         void addSharing( LSType* sharing );

         const LSType& sharing( const LSType::LabelType& label,
                                unsigned int server ) const;

         const WitnessType& witness( unsigned int num ) const;

         const ShareSetType& subsharing( const SublabelType& sublabel,
                                         unsigned int server ) const;

         void addSubsharing( const SublabelType& sublabel,
                             const ShareType& subsharing );

         void recover( const SublabelType& sublabel );

         void markRecovered( const SublabelType& sublabel );

         SubshareList& splittings( const LabelType& label );

         const CODEX_VSS::Range& subshareRange( unsigned int num ) const;

         void updateExpired();

         void updateAll();

         bool addInitMsg( const SignedInitMsg& im );

         bool addEstablishMsg( const SignedEstablishMsg& em );

         bool addComputeMsg( const SignedComputeMsg& cm );

         bool addFinishedMsg( const SignedFinishedMsg& fm );

         bool addInitResponse( const SignedContributeMsg& cm );

         bool addEstablishResponse( const SignedEstablishedMsg& em );

         bool addComputeResponse( const SignedComputedMsg& cm );

         void clearEstablishMsgs( unsigned int num );

         void clearEstablishMsgs( unsigned int num, unsigned int establisher );

         unsigned long version( unsigned int num ) const;

         const InitRecord& initRecord( unsigned int num,
                                       unsigned int i ) const;

         const EstablishRecord& establishRecord(
            unsigned int num,
            unsigned int establisher,
            unsigned int shareNum,
            const LabelType& label ) const;

         const ComputeRecord& computeRecord( unsigned int num,
                                             unsigned int i ) const;

         const SignedFinishedMsg& finishedMsg( unsigned int num,
                                               unsigned int i ) const;

         void sendFinished( unsigned int num, unsigned int server ) const;

         void sendFinished( unsigned int num,
                            unsigned int coord,
                            unsigned int server ) const;

         void sendTo( unsigned int server,
                      const CODEX_Quorum::Message& message );

         void broadcast( const CODEX_Quorum::Message& message,
                         CODEX_Quorum::ResponseCallback* cb );

      protected :
         StateInfo();

         virtual ~StateInfo();

         static StateInfo* m_instance;

         void checkSecretNum( unsigned int num ) const;

      private :
         typedef list< SublabelType >  RecoveryList;

         unsigned char        m_domain;
         unsigned int         m_refreshInterval;
         SecretManagementMap  m_secrets;
         CODEX_VSS::Range*    m_rsaSubshareRange;
         CODEX_VSS::Range*    m_elgamalSubshareRange;
         APSSShareCallback*   m_rsaCallback;
         APSSShareCallback*   m_elgamalCallback;
         unsigned long        m_interval;
         MessageDeliverer*    m_deliverer;
         RecoveryList         m_recoverLabels;
   };
}

#endif /* __CODEX_APSS_STATEINFO_H__ */

---