// Copyright 2020 Google LLC
//
// 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
//
//     https://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.

#ifndef PLATFORM_SYNCHRONIZED_H_
#define PLATFORM_SYNCHRONIZED_H_

#include "platform/api/lock.h"
#include "platform/ptr.h"

namespace location {
namespace nearby {

// An RAII mechanism to acquire a Lock over a block of code.
//
// https://docs.oracle.com/javase/tutorial/essential/concurrency/syncmeth.html
// https://docs.oracle.com/javase/tutorial/essential/concurrency/locksync.html
class Synchronized {
 public:
  explicit Synchronized(Ptr<Lock> lock) : lock_(lock) { lock_->lock(); }
  ~Synchronized() { lock_->unlock(); }

 private:
  Ptr<Lock> lock_;
};

}  // namespace nearby
}  // namespace location

#endif  // PLATFORM_SYNCHRONIZED_H_