lock_ticket.h

/*
 Copyright (c) 2013 by ScaleOut Software, Inc.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
*/ 

#pragma once

#include <stdint.h>
#include "soss_svccli.h"
#include "soss_key.h"
#include "boost/thread.hpp"

namespace sosscli {

class LockTicket
{
public:

 /* Constructors */

 LockTicket(void);

 LockTicket(SOSS_OBJKEY const &key, const int32_t ticket);

 LockTicket(const LockTicket &other);

 // Destructor.
 virtual ~LockTicket(void);

 /* Lock ticket operations */

 void release(void);

 /* Accessors */

 bool locked(void) const;

 bool is_null_ticket(void) const;

 /* operator overloads */

 LockTicket& operator=(const LockTicket& rhs);
 
 inline operator int32_t() const
 {
 // if the LockTicket is not yet initialized, return native null lock ticket
 if(!state_)
 return SOSSLIB_NULL_LOCK_TKT;

 return this->state_->lock_ticket_;
 }

protected:

private:

 /* Nested Classes */

 class LockTicketState : private boost::noncopyable
 {
 public:
 LockTicketState(SOSS_OBJKEY const &key, const int32_t ticket);

 ~LockTicketState(void);

 SOSS_OBJKEY obj_key_;

 int32_t lock_ticket_;

 bool locked_;
 };

 typedef boost::shared_ptr<LockTicketState> lock_state_t;
 lock_state_t state_;
 boost::mutex ticket_mutex_;
};

}