mirror of
https://github.com/pocoproject/poco.git
synced 2025-06-29 07:36:07 +02:00
b0581433a7
fix: remove executable flag and change back to 100644 (was 100755) Signed-off-by: Roger Meier <r.meier@siemens.com>
117 lines
2.4 KiB
C++
117 lines
2.4 KiB
C++
//
|
|
// Array.h
|
|
//
|
|
// $Id$
|
|
//
|
|
// Library: MongoDB
|
|
// Package: MongoDB
|
|
// Module: ObjectId
|
|
//
|
|
// Definition of the ObjectId class.
|
|
//
|
|
// Copyright (c) 2012, Applied Informatics Software Engineering GmbH.
|
|
// and Contributors.
|
|
//
|
|
// SPDX-License-Identifier: BSL-1.0
|
|
//
|
|
|
|
|
|
#ifndef MongoDB_ObjectId_INCLUDED
|
|
#define MongoDB_ObjectId_INCLUDED
|
|
|
|
|
|
#include "Poco/MongoDB/MongoDB.h"
|
|
#include "Poco/MongoDB/Element.h"
|
|
#include "Poco/Timestamp.h"
|
|
|
|
|
|
namespace Poco {
|
|
namespace MongoDB {
|
|
|
|
|
|
class MongoDB_API ObjectId
|
|
/// ObjectId is a 12-byte BSON type, constructed using:
|
|
///
|
|
/// - a 4-byte timestamp,
|
|
/// - a 3-byte machine identifier,
|
|
/// - a 2-byte process id, and
|
|
/// - a 3-byte counter, starting with a random value.
|
|
///
|
|
/// In MongoDB, documents stored in a collection require a unique _id field that acts
|
|
/// as a primary key. Because ObjectIds are small, most likely unique, and fast to generate,
|
|
/// MongoDB uses ObjectIds as the default value for the _id field if the _id field is not
|
|
/// specified; i.e., the mongod adds the _id field and generates a unique ObjectId to assign
|
|
/// as its value.
|
|
{
|
|
public:
|
|
typedef SharedPtr<ObjectId> Ptr;
|
|
|
|
ObjectId(const std::string& id = "");
|
|
/// Constructor
|
|
|
|
virtual ~ObjectId();
|
|
/// Destructor
|
|
|
|
Timestamp timestamp() const;
|
|
/// Returns the timestamp which is stored in the first four bytes of the id
|
|
|
|
std::string toString(const std::string& fmt = "%02x") const;
|
|
/// Returns the id in string format. The fmt parameter
|
|
/// specifies the formatting used for individual members
|
|
/// of the ID char array.
|
|
|
|
private:
|
|
unsigned char _id[12];
|
|
|
|
friend class BSONWriter;
|
|
friend class BSONReader;
|
|
};
|
|
|
|
|
|
inline Timestamp ObjectId::timestamp() const
|
|
{
|
|
int time;
|
|
char* T = (char *) &time;
|
|
T[0] = _id[3];
|
|
T[1] = _id[2];
|
|
T[2] = _id[1];
|
|
T[3] = _id[0];
|
|
return Timestamp::fromEpochTime((time_t) time);
|
|
}
|
|
|
|
|
|
// BSON Embedded Document
|
|
// spec: ObjectId
|
|
template<>
|
|
struct ElementTraits<ObjectId::Ptr>
|
|
{
|
|
enum { TypeId = 0x07 };
|
|
|
|
static std::string toString(const ObjectId::Ptr& id,
|
|
int indent = 0,
|
|
const std::string& fmt = "%x")
|
|
{
|
|
return id->toString(fmt);
|
|
}
|
|
};
|
|
|
|
|
|
template<>
|
|
inline void BSONReader::read<ObjectId::Ptr>(ObjectId::Ptr& to)
|
|
{
|
|
_reader.readRaw((char*) to->_id, 12);
|
|
}
|
|
|
|
|
|
template<>
|
|
inline void BSONWriter::write<ObjectId::Ptr>(ObjectId::Ptr& from)
|
|
{
|
|
_writer.writeRaw((char*) from->_id, 12);
|
|
}
|
|
|
|
|
|
} } // namespace Poco::MongoDB
|
|
|
|
|
|
#endif //MongoDB_ObjectId_INCLUDED
|