JLANG::JUUID Struct Reference

Simple wrapper for UUID. More...

#include <JUUID.hh>

Inheritance diagram for JLANG::JUUID:

Public Member Functions
	JUUID ()
	Default constructor.
	JUUID (const uuid_t &object)
	Copy constructor.
	JUUID (const JUUID &object)
	Copy constructor.
const JUUID &	operator() ()
	Randomizde this UUID.
bool	is_valid () const
	Check validity.
void	clear ()
	Clear UUID.
bool	less (const JUUID &object) const
	Less than method.

Static Public Member Functions
static const JUUID &	rndm ()
	Generate random UUID.
static JUUID	valueOf (const std::string &buffer)
	Extract UUID.

Public Attributes
uuid_t	uuid

Static Public Attributes
static const int	BUFFER_SIZE = 36
	number of characters for I/O of uuid_t without trailing '\0', see e.g. man uuid_parse

Friends
std::istream &	operator>> (std::istream &in, JUUID &object)
	Read object identifier from input.
std::ostream &	operator<< (std::ostream &out, const JUUID &object)
	Write object identifier to output.

Detailed Description

Simple wrapper for UUID.

Definition at line 22 of file JUUID.hh.

Constructor & Destructor Documentation

JUUID() [1/3]

JLANG::JUUID::JUUID ( )

inline

Default constructor.

Definition at line 32 of file JUUID.hh.

    {
      clear();
    }

JUUID() [2/3]

JLANG::JUUID::JUUID ( const uuid_t & object )

inline

Copy constructor.

Parameters

object

UUID

Definition at line 43 of file JUUID.hh.

    {
      uuid_copy(this->uuid, object);
    }

JUUID() [3/3]

JLANG::JUUID::JUUID ( const JUUID & object )

inline

Copy constructor.

Parameters

object

UUID

Definition at line 54 of file JUUID.hh.

    {
      uuid_copy(this->uuid, object.uuid);
    }

Member Function Documentation

operator()()

const JUUID & JLANG::JUUID::operator() ( )

inline

Randomizde this UUID.

Returns

this UUID

Definition at line 65 of file JUUID.hh.

    {
      uuid_generate_random(this->uuid);
 
      return *this;
    }

rndm()

static const JUUID & JLANG::JUUID::rndm ( )

inlinestatic

Generate random UUID.

Returns

UUID

Definition at line 78 of file JUUID.hh.

    {
      static JUUID id;
 
      return id();
    }

is_valid()

bool JLANG::JUUID::is_valid ( ) const

inline

Check validity.

Returns

true if valid; else false

Definition at line 91 of file JUUID.hh.

    {
      return uuid_is_null(this->uuid) == 0;
    }

clear()

void JLANG::JUUID::clear ( )

inline

Clear UUID.

Definition at line 100 of file JUUID.hh.

    {
      return uuid_clear(this->uuid);
    }

less()

bool JLANG::JUUID::less ( const JUUID & object ) const

inline

Less than method.

Parameters

object

UUID

Returns

true if this UUID less than given UUID; else false

Definition at line 112 of file JUUID.hh.

    {
      return uuid_compare(this->uuid, object.uuid) < 0;
    }

valueOf()

static JUUID JLANG::JUUID::valueOf ( const std::string & buffer )

inlinestatic

Extract UUID.

Parameters

buffer

UUID

Returns

UUID

Definition at line 124 of file JUUID.hh.

    {
      JUUID object;
 
      uuid_parse(buffer.c_str(), object.uuid);
 
      return object;
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JUUID & object )

friend

Read object identifier from input.

Parameters

in	input stream
object	object identifier

Returns

input stream

Definition at line 141 of file JUUID.hh.

    {
      char buffer[BUFFER_SIZE + 1];
 
      if (in.read(buffer, BUFFER_SIZE)) {
 
        buffer[BUFFER_SIZE] = '\0';
 
        uuid_parse(buffer, object.uuid);
      }
 
      return in;
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const JUUID & object )

friend

Write object identifier to output.

Parameters

out	output stream
object	object identifier

Returns

output stream

Definition at line 163 of file JUUID.hh.

    {
      char buffer[BUFFER_SIZE + 1];
 
      uuid_unparse_lower(object.uuid, buffer);
 
      return out.write(buffer, BUFFER_SIZE);
    }

Member Data Documentation

BUFFER_SIZE

const int JLANG::JUUID::BUFFER_SIZE = 36

static

number of characters for I/O of uuid_t without trailing '\0', see e.g. man uuid_parse

Definition at line 26 of file JUUID.hh.

uuid

uuid_t JLANG::JUUID::uuid

Definition at line 172 of file JUUID.hh.

---

The documentation for this struct was generated from the following file:

• JUUID.hh