PublicationInstance.h

Go to the documentation of this file.

/*
 *
 *
 * Distributed under the OpenDDS License.
 * See: http://www.opendds.org/license.html
 */

#ifndef OPENDDS_DCPS_PUBLICATION_INSTANCE_H
#define OPENDDS_DCPS_PUBLICATION_INSTANCE_H

#include "dcps_export.h"
#include "InstanceDataSampleList.h"
#include "DataSampleElement.h"
#include "dds/DCPS/PoolAllocationBase.h"
#include "ace/Synch_Traits.h"
#include "dds/DCPS/RcObject.h"
#include "dds/DCPS/unique_ptr.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
#pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL

namespace OpenDDS {
namespace DCPS {

typedef ACE_UINT16 CoherencyGroup;

/**
  * @class PublicationInstance
  *
  * @brief Struct that has information about an instance and the instance
  *        sample list.
  * @note  This struct retains the ownership of the registered sample data
  *        from typed datawriter. The data will be duplicated for the register,
  *        unregister and dispose control message.
  */
struct OpenDDS_Dcps_Export PublicationInstance  : public RcObject {

  PublicationInstance(Message_Block_Ptr registered_sample)
    : sequence_(),
      group_id_(0),
      registered_sample_(registered_sample.release()),
      unregistered_(false),
      instance_handle_(0),
      deadline_timer_id_(-1),
      durable_samples_remaining_(0) {
  }

  ~PublicationInstance() {
  }

  /// The sequence number.
  SequenceNumber   sequence_ ;

  /// The group id. // NOT USED IN FIRST IMPL
  CoherencyGroup   group_id_ ;

  /// The sample data for registration.
  Message_Block_Ptr registered_sample_;

  /// History of the instance samples.
  InstanceDataSampleList   samples_;

  /// The flag to indicate whether the instance is unregistered.
  bool             unregistered_;

  /// The instance handle for the registered object
  DDS::InstanceHandle_t instance_handle_;

  ACE_Time_Value   last_sample_tv_;

  ACE_Time_Value   cur_sample_tv_;

  long             deadline_timer_id_;

  /// Only used by WriteDataContainer::reenqueue_all() while WDC is locked.
  ssize_t durable_samples_remaining_;
};

typedef RcHandle<PublicationInstance> PublicationInstance_rch;

} // namespace DCPS
} // namespace OpenDDS

OPENDDS_END_VERSIONED_NAMESPACE_DECL

#endif /* OPENDDS_DCPS_PUBLICATION_INSTANCE_H */