/*
- * Copyright 2016 Facebook, Inc.
+ * Copyright 2017 Facebook, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#pragma once
-#include <poll.h>
#include <sys/types.h>
-#include <unistd.h>
#include <algorithm>
#include <deque>
#include <stdexcept>
#include <utility>
+#include <folly/Exception.h>
#include <folly/FileUtil.h>
-#include <folly/io/async/EventBase.h>
-#include <folly/io/async/EventHandler.h>
-#include <folly/io/async/DelayedDestruction.h>
-#include <folly/io/async/Request.h>
#include <folly/Likely.h>
#include <folly/ScopeGuard.h>
#include <folly/SpinLock.h>
+#include <folly/io/async/DelayedDestruction.h>
+#include <folly/io/async/EventBase.h>
+#include <folly/io/async/EventHandler.h>
+#include <folly/io/async/Request.h>
#include <folly/portability/Fcntl.h>
+#include <folly/portability/Sockets.h>
+#include <folly/portability/Unistd.h>
#include <glog/logging.h>
* spinning trying to move a message off the queue and failing, and then
* retrying.
*/
-template<typename MessageT>
+template <typename MessageT>
class NotificationQueue {
public:
/**
* messageAvailable() will be invoked whenever a new
* message is available from the pipe.
*/
- virtual void messageAvailable(MessageT&& message) = 0;
+ virtual void messageAvailable(MessageT&& message) noexcept = 0;
/**
* Begin consuming messages from the specified queue.
void destroy() override;
- virtual ~Consumer() {}
+ ~Consumer() override {}
private:
/**
* may throw any other exception thrown by the MessageT move/copy
* constructor.
*/
- void tryPutMessage(MessageT&& message) {
- putMessageImpl(std::move(message), advisoryMaxQueueSize_);
- }
- void tryPutMessage(const MessageT& message) {
- putMessageImpl(message, advisoryMaxQueueSize_);
+ template <typename MessageTT>
+ void tryPutMessage(MessageTT&& message) {
+ putMessageImpl(std::forward<MessageTT>(message), advisoryMaxQueueSize_);
}
/**
* (which indicates that the queue is being drained) are prevented from being
* thrown. User code must still catch std::bad_alloc errors.
*/
- bool tryPutMessageNoThrow(MessageT&& message) {
- return putMessageImpl(std::move(message), advisoryMaxQueueSize_, false);
- }
- bool tryPutMessageNoThrow(const MessageT& message) {
- return putMessageImpl(message, advisoryMaxQueueSize_, false);
+ template <typename MessageTT>
+ bool tryPutMessageNoThrow(MessageTT&& message) {
+ return putMessageImpl(
+ std::forward<MessageTT>(message), advisoryMaxQueueSize_, false);
}
/**
* - std::runtime_error if the queue is currently draining
* - any other exception thrown by the MessageT move/copy constructor.
*/
- void putMessage(MessageT&& message) {
- putMessageImpl(std::move(message), 0);
- }
- void putMessage(const MessageT& message) {
- putMessageImpl(message, 0);
+ template <typename MessageTT>
+ void putMessage(MessageTT&& message) {
+ putMessageImpl(std::forward<MessageTT>(message), 0);
}
/**
* Put several messages on the queue.
*/
- template<typename InputIteratorT>
+ template <typename InputIteratorT>
void putMessages(InputIteratorT first, InputIteratorT last) {
typedef typename std::iterator_traits<InputIteratorT>::iterator_category
IterCategory;
return false;
}
- auto data = std::move(queue_.front());
- result = data.first;
- RequestContext::setContext(data.second);
+ auto& data = queue_.front();
+ result = std::move(data.first);
+ RequestContext::setContext(std::move(data.second));
queue_.pop_front();
NotificationQueue& operator=(NotificationQueue const &) = delete;
inline bool checkQueueSize(size_t maxSize, bool throws=true) const {
- DCHECK(0 == spinlock_.trylock());
+ DCHECK(0 == spinlock_.try_lock());
if (maxSize > 0 && queue_.size() >= maxSize) {
if (throws) {
throw std::overflow_error("unable to add message to NotificationQueue: "
}
ssize_t bytes_written = 0;
- ssize_t bytes_expected = 0;
+ size_t bytes_expected = 0;
do {
if (eventfd_ >= 0) {
// eventfd(2) dictates that we must write a 64-bit integer
uint64_t signal = 1;
- bytes_expected = static_cast<ssize_t>(sizeof(signal));
+ bytes_expected = sizeof(signal);
bytes_written = ::write(eventfd_, &signal, bytes_expected);
} else {
uint8_t signal = 1;
- bytes_expected = static_cast<ssize_t>(sizeof(signal));
+ bytes_expected = sizeof(signal);
bytes_written = ::write(pipeFds_[1], &signal, bytes_expected);
}
} while (bytes_written == -1 && errno == EINTR);
}
#endif
- if (bytes_written == bytes_expected) {
+ if (bytes_written == ssize_t(bytes_expected)) {
signal_ = true;
} else {
#ifdef __ANDROID__
}
}
- bool putMessageImpl(MessageT&& message, size_t maxSize, bool throws=true) {
+ template <typename MessageTT>
+ bool putMessageImpl(MessageTT&& message, size_t maxSize, bool throws = true) {
checkPid();
bool signal = false;
{
if (numActiveConsumers_ < numConsumers_) {
signal = true;
}
- queue_.emplace_back(std::move(message), RequestContext::saveContext());
+ queue_.emplace_back(
+ std::forward<MessageTT>(message), RequestContext::saveContext());
if (signal) {
ensureSignalLocked();
}
return true;
}
- bool putMessageImpl(
- const MessageT& message, size_t maxSize, bool throws=true) {
- checkPid();
- bool signal = false;
- {
- folly::SpinLockGuard g(spinlock_);
- if (checkDraining(throws) || !checkQueueSize(maxSize, throws)) {
- return false;
- }
- if (numActiveConsumers_ < numConsumers_) {
- signal = true;
- }
- queue_.emplace_back(message, RequestContext::saveContext());
- if (signal) {
- ensureSignalLocked();
- }
- }
- return true;
- }
-
- template<typename InputIteratorT>
+ template <typename InputIteratorT>
void putMessagesImpl(InputIteratorT first, InputIteratorT last,
std::input_iterator_tag) {
checkPid();
bool draining_{false};
};
-template<typename MessageT>
+template <typename MessageT>
void NotificationQueue<MessageT>::Consumer::destroy() {
// If we are in the middle of a call to handlerReady(), destroyedFlagPtr_
// will be non-nullptr. Mark the value that it points to, so that
DelayedDestruction::destroy();
}
-template<typename MessageT>
+template <typename MessageT>
void NotificationQueue<MessageT>::Consumer::handlerReady(uint16_t /*events*/)
noexcept {
consumeMessages(false);
}
-template<typename MessageT>
+template <typename MessageT>
void NotificationQueue<MessageT>::Consumer::consumeMessages(
bool isDrain, size_t* numConsumed) noexcept {
DestructorGuard dg(this);
if (wasEmpty) {
return;
}
- } catch (const std::exception& ex) {
+ } catch (const std::exception&) {
// This catch block is really just to handle the case where the MessageT
// constructor throws. The messageAvailable() callback itself is
// declared as noexcept and should never throw.
}
}
-template<typename MessageT>
+template <typename MessageT>
void NotificationQueue<MessageT>::Consumer::init(
EventBase* eventBase,
NotificationQueue* queue) {
- assert(eventBase->isInEventBaseThread());
+ eventBase->dcheckIsInEventBaseThread();
assert(queue_ == nullptr);
assert(!isHandlerRegistered());
queue->checkPid();
}
}
-template<typename MessageT>
+template <typename MessageT>
void NotificationQueue<MessageT>::Consumer::stopConsuming() {
if (queue_ == nullptr) {
assert(!isHandlerRegistered());
queue_ = nullptr;
}
-template<typename MessageT>
+template <typename MessageT>
bool NotificationQueue<MessageT>::Consumer::consumeUntilDrained(
size_t* numConsumed) noexcept {
DestructorGuard dg(this);
: callback_(std::forward<UCallback>(callback)) {}
// we are being stricter here and requiring noexcept for callback
- void messageAvailable(MessageT&& message) override {
+ void messageAvailable(MessageT&& message) noexcept override {
static_assert(
noexcept(std::declval<TCallback>()(std::forward<MessageT>(message))),
"callback must be declared noexcept, e.g.: `[]() noexcept {}`"
std::forward<TCallback>(callback)));
}
-} // folly
+} // namespace folly
projects / folly.git / blobdiff